XMLOutputter (XMLenc 0.53 API)

java.lang.Object
- org.znerd.xmlenc.XMLOutputter

All Implemented Interfaces:

StatefulXMLEventListener, XMLEventListener, XMLEventListenerStates
```
public class XMLOutputter
extends Object
implements StatefulXMLEventListener
```
Stream-based XML outputter. Instances of this class are able to write XML output to Writers.
Standards compliance
This class is intended to produce output that conforms to the XML 1.0 Specification. However, not all applicable restrictions are validated. For example, it is currently not checked if names contain characters that are invalid within a Name production.
Furthermore, not all possible XML documents can be produced. The following limitations apply:
- the name of the applicable encoding is always printed in the XML declaration, even though it may not be necessary;
- the standalone attribute is not supported in the XML declaration;
- internal DTD subsets are not supported;
- the strategy for inserting spacing is fixed: whitespace is kept to the minimum, still whitespace can be inserted manually using whitespace(String);
- XML Namespaces are not explicitly supported, although this can be implemented on top of this class.
Supported encodings
The following encodings are supported:
- UTF-8
- UTF-16
- ISO-10646-UCS-2
- ISO-10646-UCS-4
- ISO-10646-UTF-1
- US-ASCII (also known as ASCII)
- ISO-8859-n, where n is the part number
Multi-threading
This class is not thread-safe. Do not use it from multiple threads at the same time.
Exceptions
Note that all methods check the state first and then check the arguments. This means that if the state is incorrect and the arguments are incorrect, then an IllegalStateException will be thrown.
If any of the writing methods generates an IOException, then the state will be set to XMLEventListenerStates.ERROR_STATE and no more output can be performed.
Performance hints
It is usually a good idea to let XMLOutputter instances write to buffered Writers. This typically improves performance on large documents or relatively slow or blocking output streams.
Instances of this class can be cached in a pool to reduce object creations. Call reset() (with no arguments) when storing an instance in the pool. Use reset(Writer,String) (with 2 arguments) to re-initialize the instance after fetching it from the pool.
Since:

xmlenc 0.19

Field Summary

Fields
Modifier and Type Field and Description

static String DEFAULT_INDENTATION
Default indentation.
- Fields inherited from interface org.znerd.xmlenc.XMLEventListenerStates
  AFTER_ROOT_ELEMENT, BEFORE_DTD_DECLARATION, BEFORE_ROOT_ELEMENT, BEFORE_XML_DECLARATION, DOCUMENT_ENDED, ERROR_STATE, START_TAG_OPEN, UNINITIALIZED, WITHIN_ELEMENT

Fields
Modifier and Type	Field and Description
`static String`	`DEFAULT_INDENTATION` Default indentation.

Constructor Summary

