Package org.glassfish.hk2.utilities.general

Class IndentingXMLStreamWriter

java.lang.Object

org.glassfish.hk2.utilities.general.DelegatingXMLStreamWriter

org.glassfish.hk2.utilities.general.IndentingXMLStreamWriter

All Implemented Interfaces:

javax.xml.stream.XMLStreamWriter

public class IndentingXMLStreamWriter
extends DelegatingXMLStreamWriter

Field Summary

Fields

Modifier and Type	Field	Description
private int	depth
private java.lang.String	indentStep
private static java.lang.Object	SEEN_DATA
private static java.lang.Object	SEEN_ELEMENT
private static java.lang.Object	SEEN_NOTHING
private java.lang.Object	state
private java.util.Stack<java.lang.Object>	stateStack

Constructor Summary

Constructors

Constructor	Description
IndentingXMLStreamWriter(javax.xml.stream.XMLStreamWriter writer)

Method Summary

Modifier and Type	Method	Description
private void	doIndent()	Print indentation for the current level.
int	getIndentStep()	Deprecated. Only return the length of the indent string.
private void	onEmptyElement()
private void	onEndElement()
private void	onStartElement()
void	setIndentStep(int indentStep)	Deprecated. Should use the version that takes string.
void	setIndentStep(java.lang.String s)
void	writeCData(java.lang.String data)
void	writeCharacters(char[] text, int start, int len)
void	writeCharacters(java.lang.String text)
void	writeEmptyElement(java.lang.String localName)
void	writeEmptyElement(java.lang.String namespaceURI, java.lang.String localName)
void	writeEmptyElement(java.lang.String prefix, java.lang.String localName, java.lang.String namespaceURI)
void	writeEndElement()
void	writeStartDocument()
void	writeStartDocument(java.lang.String version)
void	writeStartDocument(java.lang.String encoding, java.lang.String version)
void	writeStartElement(java.lang.String localName)
void	writeStartElement(java.lang.String namespaceURI, java.lang.String localName)
void	writeStartElement(java.lang.String prefix, java.lang.String localName, java.lang.String namespaceURI)

Methods inherited from class org.glassfish.hk2.utilities.general.DelegatingXMLStreamWriter

close, flush, getNamespaceContext, getPrefix, getProperty, setDefaultNamespace, setNamespaceContext, setPrefix, writeAttribute, writeAttribute, writeAttribute, writeComment, writeDefaultNamespace, writeDTD, writeEndDocument, writeEntityRef, writeNamespace, writeProcessingInstruction, writeProcessingInstruction

Methods inherited from class java.lang.Object

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

Field Detail

SEEN_NOTHING

private static final java.lang.Object SEEN_NOTHING

SEEN_ELEMENT

private static final java.lang.Object SEEN_ELEMENT

SEEN_DATA

private static final java.lang.Object SEEN_DATA

state

private java.lang.Object state

stateStack

private java.util.Stack<java.lang.Object> stateStack

indentStep

private java.lang.String indentStep

depth

private int depth

Constructor Detail

IndentingXMLStreamWriter

public IndentingXMLStreamWriter(javax.xml.stream.XMLStreamWriter writer)

Method Detail

getIndentStep

public int getIndentStep()

Deprecated.

Only return the length of the indent string.

Return the current indent step.

Return the current indent step: each start tag will be indented by this number of spaces times the number of ancestors that the element has.

Returns:

The number of spaces in each indentation step, or 0 or less for no indentation.

See Also:

setIndentStep(int)

setIndentStep

public void setIndentStep(int indentStep)

Deprecated.

Should use the version that takes string.

Set the current indent step.

Parameters:

indentStep - The new indent step (0 or less for no indentation).

See Also:

getIndentStep()

setIndentStep

public void setIndentStep(java.lang.String s)

onStartElement

private void onStartElement()
                     throws javax.xml.stream.XMLStreamException

Throws:

javax.xml.stream.XMLStreamException

onEndElement

private void onEndElement()
                   throws javax.xml.stream.XMLStreamException

Throws:

javax.xml.stream.XMLStreamException

onEmptyElement

private void onEmptyElement()
                     throws javax.xml.stream.XMLStreamException

Throws:

javax.xml.stream.XMLStreamException

doIndent

private void doIndent()
               throws javax.xml.stream.XMLStreamException

Print indentation for the current level.

Throws:

org.xml.sax.SAXException - If there is an error writing the indentation characters, or if a filter further down the chain raises an exception.

javax.xml.stream.XMLStreamException

writeStartDocument

