org.jdom2.output.support

类 AbstractXMLOutputProcessor

java.lang.Object

org.jdom2.output.support.AbstractOutputProcessor

org.jdom2.output.support.AbstractXMLOutputProcessor

所有已实现的接口:

XMLOutputProcessor

public abstract class AbstractXMLOutputProcessor
extends AbstractOutputProcessor
implements XMLOutputProcessor

This class provides a concrete implementation of XMLOutputProcessor for supporting the XMLOutputter.

Overview

This class is marked abstract even though all methods are fully implemented. The process*(...) methods are public because they match the XMLOutputProcessor interface but the remaining methods are all protected. People who want to create a custom XMLOutputProcessor for XMLOutputter are able to extend this class and modify any functionality they want. Before sub-classing this you should first check to see if the Format class can get you the results you want. Subclasses of this should have reentrant methods. This is easiest to accomplish simply by not allowing any instance fields. If your sub-class has an instance field/variable, then it's probably broken.

The Stacks

One significant feature of this implementation is that it creates and maintains both a NamespaceStack and FormatStack that are managed in the printElement(Writer, FormatStack, NamespaceStack, Element) method. The stacks are pushed and popped in that method only. They significantly improve the performance and readability of the code. The NamespaceStack is only sent through to the printElement(Writer, FormatStack, NamespaceStack, Element) and printContent(Writer, FormatStack, NamespaceStack, Walker) methods, but the FormatStack is pushed through to all print* Methods.

Text Processing

In XML the concept of 'Text' can be loosely defined as anything that can be found between an Element's start and end tags, excluding Comments and Processing Instructions. When considered from a JDOM perspective, this means Text, CDATA and EntityRef content. This will be referred to as 'Text-like content'

XMLOutputter delegates the management and formatting of Content to a Walker instance. See Walker and its various implementations for details on how the Element content is processed.

Because the Walker interface specifies that Text/CDATA content may be returned as either Text/CDATA instances or as formatted String values this class sometimes uses printCDATA(...) and printText(...), and sometimes uses the more direct textCDATA(Writer, String) or textRaw(Writer, String) as appropriate. In other words, subclasses should probably override these second methods instead of the print methods.

Non-Text Content

Non-text content is processed via the respective print* methods. The usage should be logical based on the method name. The general observations are:

• printElement - maintains the Stacks, prints the element open tags, with attributes and namespaces. It checks to see whether the Element is text-only, or has non-text content. If it is text-only there is no indent/newline handling and it delegates to the correct text-type print method, otherwise it delegates to printContent.
• printContent is called to output all lists of Content. It assumes that all whitespace indentation/newlines are appropriate before it is called, but it will ensure that padding is appropriate between the items in the list.

Final Notes

No methods actually write to the destination Writer except the write(...) methods. Thus, all other methods do their respective processing and delegate the actual destination output to the write(Writer, char) or write(Writer, String) methods. All Text-like content (printCDATA, printText, and printEntityRef) will ultimately be output through the the text* methods (and no other content).

从以下版本开始:

JDOM2

作者:

Rolf Lear

另请参阅:

XMLOutputter, XMLOutputProcessor

构造器概要

构造器

构造器和说明
AbstractXMLOutputProcessor()

方法概要

限定符和类型	方法和说明
void	process(java.io.Writer out, Format format, CDATA cdata) Print out a CDATA node.
void	process(java.io.Writer out, Format format, Comment comment) Print out a Comment.
void	process(java.io.Writer out, Format format, DocType doctype) Print out the DocType.
void	process(java.io.Writer out, Format format, Document doc) This will print the Document to the given Writer.
void	process(java.io.Writer out, Format format, Element element) Print out an Element, including its Attributes, and all contained (child) elements, etc.
void	process(java.io.Writer out, Format format, EntityRef entity) Print out a EntityRef.
void	process(java.io.Writer out, Format format, java.util.List<? extends Content> list) This will handle printing out a list of nodes.
void	process(java.io.Writer out, Format format, ProcessingInstruction pi) Print out a ProcessingInstruction.
void	process(java.io.Writer out, Format format, Text text) Print out a Text node.