Constructors
Constructor and Description
`XMLOutputter()` Constructs a new `XMLOutputter`.
`XMLOutputter(Writer out, String encoding)` Constructs a new `XMLOutputter` for the specified `Writer` and encoding.
`XMLOutputter(Writer out, XMLEncoder encoder)` Constructs a new `XMLOutputter` for the specified `Writer` and `encoder`.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`attribute(String name, boolean value)` Adds an attribute to the current element, with a `boolean` value.
`void`	`attribute(String name, byte value)` Adds an attribute to the current element, with a `byte` value.
`void`	`attribute(String name, char c)` Adds an attribute to the current element, with a `char` value.
`void`	`attribute(String name, double value)` Adds an attribute to the current element, with a `double` value.
`void`	`attribute(String name, float value)` Adds an attribute to the current element, with a `float` value.
`void`	`attribute(String name, int value)` Adds an attribute to the current element, with an `int` value.
`void`	`attribute(String name, long value)` Adds an attribute to the current element, with a `long` value.
`void`	`attribute(String name, short value)` Adds an attribute to the current element, with a `short` value.
`void`	`attribute(String name, String value)` Adds an attribute to the current element, with a `String` value.
`void`	`cdata(String text)` Writes a CDATA section.
`void`	`close()` Closes all open elements.
`void`	`comment(String text)` Writes the specified comment.
`void`	`declaration()` Writes the XML declaration.
`void`	`dtd(String name, String publicID, String systemID)` Writes a document type declaration.
`void`	`emptyTag(String type)` Writes an empty tag.
`void`	`endDocument()` Finishes the XML output.
`void`	`endTag()` Writes the end tag for the element on top of the stack.
`void`	`endTag(String type)` Writes end tags for elements on the stack until (and including) an element that matches the specified name.
`String[]`	`getElementStack()` Returns a copy of the element stack.
`int`	`getElementStackCapacity()` Returns the current capacity for the stack of open elements.
`int`	`getElementStackSize()` Returns the current depth of open elements.
`String`	`getEncoding()` Returns the encoding of this outputter.
`String`	`getIndentation()` Returns the string currently used for indentation.
`LineBreak`	`getLineBreak()` Returns the currently used line break.
`char`	`getQuotationMark()` Gets the quotation mark character.
`XMLEventListenerState`	`getState()` Returns the current state of this outputter.
`Writer`	`getWriter()` Returns the output stream this outputter uses.
`boolean`	`isEscaping()` Checks if escaping is currently enabled.
`void`	`pcdata(char[] ch, int start, int length)` Writes the specified character array as PCDATA.
`void`	`pcdata(String text)` Writes the specified `String` as PCDATA.
`void`	`pi(String target, String instruction)` Writes a processing instruction.
`void`	`reset()` Resets this `XMLOutputter`.
`void`	`reset(Writer out, String encoding)` Resets this `XMLOutputter` and configures it for the specified output stream and encoding.
`void`	`reset(Writer out, XMLEncoder encoder)` Resets this `XMLOutputter` and configures it for the specified output stream and encoder.
`void`	`setElementStackCapacity(int newCapacity)` Sets the capacity for the stack of open elements.
`void`	`setEscaping(boolean escapeAmpersands)` Sets if ampersands should be escaped.
`void`	`setIndentation(String indentation)` Sets the string to be used for indentation.
`void`	`setLineBreak(LineBreak lineBreak)` Sets the type of line break to use.
`void`	`setQuotationMark(char c)` Sets the quotation mark character to use.
`void`	`setState(XMLEventListenerState newState, String[] newElementStack)` Sets the state of this outputter.
`void`	`startTag(String type)` Writes an element start tag.
`void`	`whitespace(char[] ch, int start, int length)` Writes text from the specified character array as ignorable whitespace.
`void`	`whitespace(String whitespace)` Writes the specified ignorable whitespace.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - DEFAULT_INDENTATION
```
public static final String DEFAULT_INDENTATION
```
    Default indentation. This is the empty string, "", since by default no indentation is performed.
    
    See Also:
    
    Constant Field Values
- Constructor Detail
  - XMLOutputter
```
public XMLOutputter()
```
    Constructs a new XMLOutputter. This sets the state to XMLEventListenerStates.UNINITIALIZED.
  - XMLOutputter
```
public XMLOutputter(Writer out,
                    String encoding)
             throws IllegalStateException,
                    IllegalArgumentException,
                    UnsupportedEncodingException
```
    Constructs a new XMLOutputter for the specified Writer and encoding. This sets the state to XMLEventListenerStates.BEFORE_XML_DECLARATION.
    The encoding will be stored exactly as passed, leaving the case intact.
    
    Parameters:
    
    out - the output stream to write to, not null.
    
    encoding - the encoding, not null.
    
    Throws:
    
    IllegalStateException - if getState() != XMLEventListenerStates.UNINITIALIZED && getState() != XMLEventListenerStates.AFTER_ROOT_ELEMENT && getState() != XMLEventListenerStates.ERROR_STATE.
    
    IllegalArgumentException - if out == null || encoding == null.
    
    UnsupportedEncodingException - if the specified encoding is not supported.
  - XMLOutputter
```
public XMLOutputter(Writer out,
                    XMLEncoder encoder)
             throws IllegalStateException,
                    IllegalArgumentException,
                    UnsupportedEncodingException
```
    Constructs a new XMLOutputter for the specified Writer and encoder. This sets the state to XMLEventListenerStates.BEFORE_XML_DECLARATION.
    
    Parameters:
    
    out - the output stream to write to, not null.
    
    encoder - the encoder, not null.
    
    Throws:
    
    IllegalStateException - if getState() != XMLEventListenerStates.UNINITIALIZED && getState() != XMLEventListenerStates.AFTER_ROOT_ELEMENT && getState() != XMLEventListenerStates.ERROR_STATE.
    
    IllegalArgumentException - if out == null || encoder == null.
    
    UnsupportedEncodingException - if the specified encoding is not supported.
- Method Detail
  - getWriter
```
public final Writer getWriter()
```
    Returns the output stream this outputter uses.
    
    Returns:
    
    the output stream of this encoding, only null if and only if the state is XMLEventListenerStates.UNINITIALIZED.
  - getEncoding
