JAXB OSGI 4.0.9 · com.sun.xml.txw2.output.IndentingXMLStreamWriter

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

Access	Constructor and Description
public	IndentingXMLStreamWriter(XMLStreamWriter writer)

Modifier and Type	Method and Description
private void	doIndent() Print indentation for the current level.
public int	Returns: The number of spaces in each indentation step, or 0 or less for no indentation. getIndentStep() Deprecated Only return the length of the indent string. Return the current indent step.
private void	onEmptyElement()
private void	onEndElement()
private void	onStartElement()
public void	setIndentStep(int The new indent step (0 or less for no indentation). indentStep) Deprecated Should use the version that takes string. Set the current indent step.
public void	setIndentStep(String s)
public void	writeCData(String data) Overrides com.sun.xml.txw2.output.DelegatingXMLStreamWriter.writeCData. Implements javax.xml.stream.XMLStreamWriter.writeCData. Writes a CData section
public void	writeCharacters(String text) Overrides com.sun.xml.txw2.output.DelegatingXMLStreamWriter.writeCharacters. Implements javax.xml.stream.XMLStreamWriter.writeCharacters. Write text to the output
public void	writeCharacters(char[] text, int start, int len) Overrides com.sun.xml.txw2.output.DelegatingXMLStreamWriter.writeCharacters. Implements javax.xml.stream.XMLStreamWriter.writeCharacters. Write text to the output
public void	writeEmptyElement(String namespaceURI, String localName) Overrides com.sun.xml.txw2.output.DelegatingXMLStreamWriter.writeEmptyElement. Implements javax.xml.stream.XMLStreamWriter.writeEmptyElement. Writes an empty element tag to the output
public void	writeEmptyElement(String prefix, String localName, String namespaceURI) Overrides com.sun.xml.txw2.output.DelegatingXMLStreamWriter.writeEmptyElement. Implements javax.xml.stream.XMLStreamWriter.writeEmptyElement. Writes an empty element tag to the output
public void	writeEmptyElement(String localName) Overrides com.sun.xml.txw2.output.DelegatingXMLStreamWriter.writeEmptyElement. Implements javax.xml.stream.XMLStreamWriter.writeEmptyElement. Writes an empty element tag to the output
public void	writeEndElement() Overrides com.sun.xml.txw2.output.DelegatingXMLStreamWriter.writeEndElement. Implements javax.xml.stream.XMLStreamWriter.writeEndElement. Writes an end tag to the output relying on the internal state of the writer to determine the prefix and local name of the event.
public void	writeStartDocument() Overrides com.sun.xml.txw2.output.DelegatingXMLStreamWriter.writeStartDocument. Implements javax.xml.stream.XMLStreamWriter.writeStartDocument. Write the XML Declaration.
public void	writeStartDocument(String version) Overrides com.sun.xml.txw2.output.DelegatingXMLStreamWriter.writeStartDocument. Implements javax.xml.stream.XMLStreamWriter.writeStartDocument. Write the XML Declaration.
public void	writeStartDocument(String encoding, String version) Overrides com.sun.xml.txw2.output.DelegatingXMLStreamWriter.writeStartDocument. Implements javax.xml.stream.XMLStreamWriter.writeStartDocument. Write the XML Declaration.
public void	writeStartElement(String localName) Overrides com.sun.xml.txw2.output.DelegatingXMLStreamWriter.writeStartElement. Implements javax.xml.stream.XMLStreamWriter.writeStartElement. Writes a start tag to the output.
public void	writeStartElement(String namespaceURI, String localName) Overrides com.sun.xml.txw2.output.DelegatingXMLStreamWriter.writeStartElement. Implements javax.xml.stream.XMLStreamWriter.writeStartElement. Writes a start tag to the output
public void	writeStartElement(String prefix, String localName, String namespaceURI) Overrides com.sun.xml.txw2.output.DelegatingXMLStreamWriter.writeStartElement. Implements javax.xml.stream.XMLStreamWriter.writeStartElement. Writes a start tag to the output

depth	back to summary
private int depth

indentStep	back to summary
private String indentStep

SEEN_DATA	back to summary
private static final Object SEEN_DATA

SEEN_ELEMENT	back to summary
private static final Object SEEN_ELEMENT

SEEN_NOTHING	back to summary
private static final Object SEEN_NOTHING

state	back to summary
private Object state

stateStack	back to summary
private Stack<Object> stateStack

IndentingXMLStreamWriter	back to summary
public IndentingXMLStreamWriter(XMLStreamWriter writer)

Method Detail

doIndent	back to summary
private void doIndent() throws XMLStreamException Print indentation for the current level. Exceptions XMLStreamException: If there is an error writing the indentation characters, or if a filter further down the chain raises an exception.

