org.codehaus.plexus.util.xml

Class XmlUtil

public class XmlUtil extends Object

Common XML utilities methods.

Since: 1.5.7

Version: $Id: XmlUtil.java 8010 2009-01-07 12:59:50Z vsiveton $

Author: Vincent Siveton

Field Summary
static intDEFAULT_INDENTATION_SIZE
The default line indenter size i.e.
static StringDEFAULT_LINE_SEPARATOR
The default line separator ("\n" on UNIX)
Method Summary
static booleanisXml(File f)
Determines if a given File shall be handled as XML.
static voidprettyFormat(Reader reader, Writer writer)
Pretty format the input reader.
static voidprettyFormat(Reader reader, Writer writer, int indentSize, String lineSeparator)
Pretty format the input reader.
static voidprettyFormat(InputStream is, OutputStream os)
Pretty format the input stream.
static voidprettyFormat(InputStream is, OutputStream os, int indentSize, String lineSeparator)
Pretty format the input stream.

Field Detail

DEFAULT_INDENTATION_SIZE

public static final int DEFAULT_INDENTATION_SIZE
The default line indenter size i.e. 2.

DEFAULT_LINE_SEPARATOR

public static final String DEFAULT_LINE_SEPARATOR
The default line separator ("\n" on UNIX)

Method Detail

isXml

public static boolean isXml(File f)
Determines if a given File shall be handled as XML.

Parameters: f not null file

Returns: true if the given file has XML content, false otherwise.

prettyFormat

public static void prettyFormat(Reader reader, Writer writer)
Pretty format the input reader. For instance, the following input:
 <div><b>content</b></div>
 
becomes
 <div>
   <b>content</b>
 </div>
 

Parameters: reader not null writer not null

Throws: IOException if any or invalid xml content

See Also: XmlUtil to read an xml content to write an xml content

prettyFormat

public static void prettyFormat(Reader reader, Writer writer, int indentSize, String lineSeparator)
Pretty format the input reader. For instance, the following input:
 <div><b>content</b></div>
 
becomes
 <div>
   <b>content</b>
 </div>
 

Parameters: reader not null writer not null indentSize positive number for the indentation lineSeparator the wanted line separator

Throws: IOException if any or invalid xml content

See Also: to read an xml content to write an xml content

prettyFormat

public static void prettyFormat(InputStream is, OutputStream os)
Pretty format the input stream. For instance, the following input:
 <div><b>content</b></div>
 
becomes
 <div>
   <b>content</b>
 </div>
 

Parameters: is not null os not null

Throws: IOException if any or invalid xml content

See Also: XmlUtil

prettyFormat

public static void prettyFormat(InputStream is, OutputStream os, int indentSize, String lineSeparator)
Pretty format the input stream. For instance, the following input:
 <div><b>content</b></div>
 
becomes
 <div>
   <b>content</b>
 </div>
 

Parameters: is not null os not null indentSize positive number for the indentation lineSeparator the wanted line separator

Throws: IOException if any or invalid xml content

Copyright © 2001-2010 Codehaus. All Rights Reserved.