```
public final String getEncoding()
```
    Returns the encoding of this outputter.
    
    Returns:
    
    the encoding used by this outputter, only null if and only if the state is XMLEventListenerStates.UNINITIALIZED.
  - reset
```
public void reset()
```
    Resets this XMLOutputter. The Writer and the encoding will be set to null, the element stack will be cleared, the state will be set to XMLEventListenerStates.UNINITIALIZED, the line break will be set to LineBreak.NONE and the indentation will be set to DEFAULT_INDENTATION (an empty string).
    
    Specified by:
    
    reset in interface XMLEventListener
  - reset
```
public final void reset(Writer out,
                        String encoding)
                 throws IllegalArgumentException,
                        UnsupportedEncodingException
```
    Resets this XMLOutputter and configures it for the specified output stream and encoding. This resets the state to XMLEventListenerStates.BEFORE_XML_DECLARATION and clears the stack of open elements.
    
    Parameters:
    
    out - the output stream to write to, not null.
    
    encoding - the encoding, not null.
    
    Throws:
    
    IllegalArgumentException - if out == null || encoding == null.
    
    UnsupportedEncodingException - if the specified encoding is not supported.
  - reset
```
public final void reset(Writer out,
                        XMLEncoder encoder)
                 throws IllegalArgumentException,
                        UnsupportedEncodingException
```
    Resets this XMLOutputter and configures it for the specified output stream and encoder. This resets the state to XMLEventListenerStates.BEFORE_XML_DECLARATION and clears the stack of open elements.
    
    Parameters:
    
    out - the output stream to write to, not null.
    
    encoder - the encoder, not null.
    
    Throws:
    
    IllegalArgumentException - if out == null || encoder == null.
    
    UnsupportedEncodingException - if the specified encoding is not supported.
  - setState
```
public final void setState(XMLEventListenerState newState,
                           String[] newElementStack)
                    throws IllegalArgumentException
```
    Sets the state of this outputter. Normally, it is not necessary to call this method.
    Calling this method with XMLEventListenerStates.UNINITIALIZED as the state is equivalent to calling reset().
    Caution: This method can be used to let this class generate invalid XML.
    
    Specified by:
    
    setState in interface XMLEventListener
    
    Parameters:
    
    newState - the new state, not null.
    
    newElementStack - the new element stack, if newState == START_TAG_OPEN || newState == WITHIN_ELEMENT then it should be non-null and containing no null elements, otherwise it must be null.
    
    Throws:
    
    IllegalArgumentException - if newState == null || (newState == XMLEventListenerStates.START_TAG_OPEN && newElementStack == null) || (newState == XMLEventListenerStates.WITHIN_ELEMENT && newElementStack == null) || (newState != XMLEventListenerStates.START_TAG_OPEN && newState != XMLEventListenerStates.WITHIN_ELEMENT && newElementStack != null) || newElementStack[n] == null (where 0 <= n < newElementStack.length).
    
    Since:
    
    xmlenc 0.22
  - getState
```
public final XMLEventListenerState getState()
```
    Returns the current state of this outputter.
    
    Specified by:
    
    getState in interface StatefulXMLEventListener
    
    Specified by:
    
    getState in interface XMLEventListener
    
    Returns:
    
    the current state, cannot be null.
  - isEscaping
```
public final boolean isEscaping()
```
    Checks if escaping is currently enabled. If escaping is enabled, then all ampersand characters ('&') are replaced by the character entity reference "&". This affects PCDATA string printing (pcdata(String) and pcdata(char[],int,int)) and attribute value printing (attribute(String,String)).
    
    Returns:
    
    true if escaping is enabled, false otherwise.
  - setEscaping
```
public final void setEscaping(boolean escapeAmpersands)
```
    Sets if ampersands should be escaped. This affects PCDATA string printing (pcdata(String) and pcdata(char[],int,int)) and attribute value printing (attribute(String,String)).
    If ampersands are not escaped, then entity references can be printed.
    
    Parameters:
    
    escapeAmpersands - true if ampersands should be escaped, false otherwise.
    
    Since:
    
    xmlenc 0.24
  - getElementStack