doIndent

back to summary

private void doIndent() throws XMLStreamException

Print indentation for the current level.

Exceptions

XMLStreamException:: If there is an error writing the indentation characters, or if a filter further down the chain raises an exception.

getIndentStep back to summary

getIndentStep	back to summary
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:int The number of spaces in each indentation step, or 0 or less for no indentation. Annotations @Deprecated See Also `setIndentStep(int)`

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:int

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

Annotations

@Deprecated

See Also

setIndentStep(int)

onEmptyElement	back to summary
private void onEmptyElement() throws XMLStreamException

onEndElement	back to summary
private void onEndElement() throws XMLStreamException

onStartElement	back to summary
private void onStartElement() throws XMLStreamException

setIndentStep back to summary

setIndentStep	back to summary
public void setIndentStep(int indentStep) Deprecated Should use the version that takes string. Set the current indent step. Parameters indentStep:int The new indent step (0 or less for no indentation). Annotations @Deprecated See Also `getIndentStep()`

public void setIndentStep(int indentStep)

Deprecated

Should use the version that takes string.

Set the current indent step.

Parameters

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

Annotations

@Deprecated

See Also

getIndentStep()

setIndentStep	back to summary
public void setIndentStep(String s)

writeCData	back to summary
public void writeCData(String data) throws XMLStreamException Overrides com.sun.xml.txw2.output.DelegatingXMLStreamWriter.writeCData. Implements javax.xml.stream.XMLStreamWriter.writeCData. Doc from javax.xml.stream.XMLStreamWriter.writeCData. Writes a CData section Annotations @Override Exceptions XMLStreamException: if an error occurs

writeCData

back to summary

public void writeCData(String data) throws XMLStreamException

Overrides com.sun.xml.txw2.output.DelegatingXMLStreamWriter.writeCData.

Implements javax.xml.stream.XMLStreamWriter.writeCData.

Doc from javax.xml.stream.XMLStreamWriter.writeCData.

Writes a CData section

Annotations

@Override

Exceptions

XMLStreamException:: if an error occurs

writeCharacters	back to summary
public void writeCharacters(String text) throws XMLStreamException Overrides com.sun.xml.txw2.output.DelegatingXMLStreamWriter.writeCharacters. Implements javax.xml.stream.XMLStreamWriter.writeCharacters. Doc from javax.xml.stream.XMLStreamWriter.writeCharacters. Write text to the output Annotations @Override Exceptions XMLStreamException: if an error occurs

writeCharacters

back to summary

public void writeCharacters(String text) throws XMLStreamException

Overrides com.sun.xml.txw2.output.DelegatingXMLStreamWriter.writeCharacters.

Implements javax.xml.stream.XMLStreamWriter.writeCharacters.

Doc from javax.xml.stream.XMLStreamWriter.writeCharacters.

Write text to the output

Annotations

@Override

Exceptions

XMLStreamException:: if an error occurs

writeCharacters	back to summary
public void writeCharacters(char[] text, int start, int len) throws XMLStreamException Overrides com.sun.xml.txw2.output.DelegatingXMLStreamWriter.writeCharacters. Implements javax.xml.stream.XMLStreamWriter.writeCharacters. Doc from javax.xml.stream.XMLStreamWriter.writeCharacters. Write text to the output Annotations @Override Exceptions XMLStreamException: if an error occurs

writeCharacters

back to summary

public void writeCharacters(char[] text, int start, int len) throws XMLStreamException

Overrides com.sun.xml.txw2.output.DelegatingXMLStreamWriter.writeCharacters.

Implements javax.xml.stream.XMLStreamWriter.writeCharacters.

Doc from javax.xml.stream.XMLStreamWriter.writeCharacters.

Write text to the output

Annotations

@Override

Exceptions

XMLStreamException:: if an error occurs

writeEmptyElement	back to summary
public void writeEmptyElement(String namespaceURI, String localName) throws XMLStreamException Overrides com.sun.xml.txw2.output.DelegatingXMLStreamWriter.writeEmptyElement. Implements javax.xml.stream.XMLStreamWriter.writeEmptyElement. Doc from javax.xml.stream.XMLStreamWriter.writeEmptyElement. Writes an empty element tag to the output Annotations @Override Exceptions XMLStreamException: if the namespace URI has not been bound to a prefix and javax.xml.stream.isRepairingNamespaces has not been set to true

writeEmptyElement

back to summary

public void writeEmptyElement(String namespaceURI, String localName) throws XMLStreamException

Overrides com.sun.xml.txw2.output.DelegatingXMLStreamWriter.writeEmptyElement.

