Package org.jdom2.output.support
Interface SAXOutputProcessor
-
- All Known Implementing Classes:
AbstractSAXOutputProcessor
public interface SAXOutputProcessor
This interface provides a base support for theSAXOutputter
.People who want to create a custom SAXOutputProcessor for SAXOutputter are able to implement this interface with the following notes and restrictions:
- The SAXOutputter will call one, and only one of the
process(SAXTarget,Format,*)
methods each time the SAXOutputter is requested to output some JDOM content. It is thus safe to assume that aprocess(SAXTarget,Format,*)
method can set up any infrastructure needed to process the content, and that the SAXOutputter will not re-call that method, or some otherprocess(SAXTarget,Format,*)
method for the same output sequence. - The process methods should be thread-safe and reentrant: The same
process(SAXTarget,Format,*)
method may (will) be called concurrently from different threads.
The
AbstractSAXOutputProcessor
class is a full implementation of this interface and is fully customisable. People who want a custom SAXOutputter are encouraged to extend the AbstractSAXOutputProcessor rather than do a full re-implementation of this interface.- Since:
- JDOM2
- Author:
- Rolf Lear
- See Also:
SAXOutputter
,AbstractSAXOutputProcessor
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description void
process(SAXTarget out, Format format, java.util.List<? extends Content> list)
This will handle printing out a list of nodes.void
process(SAXTarget out, Format format, CDATA cdata)
Print out a
node.CDATA
void
process(SAXTarget out, Format format, Comment comment)
Print out a
.Comment
void
process(SAXTarget out, Format format, DocType doctype)
Print out the
.DocType
void
process(SAXTarget out, Format format, Document doc)
This will print the
to the given SAXTarget.Document
void
process(SAXTarget out, Format format, Element element)
void
process(SAXTarget out, Format format, EntityRef entity)
Print out a
.EntityRef
void
process(SAXTarget out, Format format, ProcessingInstruction pi)
Print out a
.ProcessingInstruction
void
process(SAXTarget out, Format format, Text text)
Print out a
node.Text
void
processAsDocument(SAXTarget out, Format format, java.util.List<? extends Content> list)
This will handle printing out a list of nodes thats encapsulated in start/end Document SAX events.void
processAsDocument(SAXTarget out, Format format, Element element)
-
-
-
Method Detail
-
process
void process(SAXTarget out, Format format, Document doc) throws JDOMException
This will print the
to the given SAXTarget.Document
Warning: using your own SAXTarget 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
-SAXTarget
to use.format
-Format
instance specifying output styledoc
-Document
to format.- Throws:
JDOMException
- if there is an issue encountered during output.java.lang.NullPointerException
- if the input content is null
-
process
void process(SAXTarget out, Format format, DocType doctype) throws JDOMException
Print out the
.DocType
- Parameters:
out
-SAXTarget
to use.format
-Format
instance specifying output styledoctype
-DocType
to output.- Throws:
JDOMException
- if there is an issue encountered during output.java.lang.NullPointerException
- if the input content is null
-
process
void process(SAXTarget out, Format format, Element element) throws JDOMException
- Parameters:
out
-SAXTarget
to use.format
-Format
instance specifying output styleelement
-Element
to output.- Throws:
JDOMException
- if there is an issue encountered during output.java.lang.NullPointerException
- if the input content is null
-
processAsDocument
void processAsDocument(SAXTarget out, Format format, Element element) throws JDOMException
Print out an
encapsulated in start/end Document SAX events, including itsElement
s, and all contained (child) elements, etc.Attribute
- Parameters:
out
-SAXTarget
to use.format
-Format
instance specifying output styleelement
-Element
to output.- Throws:
JDOMException
- if there is an issue encountered during output.java.lang.NullPointerException
- if the input content is null
-
process
void process(SAXTarget out, Format format, java.util.List<? extends Content> list) throws JDOMException
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
-SAXTarget
to use.format
-Format
instance specifying output stylelist
-List
of nodes.- Throws:
JDOMException
- if there is an issue encountered during output.java.lang.NullPointerException
- if the input list is null or contains null membersjava.lang.ClassCastException
- if any of the list members are notContent
-
processAsDocument
void processAsDocument(SAXTarget out, Format format, java.util.List<? extends Content> list) throws JDOMException
This will handle printing out a list of nodes thats encapsulated in start/end Document SAX events. This can be useful for printing the content of an element that contains HTML, like "<description>JDOM is <b>fun>!</description>".- Parameters:
out
-SAXTarget
to use.format
-Format
instance specifying output stylelist
-List
of nodes.- Throws:
JDOMException
- if there is an issue encountered during output.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(SAXTarget out, Format format, CDATA cdata) throws JDOMException
Print out a
node.CDATA
- Parameters:
out
-SAXTarget
to use.format
-Format
instance specifying output stylecdata
-CDATA
to output.- Throws:
JDOMException
- if there is an issue encountered during output.java.lang.NullPointerException
- if the input content is null
-
process
void process(SAXTarget out, Format format, Text text) throws JDOMException
Print out a
node. Perfoms the necessary entity escaping and whitespace stripping.Text
- Parameters:
out
-SAXTarget
to use.format
-Format
instance specifying output styletext
-Text
to output.- Throws:
JDOMException
- if there is an issue encountered during output.java.lang.NullPointerException
- if the input content is null
-
process
void process(SAXTarget out, Format format, Comment comment) throws JDOMException
Print out a
.Comment
- Parameters:
out
-SAXTarget
to use.format
-Format
instance specifying output stylecomment
-Comment
to output.- Throws:
JDOMException
- if there is an issue encountered during output.java.lang.NullPointerException
- if the input content is null
-
process
void process(SAXTarget out, Format format, ProcessingInstruction pi) throws JDOMException
Print out a
.ProcessingInstruction
- Parameters:
out
-SAXTarget
to use.format
-Format
instance specifying output stylepi
-ProcessingInstruction
to output.- Throws:
JDOMException
- if there is an issue encountered during output.java.lang.NullPointerException
- if the input content is null
-
process
void process(SAXTarget out, Format format, EntityRef entity) throws JDOMException
Print out a
.EntityRef
- Parameters:
out
-SAXTarget
to use.format
-Format
instance specifying output styleentity
-EntityRef
to output.- Throws:
JDOMException
- if there is an issue encountered during output.java.lang.NullPointerException
- if the input content is null
-
-