```
public final String[] getElementStack()
```
    Returns a copy of the element stack. The returned array will be a new array. The size of the array will be equal to the element stack size (see getElementStackSize().
    
    Returns:
    
    a newly constructed array that contains all the element types currently on the element stack, or null if there are no elements on the stack.
    
    Since:
    
    xmlenc 0.22
  - getElementStackSize
```
public final int getElementStackSize()
```
    Returns the current depth of open elements.
    
    Returns:
    
    the open element depth, always >= 0.
    
    Since:
    
    xmlenc 0.22
  - getElementStackCapacity
```
public final int getElementStackCapacity()
```
    Returns the current capacity for the stack of open elements.
    
    Returns:
    
    the open element stack capacity, always >= getElementStackSize().
    
    Since:
    
    xmlenc 0.28
  - setElementStackCapacity
```
public final void setElementStackCapacity(int newCapacity)
                                   throws IllegalArgumentException,
                                          OutOfMemoryError
```
    Sets the capacity for the stack of open elements. The new capacity must at least allow the stack to contain the current open elements.
    
    Parameters:
    
    newCapacity - the new capacity, >= getElementStackSize().
    
    Throws:
    
    IllegalArgumentException - if newCapacity < getElementStackSize().
    
    OutOfMemoryError - if a new array cannot be allocated; this object will still be usable, but the capacity will remain unchanged.
  - setQuotationMark
```
public final void setQuotationMark(char c)
                            throws IllegalArgumentException
```
    Sets the quotation mark character to use. This character is printed before and after an attribute value. It can be either the single or the double quote character.
    The default quotation mark character is '"'.
    
    Parameters:
    
    c - the character to put around attribute values, either '\'' or '"'.
    
    Throws:
    
    IllegalArgumentException - if c != '\'' && c != '"'.
  - getQuotationMark
```
public final char getQuotationMark()
```
    Gets the quotation mark character. This character is used to mark the start and end of an attribute value.
    The default quotation mark character is '"'.
    
    Returns:
    
    the character to put around attribute values, either '\'' or '"'.
  - setLineBreak
```
public final void setLineBreak(LineBreak lineBreak)
```
    Sets the type of line break to use. If the line break is set to LineBreak.NONE, then the indentation is reset to an empty string.
    
    Parameters:
    
    lineBreak - the line break to use; specifying null as the argument is equivalent to specifying LineBreak.NONE.
  - getLineBreak
```
public final LineBreak getLineBreak()
```
    Returns the currently used line break.
    
    Returns:
    
    the currently used line break, never null.
  - setIndentation
```
public final void setIndentation(String indentation)
                          throws IllegalStateException
```
    Sets the string to be used for indentation. A line break must be set prior to calling this method.
    Only space and tab characters are allowed for the indentation.
    
    Parameters:
    
    indentation - the character string used for indentation, or null if the default indentation should be used.
    
    Throws:
    
    IllegalStateException - if getLineBreak() == LineBreak.NONE.
    
    IllegalArgumentException - if indentation contains characters that are neither a space nor a tab.
  getIndentation public final String getIndentation() Returns the string currently used for indentation. Returns: the character string used for indentation, never null. declaration public final void declaration() throws IllegalStateException, IOException Writes the XML declaration. This method always prints the name of the encoding. The case of the encoding is as it was specified during initialization (or re-initialization). If the encoding is set to "ISO-8859-1", then this method will produce the following output: <?xml version="1.0" encoding="ISO-8859-1"?> Specified by: declaration in interface XMLEventListener Throws: IllegalStateException - if getState() != XMLEventListenerStates.BEFORE_XML_DECLARATION. IOException - if an I/O error occurs; this will set the state to XMLEventListenerStates.ERROR_STATE. dtd public final void dtd(String name, String publicID, String systemID) throws IllegalStateException, IllegalArgumentException, InvalidXMLException, IOException Writes a document type declaration. An external subset can be specified using either a system identifier (alone), or using both a public identifier and a system identifier. It can never be specified using a public identifier alone. For example, for XHTML 1.0 the public identifier is: -//W3C//DTD XHTML 1.0 Transitional//EN while the system identifier is: http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd The output is typically similar to this: <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> or alternatively, if only the system identifier is specified: <!DOCTYPE html SYSTEM "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> Specified by: dtd in interface XMLEventListener Parameters: name - the name of the document type, not null. publicID - the public identifier, can be null, but if not, then it must match the PubidLiteral production in the XML 1.0 Specification, when quoted. systemID - the system identifier, can be null, but if not, then it must match the SystemLiteral production in the XML 1.0 Specification, when quoted. Throws: IllegalStateException - if getState() != XMLEventListenerStates.BEFORE_XML_DECLARATION && getState() != XMLEventListenerStates.BEFORE_DTD_DECLARATION. IllegalArgumentException - if name == null || (publicID != null && systemID == null). InvalidXMLException - if the specified name does not match the Name production (see XMLChecker.checkName(String)). IOException - if an I/O error occurs; this will set the state to XMLEventListenerStates.ERROR_STATE. startTag public final void startTag(String type) throws IllegalStateException, IllegalArgumentException, IOException Writes an element start tag. The element type name will be stored in the internal element stack. If necessary, the capacity of this stack will be extended. Specified by: startTag in interface XMLEventListener Parameters: type - the type of the tag to start, not null. Throws: IllegalStateException - if getState() != XMLEventListenerStates.BEFORE_XML_DECLARATION && getState() != XMLEventListenerStates.BEFORE_DTD_DECLARATION && getState() != XMLEventListenerStates.BEFORE_ROOT_ELEMENT && getState() != XMLEventListenerStates.START_TAG_OPEN && getState() != XMLEventListenerStates.WITHIN_ELEMENT. IllegalArgumentException - if type == null. IOException - if an I/O error occurs; this will set the state to XMLEventListenerStates.ERROR_STATE. attribute public final void attribute(String name, String value) throws IllegalStateException, IllegalArgumentException, IOException Adds an attribute to the current element, with a String value. There must currently be an open element. The attribute value is surrounded by the quotation mark character (see getQuotationMark()). Specified by: attribute in interface XMLEventListener Parameters: name - the name of the attribute, not null. value - the value of the attribute, not null. Throws: IllegalStateException - if getState() != XMLEventListenerStates.START_TAG_OPEN. IllegalArgumentException - if name == null || value == null. IOException - if an I/O error occurs; this will set the state to XMLEventListenerStates.ERROR_STATE. attribute public final void attribute(String name, boolean value) throws IllegalStateException, IllegalArgumentException, IOException Adds an attribute to the current element, with a boolean value. There must currently be an open element. The attribute value is surrounded by the quotation mark character (see getQuotationMark()). Parameters: name - the name of the attribute, not null. value - the value of the attribute. Throws: IllegalStateException - if getState() != XMLEventListenerStates.START_TAG_OPEN. IllegalArgumentException - if name == null. IOException - if an I/O error occurs; this will set the state to XMLEventListenerStates.ERROR_STATE. attribute public final void attribute(String name, byte value) throws IllegalStateException, IllegalArgumentException, IOException Adds an attribute to the current element, with a byte value. There must currently be an open element. The attribute value is surrounded by the quotation mark character (see getQuotationMark()). Parameters: name - the name of the attribute, not null. value - the value of the attribute. Throws: IllegalStateException - if getState() != XMLEventListenerStates.START_TAG_OPEN. IllegalArgumentException - if name == null. IOException - if an I/O error occurs; this will set the state to XMLEventListenerStates.ERROR_STATE. attribute public final void attribute(String name, short value) throws IllegalStateException, IllegalArgumentException, IOException Adds an attribute to the current element, with a short value. There must currently be an open element. The attribute value is surrounded by the quotation mark character (see getQuotationMark()). Parameters: name - the name of the attribute, not null. value - the value of the attribute. Throws: IllegalStateException - if getState() != XMLEventListenerStates.START_TAG_OPEN. IllegalArgumentException - if name == null. IOException - if an I/O error occurs; this will set the state to XMLEventListenerStates.ERROR_STATE. attribute public final void attribute(String name, int value) throws IllegalStateException, IllegalArgumentException, IOException Adds an attribute to the current element, with an int value. There must currently be an open element. The attribute value is surrounded by the quotation mark character (see getQuotationMark()). Parameters: name - the name of the attribute, not null. value - the value of the attribute. Throws: IllegalStateException - if getState() != XMLEventListenerStates.START_TAG_OPEN. IllegalArgumentException - if name == null. IOException - if an I/O error occurs; this will set the state to XMLEventListenerStates.ERROR_STATE. attribute public final void attribute(String name, long value) throws IllegalStateException, IllegalArgumentException, IOException Adds an attribute to the current element, with a long value. There must currently be an open element. The attribute value is surrounded by the quotation mark character (see getQuotationMark()). Parameters: name - the name of the attribute, not null. value - the value of the attribute. Throws: IllegalStateException - if getState() != XMLEventListenerStates.START_TAG_OPEN. IllegalArgumentException - if name == null. IOException - if an I/O error occurs; this will set the state to XMLEventListenerStates.ERROR_STATE. attribute public final void attribute(String name, float value) throws IllegalStateException, IllegalArgumentException, IOException Adds an attribute to the current element, with a float value. There must currently be an open element. The attribute value is surrounded by the quotation mark character (see getQuotationMark()). Parameters: name - the name of the attribute, not null. value - the value of the attribute. Throws: IllegalStateException - if getState() != XMLEventListenerStates.START_TAG_OPEN. IllegalArgumentException - if name == null. IOException - if an I/O error occurs; this will set the state to XMLEventListenerStates.ERROR_STATE. attribute public final void attribute(String name, double value) throws IllegalStateException, IllegalArgumentException, IOException Adds an attribute to the current element, with a double value. There must currently be an open element. The attribute value is surrounded by the quotation mark character (see getQuotationMark()). Parameters: name - the name of the attribute, not null. value - the value of the attribute. Throws: IllegalStateException - if getState() != XMLEventListenerStates.START_TAG_OPEN. IllegalArgumentException - if name == null. IOException - if an I/O error occurs; this will set the state to XMLEventListenerStates.ERROR_STATE. attribute public final void attribute(String name, char c) throws IllegalStateException, IllegalArgumentException, IOException Adds an attribute to the current element, with a char value. There must currently be an open element. The attribute value is surrounded by the quotation mark character (see getQuotationMark()). Parameters: name - the name of the attribute, not null. c - the value of the attribute, a single character. Throws: IllegalStateException - if getState() != XMLEventListenerStates.START_TAG_OPEN. IllegalArgumentException - if name == null. IOException - if an I/O error occurs; this will set the state to XMLEventListenerStates.ERROR_STATE. endTag public final void endTag() throws IllegalStateException, IOException Writes the end tag for the element on top of the stack. Specified by: endTag in interface XMLEventListener Throws: IllegalStateException - if getState() != XMLEventListenerStates.START_TAG_OPEN && getState() != XMLEventListenerStates.WITHIN_ELEMENT IOException - if an I/O error occurs; this will set the state to XMLEventListenerStates.ERROR_STATE. endTag public final void endTag(String type) throws IllegalStateException, NoSuchElementException, IOException Writes end tags for elements on the stack until (and including) an element that matches the specified name. Parameters: type - the type of the tag to end, not null. Throws: IllegalStateException - if getState() != XMLEventListenerStates.START_TAG_OPEN && getState() != XMLEventListenerStates.WITHIN_ELEMENT IllegalArgumentException - if type == null. NoSuchElementException - if an element of the specified type could not be found on the stack. IOException - if an I/O error occurs; this will set the state to XMLEventListenerStates.ERROR_STATE. Since: xmlenc 0.53 emptyTag public final void emptyTag(String type) throws IllegalStateException, IllegalArgumentException, IOException Writes an empty tag. This is equivalent to calling: startTag(type); endTag(); Parameters: type - the type of the tag to start, not null. Throws: IllegalStateException - if getState() != XMLEventListenerStates.BEFORE_XML_DECLARATION && getState() != XMLEventListenerStates.BEFORE_DTD_DECLARATION && getState() != XMLEventListenerStates.BEFORE_ROOT_ELEMENT && getState() != XMLEventListenerStates.START_TAG_OPEN && getState() != XMLEventListenerStates.WITHIN_ELEMENT. IllegalArgumentException - if type == null. IOException - if an I/O error occurs; this will set the state to XMLEventListenerStates.ERROR_STATE. Since: xmlenc 0.53 pcdata public final void pcdata(String text) throws IllegalStateException, IllegalArgumentException, InvalidXMLException, IOException Writes the specified String as PCDATA. Specified by: pcdata in interface XMLEventListener Parameters: text - the PCDATA text to be written, not null. Throws: IllegalStateException - if getState() != XMLEventListenerStates.START_TAG_OPEN && getState() != XMLEventListenerStates.WITHIN_ELEMENT IllegalArgumentException - if text == null. InvalidXMLException - if the specified text contains an invalid character. IOException - if an I/O error occurs; this will set the state to XMLEventListenerStates.ERROR_STATE. pcdata public final void pcdata(char[] ch, int start, int length) throws IllegalStateException, IllegalArgumentException, IndexOutOfBoundsException, InvalidXMLException, IOException Writes the specified character array as PCDATA. Specified by: pcdata in interface XMLEventListener Parameters: ch - the character array containing the text to be written, not null. start - the start index in the array, must be >= 0 and it must be < ch.length. length - the number of characters to read from the array, must be > 0. Throws: IllegalStateException - if getState() != XMLEventListenerStates.START_TAG_OPEN && getState() != XMLEventListenerStates.WITHIN_ELEMENT IllegalArgumentException - if ch == null || start < 0 || start >= ch.length || length < 0. IndexOutOfBoundsException - if start + length > ch.length. InvalidXMLException - if the specified text contains an invalid character. IOException - if an I/O error occurs; this will set the state to XMLEventListenerStates.ERROR_STATE. whitespace public final void whitespace(String whitespace) throws IllegalStateException, IllegalArgumentException, InvalidXMLException, IOException Writes the specified ignorable whitespace. Ignorable whitespace may be written anywhere in XML output stream, except above the XML declaration. If the state equals XMLEventListenerStates.BEFORE_XML_DECLARATION, then it will be set to XMLEventListenerStates.BEFORE_DTD_DECLARATION, otherwise if the state is XMLEventListenerStates.START_TAG_OPEN then it will be set to XMLEventListenerStates.WITHIN_ELEMENT, otherwise the state will not be changed. Specified by: whitespace in interface XMLEventListener Parameters: whitespace - the ignorable whitespace to be written, not null. Throws: IllegalStateException - if getState() != XMLEventListenerStates.BEFORE_XML_DECLARATION && getState() != XMLEventListenerStates.BEFORE_DTD_DECLARATION && getState() != XMLEventListenerStates.BEFORE_ROOT_ELEMENT && getState() != XMLEventListenerStates.START_TAG_OPEN && getState() != XMLEventListenerStates.WITHIN_ELEMENT && getState() != XMLEventListenerStates.AFTER_ROOT_ELEMENT. IllegalArgumentException - if whitespace == null. InvalidXMLException - if the specified character string contains a character that is invalid as whitespace. IOException - if an I/O error occurs; this will set the state to XMLEventListenerStates.ERROR_STATE. whitespace public final void whitespace(char[] ch, int start, int length) throws IllegalStateException, IllegalArgumentException, IndexOutOfBoundsException, InvalidXMLException, IOException Writes text from the specified character array as ignorable whitespace. Ignorable whitespace may be written anywhere in XML output stream, except above the XML declaration. This method does not check if the string actually contains whitespace. If the state equals XMLEventListenerStates.BEFORE_XML_DECLARATION, then it will be set to XMLEventListenerStates.BEFORE_DTD_DECLARATION, otherwise if the state is XMLEventListenerStates.START_TAG_OPEN then it will be set to XMLEventListenerStates.WITHIN_ELEMENT, otherwise the state will not be changed. Specified by: whitespace in interface XMLEventListener Parameters: ch - the character array containing the text to be written, not null. start - the start index in the array, must be >= 0 and it must be < ch.length. length - the number of characters to read from the array, must be > 0. Throws: IllegalStateException - if getState() != XMLEventListenerStates.BEFORE_XML_DECLARATION && getState() != XMLEventListenerStates.BEFORE_DTD_DECLARATION && getState() != XMLEventListenerStates.BEFORE_ROOT_ELEMENT && getState() != XMLEventListenerStates.START_TAG_OPEN && getState() != XMLEventListenerStates.WITHIN_ELEMENT && getState() != XMLEventListenerStates.AFTER_ROOT_ELEMENT. IllegalArgumentException - if ch == null || start < 0 || start >= ch.length || length < 0. IndexOutOfBoundsException - if start + length > ch.length. InvalidXMLException - if the specified character string contains a character that is invalid as whitespace. IOException - if an I/O error occurs; this will set the state to XMLEventListenerStates.ERROR_STATE. comment public final void comment(String text) throws IllegalStateException, IllegalArgumentException, InvalidXMLException, IOException Writes the specified comment. The comment should not contain the string "--". If the state equals XMLEventListenerStates.BEFORE_XML_DECLARATION, then it will be set to XMLEventListenerStates.BEFORE_DTD_DECLARATION, otherwise if the state is XMLEventListenerStates.START_TAG_OPEN then it will be set to XMLEventListenerStates.WITHIN_ELEMENT, otherwise the state will not be changed. Specified by: comment in interface XMLEventListener Parameters: text - the text for the comment be written, not null. Throws: IllegalStateException - if getState() != XMLEventListenerStates.BEFORE_XML_DECLARATION && getState() != XMLEventListenerStates.BEFORE_DTD_DECLARATION && getState() != XMLEventListenerStates.BEFORE_ROOT_ELEMENT && getState() != XMLEventListenerStates.START_TAG_OPEN && getState() != XMLEventListenerStates.WITHIN_ELEMENT && getState() != XMLEventListenerStates.AFTER_ROOT_ELEMENT. IllegalArgumentException - if text == null. InvalidXMLException - if the specified text contains an invalid character. IOException - if an I/O error occurs; this will set the state to XMLEventListenerStates.ERROR_STATE. pi public final void pi(String target, String instruction) throws IllegalStateException, IllegalArgumentException, IOException Writes a processing instruction. A target and an optional instruction should be specified. A processing instruction can appear above and below the root element, and between elements. It cannot appear inside an element start or end tag, nor inside a comment. Processing instructions cannot be nested. If the state equals XMLEventListenerStates.BEFORE_XML_DECLARATION, then it will be set to XMLEventListenerStates.BEFORE_DTD_DECLARATION, otherwise the state will not be changed. Specified by: pi in interface XMLEventListener Parameters: target - an identification of the application at which the instruction is targeted, not null. instruction - the instruction, can be null, which is equivalent to an empty string. Throws: IllegalStateException - if getState() != XMLEventListenerStates.BEFORE_XML_DECLARATION && getState() != XMLEventListenerStates.BEFORE_DTD_DECLARATION && getState() != XMLEventListenerStates.BEFORE_ROOT_ELEMENT && getState() != XMLEventListenerStates.START_TAG_OPEN && getState() != XMLEventListenerStates.WITHIN_ELEMENT && getState() != XMLEventListenerStates.AFTER_ROOT_ELEMENT. IllegalArgumentException - if target == null. IOException - if an I/O error occurs; this will set the state to XMLEventListenerStates.ERROR_STATE. cdata public final void cdata(String text) throws IllegalStateException, IllegalArgumentException, IOException Writes a CDATA section. A CDATA section can contain any string, except "]]>". This will, however, not be checked by this method. Left angle brackets and ampersands will be output in their literal form; they need not (and cannot) be escaped using "<" and "&". If the specified string is empty (i.e. "".equals(text), then nothing will be output. If the specified string contains characters that cannot be printed in this encoding, then the result is undefined. Specified by: cdata in interface XMLEventListener Parameters: text - the contents of the CDATA section, not null. Throws: IllegalStateException - if getState() != XMLEventListenerStates.START_TAG_OPEN && getState() != XMLEventListenerStates.WITHIN_ELEMENT IllegalArgumentException - if text == null. IOException - if an I/O error occurs; this will set the state to XMLEventListenerStates.ERROR_STATE. close public final void close() throws IllegalStateException, IOException Closes all open elements. After calling this method, only the whitespace(String) method can be called. If you would like to flush the output stream as well, call endDocument() instead. Throws: IllegalStateException - if getState() != XMLEventListenerStates.START_TAG_OPEN && getState() != XMLEventListenerStates.WITHIN_ELEMENT && getState() != XMLEventListenerStates.AFTER_ROOT_ELEMENT IOException - if an I/O error occurs; this will set the state to XMLEventListenerStates.ERROR_STATE. endDocument public final void endDocument() throws IllegalStateException, IOException Finishes the XML output. All open elements will be closed and the underlying output stream will be flushed using getWriter().flush(). After calling this method, the state is changed to XMLEventListenerStates.DOCUMENT_ENDED, so that no more output can be written until this outputter is reset. Specified by: endDocument in interface XMLEventListener Throws: IllegalStateException - if getState() != XMLEventListenerStates.START_TAG_OPEN && getState() != XMLEventListenerStates.WITHIN_ELEMENT && getState() != XMLEventListenerStates.AFTER_ROOT_ELEMENT. IOException - if an I/O error occurs; this will set the state to XMLEventListenerStates.ERROR_STATE.

Class XMLOutputter

Standards compliance

Supported encodings

Multi-threading

Exceptions

Performance hints

Field Summary

Fields inherited from interface org.znerd.xmlenc.XMLEventListenerStates

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

DEFAULT_INDENTATION

Constructor Detail

XMLOutputter

XMLOutputter

XMLOutputter

Method Detail

getWriter

getEncoding

reset

reset

reset

setState

getState

isEscaping

setEscaping

getElementStack

getElementStackSize

getElementStackCapacity

setElementStackCapacity

setQuotationMark

getQuotationMark

setLineBreak

getLineBreak

setIndentation

getIndentation

declaration

dtd

startTag

attribute

attribute

attribute

attribute

attribute

attribute

attribute

attribute

attribute

endTag

endTag

emptyTag

pcdata

pcdata

whitespace

whitespace

comment

pi

cdata

close

endDocument