从类继承的方法 java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

构造器详细资料

AbstractXMLOutputProcessor

public AbstractXMLOutputProcessor()

方法详细资料

process

public void process(java.io.Writer out,
                    Format format,
                    Document doc)
             throws java.io.IOException

从接口复制的说明: XMLOutputProcessor

This will print the Document to the given Writer.

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.

指定者:

process 在接口中 XMLOutputProcessor

参数:

out - Writer to use.

format - Format instance specifying output style

doc - Document to format.

抛出:

java.io.IOException - if there's any problem writing.

process

public void process(java.io.Writer out,
                    Format format,
                    DocType doctype)
             throws java.io.IOException

从接口复制的说明: XMLOutputProcessor

Print out the DocType.

指定者:

process 在接口中 XMLOutputProcessor

参数:

out - Writer to use.

format - Format instance specifying output style

doctype - DocType to output.

抛出:

java.io.IOException - if there's any problem writing.

process

public void process(java.io.Writer out,
                    Format format,
                    Element element)
             throws java.io.IOException

从接口复制的说明: XMLOutputProcessor

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

指定者:

process 在接口中 XMLOutputProcessor

参数:

out - Writer to use.

format - Format instance specifying output style

element - Element to output.

抛出:

java.io.IOException - if there's any problem writing.

process

public void process(java.io.Writer out,
                    Format format,
                    java.util.List<? extends Content> list)
             throws java.io.IOException

从接口复制的说明: XMLOutputProcessor

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>".

指定者:

process 在接口中 XMLOutputProcessor

参数:

out - Writer to use.

format - Format instance specifying output style

list - List of nodes.

抛出:

java.io.IOException - if there's any problem writing.

process

public void process(java.io.Writer out,
                    Format format,
                    CDATA cdata)
             throws java.io.IOException

从接口复制的说明: XMLOutputProcessor

Print out a CDATA node.

指定者:

process 在接口中 XMLOutputProcessor

参数:

out - Writer to use.

format - Format instance specifying output style

cdata - CDATA to output.

抛出:

java.io.IOException - if there's any problem writing.

process

public void process(java.io.Writer out,
                    Format format,
                    Text text)
             throws java.io.IOException

从接口复制的说明: XMLOutputProcessor

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

指定者:

process 在接口中 XMLOutputProcessor

参数:

out - Writer to use.

format - Format instance specifying output style

text - Text to output.

抛出:

java.io.IOException - if there's any problem writing.

process

public void process(java.io.Writer out,
                    Format format,
                    Comment comment)
             throws java.io.IOException

从接口复制的说明: XMLOutputProcessor

Print out a Comment.

指定者:

process 在接口中 XMLOutputProcessor

参数:

out - Writer to use.

format - Format instance specifying output style

comment - Comment to output.

抛出:

java.io.IOException - if there's any problem writing.

process

public void process(java.io.Writer out,
                    Format format,
                    ProcessingInstruction pi)
             throws java.io.IOException

从接口复制的说明: XMLOutputProcessor

Print out a ProcessingInstruction.

指定者:

process 在接口中 XMLOutputProcessor

参数:

out - Writer to use.

format - Format instance specifying output style

pi - ProcessingInstruction to output.

抛出:

java.io.IOException - if there's any problem writing.

process

public void process(java.io.Writer out,
                    Format format,
                    EntityRef entity)
             throws java.io.IOException

从接口复制的说明: XMLOutputProcessor

Print out a EntityRef.

指定者:

process 在接口中 XMLOutputProcessor

参数:

out - Writer to use.

format - Format instance specifying output style

entity - EntityRef to output.

抛出:

java.io.IOException - if there's any problem writing.