Package org.jdom2.output.support
Interface StAXEventProcessor
- All Known Implementing Classes:
AbstractStAXEventProcessor
public interface StAXEventProcessor
This interface provides a base support for the
XMLOutputter
.
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(XMLEventConsumer,Format,*)
methods each time the XMLOutputter is requested to output some JDOM content. It is thus safe to assume that aprocess(XMLEventConsumer,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(XMLEventConsumer,Format,*)
method for the same output sequence. - The process methods should be thread-safe and reentrant: The same
process(XMLEventConsumer,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:
-
Method Summary
Modifier and TypeMethodDescriptionvoid
process
(XMLEventConsumer out, Format format, XMLEventFactory eventfactory, List<? extends Content> list) This will handle printing out a list of nodes.void
process
(XMLEventConsumer out, Format format, XMLEventFactory eventfactpry, CDATA cdata) Print out a
node.CDATA
void
process
(XMLEventConsumer out, Format format, XMLEventFactory eventfactory, Comment comment) Print out a
.Comment
void
process
(XMLEventConsumer out, Format format, XMLEventFactory eventfactory, DocType doctype) Print out the
.DocType
void
process
(XMLEventConsumer out, Format format, XMLEventFactory eventfactory, Document doc) This will print the
to the given XMLEventConsumer.Document
void
process
(XMLEventConsumer out, Format format, XMLEventFactory eventfactory, Element element) void
process
(XMLEventConsumer out, Format format, XMLEventFactory eventfactory, EntityRef entity) Print out a
.EntityRef
void
process
(XMLEventConsumer out, Format format, XMLEventFactory eventfactory, ProcessingInstruction pi) Print out a
.ProcessingInstruction
void
process
(XMLEventConsumer out, Format format, XMLEventFactory eventfactory, Text text) Print out a
node.Text
-
Method Details
-
process
void process(XMLEventConsumer out, Format format, XMLEventFactory eventfactory, Document doc) throws XMLStreamException This will print the
to the given XMLEventConsumer.Document
Warning: using your own XMLEventConsumer 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
-XMLEventConsumer
to use.format
-Format
instance specifying output styleeventfactory
-XMLEventFactory
for creating XMLEvent instances.doc
-Document
to format.- Throws:
XMLStreamException
- if there's any problem writing.NullPointerException
- if the input content is null
-
process
void process(XMLEventConsumer out, Format format, XMLEventFactory eventfactory, DocType doctype) throws XMLStreamException Print out the
.DocType
- Parameters:
out
-XMLEventConsumer
to use.format
-Format
instance specifying output styleeventfactory
-XMLEventFactory
for creating XMLEvent instances.doctype
-DocType
to output.- Throws:
XMLStreamException
- if there's any problem writing.NullPointerException
- if the input content is null
-
process
void process(XMLEventConsumer out, Format format, XMLEventFactory eventfactory, Element element) throws XMLStreamException - Parameters:
out
-XMLEventConsumer
to use.format
-Format
instance specifying output styleeventfactory
-XMLEventFactory
for creating XMLEvent instances.element
-Element
to output.- Throws:
XMLStreamException
- if there's any problem writing.NullPointerException
- if the input content is null
-
process
void process(XMLEventConsumer out, Format format, XMLEventFactory eventfactory, 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
-XMLEventConsumer
to use.format
-Format
instance specifying output styleeventfactory
-XMLEventFactory
for creating XMLEvent instances.list
-List
of nodes.- Throws:
XMLStreamException
- if there's any problem writing.NullPointerException
- if the input list is null or contains null membersClassCastException
- if any of the list members are notContent
-
process
void process(XMLEventConsumer out, Format format, XMLEventFactory eventfactpry, CDATA cdata) throws XMLStreamException Print out a
node.CDATA
- Parameters:
out
-XMLEventConsumer
to use.format
-Format
instance specifying output styleeventfactpry
-XMLEventFactory
for creating XMLEvent instances.cdata
-CDATA
to output.- Throws:
XMLStreamException
- if there's any problem writing.NullPointerException
- if the input content is null
-
process
void process(XMLEventConsumer out, Format format, XMLEventFactory eventfactory, Text text) throws XMLStreamException Print out a
node. Performs the necessary entity escaping and whitespace stripping.Text
- Parameters:
out
-XMLEventConsumer
to use.format
-Format
instance specifying output styleeventfactory
-XMLEventFactory
for creating XMLEvent instances.text
-Text
to output.- Throws:
XMLStreamException
- if there's any problem writing.NullPointerException
- if the input content is null
-
process
void process(XMLEventConsumer out, Format format, XMLEventFactory eventfactory, Comment comment) throws XMLStreamException Print out a
.Comment
- Parameters:
out
-XMLEventConsumer
to use.format
-Format
instance specifying output styleeventfactory
-XMLEventFactory
for creating XMLEvent instances.comment
-Comment
to output.- Throws:
XMLStreamException
- if there's any problem writing.NullPointerException
- if the input content is null
-
process
void process(XMLEventConsumer out, Format format, XMLEventFactory eventfactory, ProcessingInstruction pi) throws XMLStreamException Print out a
.ProcessingInstruction
- Parameters:
out
-XMLEventConsumer
to use.format
-Format
instance specifying output styleeventfactory
-XMLEventFactory
for creating XMLEvent instances.pi
-ProcessingInstruction
to output.- Throws:
XMLStreamException
- if there's any problem writing.NullPointerException
- if the input content is null
-
process
void process(XMLEventConsumer out, Format format, XMLEventFactory eventfactory, EntityRef entity) throws XMLStreamException Print out a
.EntityRef
- Parameters:
out
-XMLEventConsumer
to use.format
-Format
instance specifying output styleeventfactory
-XMLEventFactory
for creating XMLEvent instances.entity
-EntityRef
to output.- Throws:
XMLStreamException
- if there's any problem writing.NullPointerException
- if the input content is null
-