public void writeStartDocument()
                        throws javax.xml.stream.XMLStreamException

Specified by:

writeStartDocument in interface javax.xml.stream.XMLStreamWriter

Overrides:

writeStartDocument in class DelegatingXMLStreamWriter

Throws:

javax.xml.stream.XMLStreamException

writeStartDocument

public void writeStartDocument(java.lang.String version)
                        throws javax.xml.stream.XMLStreamException

Specified by:

writeStartDocument in interface javax.xml.stream.XMLStreamWriter

Overrides:

writeStartDocument in class DelegatingXMLStreamWriter

Throws:

javax.xml.stream.XMLStreamException

writeStartDocument

public void writeStartDocument(java.lang.String encoding,
                               java.lang.String version)
                        throws javax.xml.stream.XMLStreamException

Specified by:

writeStartDocument in interface javax.xml.stream.XMLStreamWriter

Overrides:

writeStartDocument in class DelegatingXMLStreamWriter

Throws:

javax.xml.stream.XMLStreamException

writeStartElement

public void writeStartElement(java.lang.String localName)
                       throws javax.xml.stream.XMLStreamException

Specified by:

writeStartElement in interface javax.xml.stream.XMLStreamWriter

Overrides:

writeStartElement in class DelegatingXMLStreamWriter

Throws:

javax.xml.stream.XMLStreamException

writeStartElement

public void writeStartElement(java.lang.String namespaceURI,
                              java.lang.String localName)
                       throws javax.xml.stream.XMLStreamException

Specified by:

writeStartElement in interface javax.xml.stream.XMLStreamWriter

Overrides:

writeStartElement in class DelegatingXMLStreamWriter

Throws:

javax.xml.stream.XMLStreamException

writeStartElement

public void writeStartElement(java.lang.String prefix,
                              java.lang.String localName,
                              java.lang.String namespaceURI)
                       throws javax.xml.stream.XMLStreamException

Specified by:

writeStartElement in interface javax.xml.stream.XMLStreamWriter

Overrides:

writeStartElement in class DelegatingXMLStreamWriter

Throws:

javax.xml.stream.XMLStreamException

writeEmptyElement

public void writeEmptyElement(java.lang.String namespaceURI,
                              java.lang.String localName)
                       throws javax.xml.stream.XMLStreamException

Specified by:

writeEmptyElement in interface javax.xml.stream.XMLStreamWriter

Overrides:

writeEmptyElement in class DelegatingXMLStreamWriter

Throws:

javax.xml.stream.XMLStreamException

writeEmptyElement

public void writeEmptyElement(java.lang.String prefix,
                              java.lang.String localName,
                              java.lang.String namespaceURI)
                       throws javax.xml.stream.XMLStreamException

Specified by:

writeEmptyElement in interface javax.xml.stream.XMLStreamWriter

Overrides:

writeEmptyElement in class DelegatingXMLStreamWriter

Throws:

javax.xml.stream.XMLStreamException

writeEmptyElement

public void writeEmptyElement(java.lang.String localName)
                       throws javax.xml.stream.XMLStreamException

Specified by:

writeEmptyElement in interface javax.xml.stream.XMLStreamWriter

Overrides:

writeEmptyElement in class DelegatingXMLStreamWriter

Throws:

javax.xml.stream.XMLStreamException

writeEndElement

public void writeEndElement()
                     throws javax.xml.stream.XMLStreamException

Specified by:

writeEndElement in interface javax.xml.stream.XMLStreamWriter

Overrides:

writeEndElement in class DelegatingXMLStreamWriter

Throws:

javax.xml.stream.XMLStreamException

writeCharacters

public void writeCharacters(java.lang.String text)
                     throws javax.xml.stream.XMLStreamException

Specified by:

writeCharacters in interface javax.xml.stream.XMLStreamWriter

Overrides:

writeCharacters in class DelegatingXMLStreamWriter

Throws:

javax.xml.stream.XMLStreamException

writeCharacters

public void writeCharacters(char[] text,
                            int start,
                            int len)
                     throws javax.xml.stream.XMLStreamException

Specified by:

writeCharacters in interface javax.xml.stream.XMLStreamWriter

Overrides:

writeCharacters in class DelegatingXMLStreamWriter

Throws:

javax.xml.stream.XMLStreamException

writeCData

public void writeCData(java.lang.String data)
                throws javax.xml.stream.XMLStreamException

Specified by:

writeCData in interface javax.xml.stream.XMLStreamWriter

Overrides:

writeCData in class DelegatingXMLStreamWriter

Throws:

javax.xml.stream.XMLStreamException