Package org.jdom2.output.support
Interface StAXStreamProcessor
-
- All Known Implementing Classes:
AbstractStAXStreamProcessor
public interface StAXStreamProcessor
This interface provides a base support for theXMLOutputter
.People who want to create a custom XMLOutputProcessor for XMLOutputter are able to implement this interface with the following notes and restrictions:
- The XMLOutputter will call one, and only one of the
process(XMLStreamWriter,Format,*)
methods each time the XMLOutputter is requested to output some JDOM content. It is thus safe to assume that aprocess(XMLStreamWriter,Format,*)
method can set up any infrastructure needed to process the content, and that the XMLOutputter will not re-call that method, or some otherprocess(XMLStreamWriter,Format,*)
method for the same output sequence. - The process methods should be thread-safe and reentrant: The same
process(XMLStreamWriter,Format,*)
method may (will) be called concurrently from different threads.
The
AbstractXMLOutputProcessor
class is a full implementation of this interface and is fully customisable. People who want a custom XMLOutputter are encouraged to extend the AbstractXMLOutputProcessor rather than do a full re-implementation of this interface.- Since:
- JDOM2
- Author:
- Rolf Lear
- See Also:
XMLOutputter
,AbstractXMLOutputProcessor
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description void
process(javax.xml.stream.XMLStreamWriter out, Format format, java.util.List<? extends Content> list)
This will handle printing out a list of nodes.void
process(javax.xml.stream.XMLStreamWriter out, Format format, CDATA cdata)
Print out a
node.CDATA
void
process(javax.xml.stream.XMLStreamWriter out, Format format, Comment comment)
Print out a
.Comment
void
process(javax.xml.stream.XMLStreamWriter out, Format format, DocType doctype)
Print out the
.DocType
void
process(javax.xml.stream.XMLStreamWriter out, Format format, Document doc)
This will print the
to the given XMLStreamWriter.Document
void
process(javax.xml.stream.XMLStreamWriter out, Format format, Element element)
void
process(javax.xml.stream.XMLStreamWriter out, Format format, EntityRef entity)
Print out a
.EntityRef
void
process(javax.xml.stream.XMLStreamWriter out, Format format, ProcessingInstruction pi)
Print out a
.ProcessingInstruction
void
process(javax.xml.stream.XMLStreamWriter out, Format format, Text text)
Print out a
node.Text
-
-
-
Method Detail
-
process
void process(javax.xml.stream.XMLStreamWriter out, Format format, Document doc) throws javax.xml.stream.XMLStreamException
This will print the
to the given XMLStreamWriter.Document
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
to use.format
-Format
instance specifying output styledoc
-Document
to format.- Throws:
javax.xml.stream.XMLStreamException
- if there's any problem writing.java.lang.NullPointerException
- if the input content is null
-
process
void process(javax.xml.stream.XMLStreamWriter out, Format format, DocType doctype) throws javax.xml.stream.XMLStreamException
Print out the
.DocType
- Parameters:
out
-XMLStreamWriter
to use.format
-Format
instance specifying output styledoctype
-DocType
to output.- Throws:
javax.xml.stream.XMLStreamException
- if there's any problem writing.java.lang.NullPointerException
- if the input content is null
-
process
void process(javax.xml.stream.XMLStreamWriter out, Format format, Element element) throws javax.xml.stream.XMLStreamException
- Parameters:
out
-XMLStreamWriter
to use.format
-Format
instance specifying output styleelement
-Element
to output.- Throws:
javax.xml.stream.XMLStreamException
- if there's any problem writing.java.lang.NullPointerException
- if the input content is null
-
process
void process(javax.xml.stream.XMLStreamWriter out, Format format, java.util.List<? extends Content> list) throws javax.xml.stream.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
to use.format
-Format
instance specifying output stylelist
-List
of nodes.- Throws:
javax.xml.stream.XMLStreamException
- if there's any problem writing.java.lang.NullPointerException
- if the input list is null or contains null membersjava.lang.ClassCastException
- if any of the list members are notContent
-
process
void process(javax.xml.stream.XMLStreamWriter out, Format format, CDATA cdata) throws javax.xml.stream.XMLStreamException
Print out a
node.CDATA
- Parameters:
out
-XMLStreamWriter
to use.format
-Format
instance specifying output stylecdata
-CDATA
to output.- Throws:
javax.xml.stream.XMLStreamException
- if there's any problem writing.java.lang.NullPointerException
- if the input content is null
-
process
void process(javax.xml.stream.XMLStreamWriter out, Format format, Text text) throws javax.xml.stream.XMLStreamException
Print out a
node. Perfoms the necessary entity escaping and whitespace stripping.Text
- Parameters:
out
-XMLStreamWriter
to use.format
-Format
instance specifying output styletext
-Text
to output.- Throws:
javax.xml.stream.XMLStreamException
- if there's any problem writing.java.lang.NullPointerException
- if the input content is null
-
process
void process(javax.xml.stream.XMLStreamWriter out, Format format, Comment comment) throws javax.xml.stream.XMLStreamException
Print out a
.Comment
- Parameters:
out
-XMLStreamWriter
to use.format
-Format
instance specifying output stylecomment
-Comment
to output.- Throws:
javax.xml.stream.XMLStreamException
- if there's any problem writing.java.lang.NullPointerException
- if the input content is null
-
process
void process(javax.xml.stream.XMLStreamWriter out, Format format, ProcessingInstruction pi) throws javax.xml.stream.XMLStreamException
Print out a
.ProcessingInstruction
- Parameters:
out
-XMLStreamWriter
to use.format
-Format
instance specifying output stylepi
-ProcessingInstruction
to output.- Throws:
javax.xml.stream.XMLStreamException
- if there's any problem writing.java.lang.NullPointerException
- if the input content is null
-
process
void process(javax.xml.stream.XMLStreamWriter out, Format format, EntityRef entity) throws javax.xml.stream.XMLStreamException
Print out a
.EntityRef
- Parameters:
out
-XMLStreamWriter
to use.format
-Format
instance specifying output styleentity
-EntityRef
to output.- Throws:
javax.xml.stream.XMLStreamException
- if there's any problem writing.java.lang.NullPointerException
- if the input content is null
-
-