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

Class PrettyPrintXMLWriter

java.lang.Object

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

All Implemented Interfaces:

XMLWriter

@Deprecated
public class PrettyPrintXMLWriter
extends java.lang.Object
implements XMLWriter

Deprecated.

this class swallows and ignores IOExceptions. It is dangerous to use when writing to anything other than a StringWriter.

XMLWriter with nice indentation.

Author:

kama

Constructor Summary

Constructors

Constructor	Description
PrettyPrintXMLWriter(java.io.PrintWriter writer)	Deprecated.
PrettyPrintXMLWriter(java.io.PrintWriter writer, java.lang.String lineIndent)	Deprecated.
PrettyPrintXMLWriter(java.io.PrintWriter writer, java.lang.String encoding, java.lang.String doctype)	Deprecated.
PrettyPrintXMLWriter(java.io.PrintWriter writer, java.lang.String lineIndent, java.lang.String encoding, java.lang.String doctype)	Deprecated.
PrettyPrintXMLWriter(java.io.PrintWriter writer, java.lang.String lineIndent, java.lang.String lineSeparator, java.lang.String encoding, java.lang.String doctype)	Deprecated.
PrettyPrintXMLWriter(java.io.Writer writer)	Deprecated.
PrettyPrintXMLWriter(java.io.Writer writer, java.lang.String lineIndent)	Deprecated.
PrettyPrintXMLWriter(java.io.Writer writer, java.lang.String encoding, java.lang.String doctype)	Deprecated.
PrettyPrintXMLWriter(java.io.Writer writer, java.lang.String lineIndent, java.lang.String encoding, java.lang.String doctype)	Deprecated.

Method Summary

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

PrettyPrintXMLWriter

public PrettyPrintXMLWriter(java.io.PrintWriter writer,
                            java.lang.String lineIndent)

Deprecated.

Parameters:

writer - not null

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

PrettyPrintXMLWriter

public PrettyPrintXMLWriter(java.io.Writer writer,
                            java.lang.String lineIndent)

Deprecated.

Parameters:

writer - not null

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

PrettyPrintXMLWriter

public PrettyPrintXMLWriter(java.io.PrintWriter writer)

Deprecated.

Parameters:

writer - not null

PrettyPrintXMLWriter

public PrettyPrintXMLWriter(java.io.Writer writer)

Deprecated.

Parameters:

writer - not null

PrettyPrintXMLWriter

public PrettyPrintXMLWriter(java.io.PrintWriter writer,
                            java.lang.String lineIndent,
                            java.lang.String encoding,
                            java.lang.String doctype)

Deprecated.

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(java.io.Writer writer,
                            java.lang.String lineIndent,
                            java.lang.String encoding,
                            java.lang.String doctype)

Deprecated.

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(java.io.PrintWriter writer,
                            java.lang.String encoding,
                            java.lang.String doctype)

Deprecated.

Parameters:

writer - not null

encoding - can be null or invalid

doctype - can be null

PrettyPrintXMLWriter

public PrettyPrintXMLWriter(java.io.Writer writer,
                            java.lang.String encoding,
                            java.lang.String doctype)

Deprecated.

Parameters:

writer - not null

encoding - can be null or invalid

doctype - can be null

PrettyPrintXMLWriter

public PrettyPrintXMLWriter(java.io.PrintWriter writer,
                            java.lang.String lineIndent,
                            java.lang.String lineSeparator,
                            java.lang.String encoding,
                            java.lang.String doctype)

Deprecated.

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 Detail

addAttribute

public void addAttribute(java.lang.String key,
                         java.lang.String value)
                  throws java.io.IOException

Deprecated.

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:

java.io.IOException - if adding the attribute fails

setEncoding

public void setEncoding(java.lang.String encoding)

Deprecated.

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(java.lang.String docType)

Deprecated.

Sets the DOCTYPE of the document.

Specified by:

setDocType in interface XMLWriter

Parameters:

docType - the docType

setLineSeparator

public void setLineSeparator(java.lang.String lineSeparator)

Deprecated.

Parameters:

lineSeparator - the line separator to be output

setLineIndenter

public void setLineIndenter(java.lang.String lineIndentParameter)

Deprecated.

Parameters:

lineIndentParameter - the line indent parameter

startElement

public void startElement(java.lang.String elementName)
                  throws java.io.IOException

Deprecated.

Start an XML Element tag.

Specified by:

startElement in interface XMLWriter

Parameters:

elementName - the name of the tag

Throws:

java.io.IOException - if starting the element fails

writeText

public void writeText(java.lang.String text)
               throws java.io.IOException

Deprecated.

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:

java.io.IOException - if writing the text fails

writeMarkup

public void writeMarkup(java.lang.String markup)
                 throws java.io.IOException

Deprecated.

Add preformatted markup to the current element tag.

Specified by:

writeMarkup in interface XMLWriter

Parameters:

markup - the text which should be written

Throws:

java.io.IOException - if writing the markup fails

endElement

public void endElement()
                throws java.io.IOException

Deprecated.

End the previously opened element.

Specified by:

endElement in interface XMLWriter

Throws:

java.io.IOException - if ending the element fails

See Also:

XMLWriter.startElement(String)