Implements javax.xml.stream.XMLStreamWriter.writeEmptyElement.

Doc from javax.xml.stream.XMLStreamWriter.writeEmptyElement.

Writes an empty element tag to the output

Annotations

@Override

Exceptions

XMLStreamException:: if the namespace URI has not been bound to a prefix and javax.xml.stream.isRepairingNamespaces has not been set to true

writeEmptyElement	back to summary
public void writeEmptyElement(String prefix, String localName, String namespaceURI) throws XMLStreamException Overrides com.sun.xml.txw2.output.DelegatingXMLStreamWriter.writeEmptyElement. Implements javax.xml.stream.XMLStreamWriter.writeEmptyElement. Doc from javax.xml.stream.XMLStreamWriter.writeEmptyElement. Writes an empty element tag to the output Annotations @Override Exceptions XMLStreamException: if an error occurs

writeEmptyElement

back to summary

public void writeEmptyElement(String prefix, String localName, String namespaceURI) throws XMLStreamException

Overrides com.sun.xml.txw2.output.DelegatingXMLStreamWriter.writeEmptyElement.

Implements javax.xml.stream.XMLStreamWriter.writeEmptyElement.

Doc from javax.xml.stream.XMLStreamWriter.writeEmptyElement.

Writes an empty element tag to the output

Annotations

@Override

Exceptions

XMLStreamException:: if an error occurs

writeEmptyElement	back to summary
public void writeEmptyElement(String localName) throws XMLStreamException Overrides com.sun.xml.txw2.output.DelegatingXMLStreamWriter.writeEmptyElement. Implements javax.xml.stream.XMLStreamWriter.writeEmptyElement. Doc from javax.xml.stream.XMLStreamWriter.writeEmptyElement. Writes an empty element tag to the output Annotations @Override Exceptions XMLStreamException: if an error occurs

writeEmptyElement

back to summary

public void writeEmptyElement(String localName) throws XMLStreamException

Overrides com.sun.xml.txw2.output.DelegatingXMLStreamWriter.writeEmptyElement.

Implements javax.xml.stream.XMLStreamWriter.writeEmptyElement.

Doc from javax.xml.stream.XMLStreamWriter.writeEmptyElement.

Writes an empty element tag to the output

Annotations

@Override

Exceptions

XMLStreamException:: if an error occurs

writeEndElement	back to summary
public void writeEndElement() throws XMLStreamException Overrides com.sun.xml.txw2.output.DelegatingXMLStreamWriter.writeEndElement. Implements javax.xml.stream.XMLStreamWriter.writeEndElement. Doc from javax.xml.stream.XMLStreamWriter.writeEndElement. Writes an end tag to the output relying on the internal state of the writer to determine the prefix and local name of the event. Annotations @Override Exceptions XMLStreamException: if an error occurs

writeEndElement

back to summary

public void writeEndElement() throws XMLStreamException

Overrides com.sun.xml.txw2.output.DelegatingXMLStreamWriter.writeEndElement.

Implements javax.xml.stream.XMLStreamWriter.writeEndElement.

Doc from javax.xml.stream.XMLStreamWriter.writeEndElement.

Writes an end tag to the output relying on the internal state of the writer to determine the prefix and local name of the event.

Annotations

@Override

Exceptions

XMLStreamException:: if an error occurs

writeStartDocument	back to summary
public void writeStartDocument() throws XMLStreamException Overrides com.sun.xml.txw2.output.DelegatingXMLStreamWriter.writeStartDocument. Implements javax.xml.stream.XMLStreamWriter.writeStartDocument. Doc from javax.xml.stream.XMLStreamWriter.writeStartDocument. Write the XML Declaration. Defaults the XML version to 1.0, and the encoding to utf-8 Annotations @Override Exceptions XMLStreamException: if an error occurs

writeStartDocument

back to summary

public void writeStartDocument() throws XMLStreamException

Overrides com.sun.xml.txw2.output.DelegatingXMLStreamWriter.writeStartDocument.

Implements javax.xml.stream.XMLStreamWriter.writeStartDocument.

Doc from javax.xml.stream.XMLStreamWriter.writeStartDocument.

Write the XML Declaration. Defaults the XML version to 1.0, and the encoding to utf-8

Annotations

@Override

Exceptions

XMLStreamException:: if an error occurs

writeStartDocument	back to summary
public void writeStartDocument(String version) throws XMLStreamException Overrides com.sun.xml.txw2.output.DelegatingXMLStreamWriter.writeStartDocument. Implements javax.xml.stream.XMLStreamWriter.writeStartDocument. Doc from javax.xml.stream.XMLStreamWriter.writeStartDocument. Write the XML Declaration. Defaults the XML version to 1.0 Annotations @Override Exceptions XMLStreamException: if an error occurs

