Top Description Methods
org.jdom2.output.support

public Interface StAXStreamProcessor

Known Direct Implementers
org.jdom2.output.support.AbstractStAXStreamProcessor
Imports
java.util.List, javax.xml.stream.XMLStreamException, .XMLStreamWriter, org.jdom2.Attribute, .CDATA, .Comment, .Content, .DocType, .Document, .Element, .EntityRef, .ProcessingInstruction, .Text, org.jdom2.output.Format, .StAXStreamOutputter
This interface provides a base support for the StAXStreamOutputter.

People who want to create a custom StAXStreamProcessor for StAXStreamOutputter are able to implement this interface.

The AbstractStAXStreamProcessor class is a full implementation of this interface and is fully customisable. People who want a custom StAXStreamOutputter are encouraged to extend the AbstractStAXStreamProcessor rather than do a full re-implementation of this interface.

Author
Rolf Lear
Since
JDOM2
See Also
StAXStreamOutputter, AbstractStAXStreamProcessor

Method Summary

Modifier and TypeMethod and Description
public void
process(XMLStreamWriter
XMLStreamWriter to use.
out, Format
Format instance specifying output style
format, Document
Document to format.
doc)

This will print the Document to the given XMLStreamWriter.

public void
process(XMLStreamWriter
XMLStreamWriter to use.
out, Format
Format instance specifying output style
format, DocType
DocType to output.
doctype)

Print out the DocType.

public void
process(XMLStreamWriter
XMLStreamWriter to use.
out, Format
Format instance specifying output style
format, Element
Element to output.
element)

Print out an Element, including its Attributes, and all contained (child) elements, etc.

public void
process(XMLStreamWriter
XMLStreamWriter to use.
out, Format
Format instance specifying output style
format, List<? extends Content>
List of nodes.
list)

This will handle printing out a list of nodes.

public void
process(XMLStreamWriter
XMLStreamWriter to use.
out, Format
Format instance specifying output style
format, CDATA
CDATA to output.
cdata)

Print out a CDATA node.

public void
process(XMLStreamWriter
XMLStreamWriter to use.
out, Format
Format instance specifying output style
format, Text
Text to output.
text)

Print out a Text node.

public void
process(XMLStreamWriter
XMLStreamWriter to use.
out, Format
Format instance specifying output style
format, Comment
Comment to output.
comment)

Print out a Comment.

public void
process(XMLStreamWriter
XMLStreamWriter to use.
out, Format
Format instance specifying output style
format, ProcessingInstruction
ProcessingInstruction to output.
pi)

Print out a ProcessingInstruction.

public void
process(XMLStreamWriter
XMLStreamWriter to use.
out, Format
Format instance specifying output style
format, EntityRef
EntityRef to output.
entity)

Print out a EntityRef.

Method Detail

processback to summary
public void process(XMLStreamWriter out, Format format, Document doc) throws XMLStreamException

This will print the Document to the given XMLStreamWriter.

Warning

using your own XMLStreamWriter may cause the outputter's preferred character encoding to be ignored. If you use encodings other than UTF-8, we recommend using the method that takes an OutputStream instead.

Parameters
out:XMLStreamWriter

XMLStreamWriter to use.

format:Format

Format instance specifying output style

doc:Document

Document to format.

Exceptions
XMLStreamException:
if there's any problem writing.
NullPointerException:
if the input content is null
processback to summary
public void process(XMLStreamWriter out, Format format, DocType doctype) throws XMLStreamException

Print out the DocType.

Parameters
out:XMLStreamWriter

XMLStreamWriter to use.

format:Format

Format instance specifying output style

doctype:DocType

DocType to output.

Exceptions
XMLStreamException:
if there's any problem writing.
NullPointerException:
if the input content is null
processback to summary
public void process(XMLStreamWriter out, Format format, Element element) throws XMLStreamException

Print out an Element, including its Attributes, and all contained (child) elements, etc.

Parameters
out:XMLStreamWriter

XMLStreamWriter to use.

format:Format

Format instance specifying output style

element:Element

Element to output.

Exceptions
XMLStreamException:
if there's any problem writing.
NullPointerException:
if the input content is null
processback to summary
public void process(XMLStreamWriter out, Format format, List<? extends Content> list) throws XMLStreamException

This will handle printing out a list of nodes. This can be useful for printing the content of an element that contains HTML, like "<description>JDOM is <b>fun>!</description>".

Parameters
out:XMLStreamWriter

XMLStreamWriter to use.

format:Format

Format instance specifying output style

list:List<? extends Content>

List of nodes.

Exceptions
XMLStreamException:
if there's any problem writing.
NullPointerException:
if the input list is null or contains null members
ClassCastException:
if any of the list members are not Content
processback to summary
public void process(XMLStreamWriter out, Format format, CDATA cdata) throws XMLStreamException

Print out a CDATA node.

Parameters
out:XMLStreamWriter

XMLStreamWriter to use.

format:Format

Format instance specifying output style

cdata:CDATA

CDATA to output.

Exceptions
XMLStreamException:
if there's any problem writing.
NullPointerException:
if the input content is null
processback to summary
public void process(XMLStreamWriter out, Format format, Text text) throws XMLStreamException

Print out a Text node. Performs the necessary entity escaping and whitespace stripping.

Parameters
out:XMLStreamWriter

XMLStreamWriter to use.

format:Format

Format instance specifying output style

text:Text

Text to output.

Exceptions
XMLStreamException:
if there's any problem writing.
NullPointerException:
if the input content is null
processback to summary
public void process(XMLStreamWriter out, Format format, Comment comment) throws XMLStreamException

Print out a Comment.

Parameters
out:XMLStreamWriter

XMLStreamWriter to use.

format:Format

Format instance specifying output style

comment:Comment

Comment to output.

Exceptions
XMLStreamException:
if there's any problem writing.
NullPointerException:
if the input content is null
processback to summary
public void process(XMLStreamWriter out, Format format, ProcessingInstruction pi) throws XMLStreamException

Print out a ProcessingInstruction.

Parameters
out:XMLStreamWriter

XMLStreamWriter to use.

format:Format

Format instance specifying output style

pi:ProcessingInstruction

ProcessingInstruction to output.

Exceptions
XMLStreamException:
if there's any problem writing.
NullPointerException:
if the input content is null
processback to summary
public void process(XMLStreamWriter out, Format format, EntityRef entity) throws XMLStreamException

Print out a EntityRef.

Parameters
out:XMLStreamWriter

XMLStreamWriter to use.

format:Format

Format instance specifying output style

entity:EntityRef

EntityRef to output.

Exceptions
XMLStreamException:
if there's any problem writing.
NullPointerException:
if the input content is null