Package org.apache.maven.shared.utils.xml

Class PrettyPrintXMLWriter

java.lang.Object

org.apache.maven.shared.utils.xml.PrettyPrintXMLWriter

All Implemented Interfaces:

XMLWriter

public class PrettyPrintXMLWriter
extends Object
implements XMLWriter

XMLWriter with nice indentation.

Author:

kama

Constructor Summary

Constructors

Constructor	Description
PrettyPrintXMLWriter(PrintWriter writer)
PrettyPrintXMLWriter(PrintWriter writer, String lineIndent)
PrettyPrintXMLWriter(PrintWriter writer, String encoding, String doctype)
PrettyPrintXMLWriter(PrintWriter writer, String lineIndent, String encoding, String doctype)
PrettyPrintXMLWriter(PrintWriter writer, String lineIndent, String lineSeparator, String encoding, String doctype)
PrettyPrintXMLWriter(Writer writer)
PrettyPrintXMLWriter(Writer writer, String lineIndent)
PrettyPrintXMLWriter(Writer writer, String encoding, String doctype)
PrettyPrintXMLWriter(Writer writer, String lineIndent, String encoding, String doctype)

Method Summary

Modifier and Type	Method	Description
void	addAttribute(String key, String value)	Add a XML attribute to the current XML Element.
void	endElement()	End the previously opened element.
void	setDocType(String docType)	Sets the DOCTYPE of the document.
void	setEncoding(String encoding)	Sets the encoding of the document.
void	setLineIndenter(String lineIndentParameter)
void	setLineSeparator(String lineSeparator)
void	startElement(String elementName)	Start an XML Element tag.
void	writeMarkup(String markup)	Add preformatted markup to the current element tag.
void	writeText(String text)	Add text to the current element tag.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

PrettyPrintXMLWriter

public PrettyPrintXMLWriter(PrintWriter writer,
 String lineIndent)

Parameters:

writer - not null

lineIndent - can be null, but the normal way is some spaces

PrettyPrintXMLWriter

public PrettyPrintXMLWriter(Writer writer,
 String lineIndent)

Parameters:

writer - not null

lineIndent - can be null, but the normal way is some spaces.

PrettyPrintXMLWriter

public PrettyPrintXMLWriter(PrintWriter writer)

Parameters:

writer - not null

PrettyPrintXMLWriter

public PrettyPrintXMLWriter(Writer writer)

Parameters:

writer - not null

PrettyPrintXMLWriter

public PrettyPrintXMLWriter(PrintWriter writer,
 String lineIndent,
 String encoding,
 String doctype)

Parameters:

writer - not null

lineIndent - can be null, but the normal way is some spaces

encoding - can be null or invalid

doctype - can be null

PrettyPrintXMLWriter

public PrettyPrintXMLWriter(Writer writer,
 String lineIndent,
 String encoding,
 String doctype)

Parameters:

writer - not null

lineIndent - can be null, but the normal way is some spaces

encoding - can be null or invalid

doctype - can be null

PrettyPrintXMLWriter

public PrettyPrintXMLWriter(PrintWriter writer,
 String encoding,
 String doctype)

Parameters:

writer - not null

encoding - can be null or invalid

doctype - can be null

PrettyPrintXMLWriter

public PrettyPrintXMLWriter(Writer writer,
 String encoding,
 String doctype)

Parameters:

writer - not null

encoding - can be null or invalid

doctype - can be null

PrettyPrintXMLWriter

public PrettyPrintXMLWriter(PrintWriter writer,
 String lineIndent,
 String lineSeparator,
 String encoding,
 String doctype)

Parameters:

writer - not null

lineIndent - can be null, but the normal way is some spaces.

lineSeparator - can be null, but the normal way is valid line separator

encoding - can be null or the encoding to use.

doctype - can be null

Method Details

addAttribute

public void addAttribute(String key,
 String value)
                  throws IOException

Add a XML attribute to the current XML Element. This method must get called immediately after XMLWriter.startElement(String).

Specified by:

addAttribute in interface XMLWriter

Parameters:

key - The key of the attribute.

value - The value of the attribute.

Throws:

IOException - if adding the attribute fails.

setEncoding

public void setEncoding(String encoding)

Sets the encoding of the document. If not set, UTF-8 is used.

Specified by:

setEncoding in interface XMLWriter

Parameters:

encoding - the encoding

setDocType

public void setDocType(String docType)

Sets the DOCTYPE of the document.

Specified by:

setDocType in interface XMLWriter

Parameters:

docType - the docType

setLineSeparator

public void setLineSeparator(String lineSeparator)

Parameters:

lineSeparator - the line separator to be output

setLineIndenter

public void setLineIndenter(String lineIndentParameter)

Parameters:

lineIndentParameter - the line indent parameter

startElement

public void startElement(String elementName)
                  throws IOException

Start an XML Element tag.

Specified by:

startElement in interface XMLWriter

Parameters:

elementName - the name of the tag

Throws:

IOException - if starting the element fails

writeText

public void writeText(String text)
               throws IOException

Add text to the current element tag. This performs XML escaping to guarantee well-formed content.

Specified by:

writeText in interface XMLWriter

Parameters:

text - The text which should be written.

Throws:

IOException - if writing the text fails.

writeMarkup

public void writeMarkup(String markup)
                 throws IOException

Add preformatted markup to the current element tag.

Specified by:

writeMarkup in interface XMLWriter

Parameters:

markup - the text which should be written

Throws:

IOException - if writing the markup fails

endElement

public void endElement()
                throws IOException

End the previously opened element.

Specified by:

endElement in interface XMLWriter

Throws:

IOException - if ending the element fails.

See Also:

• XMLWriter.startElement(String)