Package org.jdom2.output.support
Interface XMLOutputProcessor
- All Known Implementing Classes:
AbstractXMLOutputProcessor
public interface XMLOutputProcessor
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(Writer,Format,*)
methods each time the XMLOutputter is requested to output some JDOM content. It is thus safe to assume that aprocess(Writer,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(Writer,Format,*)
method for the same output sequence. - The process methods should be thread-safe and reentrant: The same
process(Writer,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
This will handle printing out a list of nodes.void
Print out a
node.CDATA
void
Print out a
.Comment
void
Print out the
.DocType
void
This will print the
to the given Writer.Document
void
void
Print out a
.EntityRef
void
process
(Writer out, Format format, ProcessingInstruction pi) Print out a
.ProcessingInstruction
void
Print out a
node.Text
-
Method Details
-
process
This will print the
to the given Writer.Document
Warning: using your own Writer 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
-Writer
to use.format
-Format
instance specifying output styledoc
-Document
to format.- Throws:
IOException
- if there's any problem writing.NullPointerException
- if the input content is null
-
process
Print out the
.DocType
- Parameters:
out
-Writer
to use.format
-Format
instance specifying output styledoctype
-DocType
to output.- Throws:
IOException
- if there's any problem writing.NullPointerException
- if the input content is null
-
process
- Parameters:
out
-Writer
to use.format
-Format
instance specifying output styleelement
-Element
to output.- Throws:
IOException
- if there's any problem writing.NullPointerException
- if the input content is null
-
process
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
-Writer
to use.format
-Format
instance specifying output stylelist
-List
of nodes.- Throws:
IOException
- 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
Print out a
node.CDATA
- Parameters:
out
-Writer
to use.format
-Format
instance specifying output stylecdata
-CDATA
to output.- Throws:
IOException
- if there's any problem writing.NullPointerException
- if the input content is null
-
process
Print out a
node. Performs the necessary entity escaping and whitespace stripping.Text
- Parameters:
out
-Writer
to use.format
-Format
instance specifying output styletext
-Text
to output.- Throws:
IOException
- if there's any problem writing.NullPointerException
- if the input content is null
-
process
Print out a
.Comment
- Parameters:
out
-Writer
to use.format
-Format
instance specifying output stylecomment
-Comment
to output.- Throws:
IOException
- if there's any problem writing.NullPointerException
- if the input content is null
-
process
Print out a
.ProcessingInstruction
- Parameters:
out
-Writer
to use.format
-Format
instance specifying output stylepi
-ProcessingInstruction
to output.- Throws:
IOException
- if there's any problem writing.NullPointerException
- if the input content is null
-
process
Print out a
.EntityRef
- Parameters:
out
-Writer
to use.format
-Format
instance specifying output styleentity
-EntityRef
to output.- Throws:
IOException
- if there's any problem writing.NullPointerException
- if the input content is null
-