writeStartDocument

back to summary

public void writeStartDocument(String version) throws XMLStreamException

Overrides com.sun.xml.txw2.output.DelegatingXMLStreamWriter.writeStartDocument.

Implements javax.xml.stream.XMLStreamWriter.writeStartDocument.

Doc from javax.xml.stream.XMLStreamWriter.writeStartDocument.

Write the XML Declaration. Defaults the XML version to 1.0

Annotations

@Override

Exceptions

XMLStreamException:: if an error occurs

writeStartDocument	back to summary
public void writeStartDocument(String encoding, String version) throws XMLStreamException Overrides com.sun.xml.txw2.output.DelegatingXMLStreamWriter.writeStartDocument. Implements javax.xml.stream.XMLStreamWriter.writeStartDocument. Doc from javax.xml.stream.XMLStreamWriter.writeStartDocument. Write the XML Declaration. Note that the encoding parameter does not set the actual encoding of the underlying output. That must be set when the instance of the XMLStreamWriter is created using the XMLOutputFactory Annotations @Override Exceptions XMLStreamException: If given encoding does not match encoding of the underlying stream

writeStartDocument

back to summary

public void writeStartDocument(String encoding, String version) throws XMLStreamException

Overrides com.sun.xml.txw2.output.DelegatingXMLStreamWriter.writeStartDocument.

Implements javax.xml.stream.XMLStreamWriter.writeStartDocument.

Doc from javax.xml.stream.XMLStreamWriter.writeStartDocument.

Write the XML Declaration. Note that the encoding parameter does not set the actual encoding of the underlying output. That must be set when the instance of the XMLStreamWriter is created using the XMLOutputFactory

Annotations

@Override

Exceptions

XMLStreamException:: If given encoding does not match encoding of the underlying stream

writeStartElement	back to summary
public void writeStartElement(String localName) throws XMLStreamException Overrides com.sun.xml.txw2.output.DelegatingXMLStreamWriter.writeStartElement. Implements javax.xml.stream.XMLStreamWriter.writeStartElement. Doc from javax.xml.stream.XMLStreamWriter.writeStartElement. Writes a start tag to the output. All writeStartElement methods open a new scope in the internal namespace context. Writing the corresponding EndElement causes the scope to be closed. Annotations @Override Exceptions XMLStreamException: if an error occurs

writeStartElement

back to summary

public void writeStartElement(String localName) throws XMLStreamException

Overrides com.sun.xml.txw2.output.DelegatingXMLStreamWriter.writeStartElement.

Implements javax.xml.stream.XMLStreamWriter.writeStartElement.

Doc from javax.xml.stream.XMLStreamWriter.writeStartElement.

Writes a start tag to the output. All writeStartElement methods open a new scope in the internal namespace context. Writing the corresponding EndElement causes the scope to be closed.

Annotations

@Override

Exceptions

XMLStreamException:: if an error occurs

writeStartElement	back to summary
public void writeStartElement(String namespaceURI, String localName) throws XMLStreamException Overrides com.sun.xml.txw2.output.DelegatingXMLStreamWriter.writeStartElement. Implements javax.xml.stream.XMLStreamWriter.writeStartElement. Doc from javax.xml.stream.XMLStreamWriter.writeStartElement. Writes a start tag to the output Annotations @Override Exceptions XMLStreamException: if the namespace URI has not been bound to a prefix and javax.xml.stream.isRepairingNamespaces has not been set to true

writeStartElement

back to summary

public void writeStartElement(String namespaceURI, String localName) throws XMLStreamException

Overrides com.sun.xml.txw2.output.DelegatingXMLStreamWriter.writeStartElement.

Implements javax.xml.stream.XMLStreamWriter.writeStartElement.

Doc from javax.xml.stream.XMLStreamWriter.writeStartElement.

Writes a start tag to the output

Annotations

@Override

Exceptions

XMLStreamException:: if the namespace URI has not been bound to a prefix and javax.xml.stream.isRepairingNamespaces has not been set to true

writeStartElement	back to summary
public void writeStartElement(String prefix, String localName, String namespaceURI) throws XMLStreamException Overrides com.sun.xml.txw2.output.DelegatingXMLStreamWriter.writeStartElement. Implements javax.xml.stream.XMLStreamWriter.writeStartElement. Doc from javax.xml.stream.XMLStreamWriter.writeStartElement. Writes a start tag to the output Annotations @Override Exceptions XMLStreamException: if an error occurs

writeStartElement

back to summary