org.jdom2.output.support

类 AbstractStAXStreamProcessor

java.lang.Object

org.jdom2.output.support.AbstractOutputProcessor

org.jdom2.output.support.AbstractStAXStreamProcessor

所有已实现的接口:

StAXStreamProcessor

public abstract class AbstractStAXStreamProcessor
extends AbstractOutputProcessor
implements StAXStreamProcessor

This class provides a concrete implementation of StAXStreamProcessor for supporting the StAXStreamOutputter.

Overview

This class is marked abstract even though all methods are fully implemented. The process*(...) methods are public because they match the StAXStreamProcessor interface but the remaining methods are all protected. People who want to create a custom StAXStreamProcessor for StAXStreamOutputter 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(XMLStreamWriter, 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(XMLStreamWriter, FormatStack, NamespaceStack, Element) and printContent(XMLStreamWriter, FormatStack, NamespaceStack, Walker) methods, but the FormatStack is pushed through to all print* Methods. An interesting read for people using this class: Apache Axiom notes on setPrefix().

从以下版本开始:

JDOM2

作者:

Rolf Lear

另请参阅:

StAXStreamOutputter, StAXStreamProcessor

构造器概要

构造器

构造器和说明
AbstractStAXStreamProcessor()

方法概要

限定符和类型	方法和说明
void	process(javax.xml.stream.XMLStreamWriter out, Format format, CDATA cdata) Print out a CDATA node.
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 Document to the given XMLStreamWriter.
void	process(javax.xml.stream.XMLStreamWriter out, Format format, Element element) Print out an Element, including its Attributes, and all contained (child) elements, etc.
void	process(javax.xml.stream.XMLStreamWriter out, Format format, EntityRef entity) Print out a EntityRef.
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, ProcessingInstruction pi) Print out a ProcessingInstruction.
void	process(javax.xml.stream.XMLStreamWriter out, Format format, Text text) Print out a Text node.

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

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

构造器详细资料

AbstractStAXStreamProcessor

public AbstractStAXStreamProcessor()

方法详细资料

process

public void process(javax.xml.stream.XMLStreamWriter out,
                    Format format,
                    Document doc)
             throws javax.xml.stream.XMLStreamException

从接口复制的说明: StAXStreamProcessor

This will print the Document to the given XMLStreamWriter.

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.

指定者:

process 在接口中 StAXStreamProcessor

参数:

out - XMLStreamWriter to use.

format - Format instance specifying output style

doc - Document to format.

抛出:

javax.xml.stream.XMLStreamException - if there's any problem writing.

process

public void process(javax.xml.stream.XMLStreamWriter out,
                    Format format,
                    DocType doctype)
             throws javax.xml.stream.XMLStreamException

从接口复制的说明: StAXStreamProcessor

Print out the DocType.

指定者:

process 在接口中 StAXStreamProcessor

参数:

out - XMLStreamWriter to use.

format - Format instance specifying output style

doctype - DocType to output.

抛出:

javax.xml.stream.XMLStreamException - if there's any problem writing.

process

public void process(javax.xml.stream.XMLStreamWriter out,
                    Format format,
                    Element element)
             throws javax.xml.stream.XMLStreamException

从接口复制的说明: StAXStreamProcessor

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

指定者:

process 在接口中 StAXStreamProcessor

参数:

out - XMLStreamWriter to use.

format - Format instance specifying output style

element - Element to output.

抛出:

javax.xml.stream.XMLStreamException - if there's any problem writing.

process

public void process(javax.xml.stream.XMLStreamWriter out,
                    Format format,
                    java.util.List<? extends Content> list)
             throws javax.xml.stream.XMLStreamException

从接口复制的说明: StAXStreamProcessor

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 在接口中 StAXStreamProcessor

参数:

out - XMLStreamWriter to use.

format - Format instance specifying output style

list - List of nodes.

抛出:

javax.xml.stream.XMLStreamException - if there's any problem writing.

process

public void process(javax.xml.stream.XMLStreamWriter out,
                    Format format,
                    CDATA cdata)
             throws javax.xml.stream.XMLStreamException

从接口复制的说明: StAXStreamProcessor

Print out a CDATA node.

指定者:

process 在接口中 StAXStreamProcessor

参数:

out - XMLStreamWriter to use.

format - Format instance specifying output style

cdata - CDATA to output.

抛出:

javax.xml.stream.XMLStreamException - if there's any problem writing.

process

public void process(javax.xml.stream.XMLStreamWriter out,
                    Format format,
                    Text text)
             throws javax.xml.stream.XMLStreamException

从接口复制的说明: StAXStreamProcessor

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

指定者:

process 在接口中 StAXStreamProcessor

参数:

out - XMLStreamWriter to use.

format - Format instance specifying output style

text - Text to output.

抛出:

javax.xml.stream.XMLStreamException - if there's any problem writing.

process

public void process(javax.xml.stream.XMLStreamWriter out,
                    Format format,
                    Comment comment)
             throws javax.xml.stream.XMLStreamException

从接口复制的说明: StAXStreamProcessor

Print out a Comment.

指定者:

process 在接口中 StAXStreamProcessor

参数:

out - XMLStreamWriter to use.

format - Format instance specifying output style

comment - Comment to output.

抛出:

javax.xml.stream.XMLStreamException - if there's any problem writing.

process

public void process(javax.xml.stream.XMLStreamWriter out,
                    Format format,
                    ProcessingInstruction pi)
             throws javax.xml.stream.XMLStreamException

从接口复制的说明: StAXStreamProcessor

Print out a ProcessingInstruction.

指定者:

process 在接口中 StAXStreamProcessor

参数:

out - XMLStreamWriter to use.

format - Format instance specifying output style

pi - ProcessingInstruction to output.

抛出:

javax.xml.stream.XMLStreamException - if there's any problem writing.

process

public void process(javax.xml.stream.XMLStreamWriter out,
                    Format format,
                    EntityRef entity)
             throws javax.xml.stream.XMLStreamException

从接口复制的说明: StAXStreamProcessor

Print out a EntityRef.

指定者:

process 在接口中 StAXStreamProcessor

参数:

out - XMLStreamWriter to use.

format - Format instance specifying output style

entity - EntityRef to output.

抛出:

javax.xml.stream.XMLStreamException - if there's any problem writing.