StAXEventOutputter

java.lang.Object
- org.jdom2.output.StAXEventOutputter

所有已实现的接口:

java.lang.Cloneable
```
public final class StAXEventOutputter
extends java.lang.Object
implements java.lang.Cloneable
```
Outputs a JDOM document as a StAX XMLEventConsumer of bytes.
The StAXStreamOutputter can manage many styles of document formatting, from untouched to 'pretty' printed. The default is to output the document content exactly as created, but this can be changed by setting a new Format object:
- For pretty-print output, use Format.getPrettyFormat().
- For whitespace-normalised output, use Format.getCompactFormat().
- For unmodified-format output, use Format.getRawFormat().
All of the output*(...) methods will flush the destination XMLEventConsumer before returning, and none of them will close() the destination.
To omit output of the declaration use Format.setOmitDeclaration(boolean). To omit printing of the encoding in the declaration use Format.setOmitEncoding(boolean).
If changing the Format settings are insufficient for your output needs you can customise this StAXStreamOutputter further by setting a different StAXEventProcessor with the setStAXEventProcessor(StAXEventProcessor) method or an appropriate constructor. A fully-enabled Abstract class AbstractStAXEventProcessor is available to be further extended to your needs if all you want to do is tweak some details.
从以下版本开始:

JDOM2

作者:

Rolf Lear

构造器概要

构造器
构造器和说明
`StAXEventOutputter()` This will create an `StAXStreamOutputter` with a default `Format` and `XMLOutputProcessor`.
`StAXEventOutputter(Format format)` This will create an `StAXStreamOutputter` with the specified format characteristics.
`StAXEventOutputter(Format format, StAXEventProcessor processor, javax.xml.stream.XMLEventFactory eventfactory)` This will create an `StAXStreamOutputter` with the specified format characteristics.
`StAXEventOutputter(StAXEventProcessor processor)` This will create an `StAXStreamOutputter` with the specified XMLOutputProcessor.
`StAXEventOutputter(javax.xml.stream.XMLEventFactory eventfactory)` This will create an `StAXStreamOutputter` with the specified XMLOutputProcessor.

方法概要

所有方法实例方法具体方法
限定符和类型	方法和说明
`StAXEventOutputter`	`clone()` Returns a cloned copy of this StAXStreamOutputter.
`javax.xml.stream.XMLEventFactory`	`getEventFactory()`
`Format`	`getFormat()` Returns the current format in use by the StAXStreamOutputter.
`StAXEventProcessor`	`getStAXStream()` Returns the current XMLOutputProcessor instance in use by the StAXStreamOutputter.
`void`	`output(CDATA cdata, javax.xml.stream.util.XMLEventConsumer out)` Print out a `CDATA` node.
`void`	`output(Comment comment, javax.xml.stream.util.XMLEventConsumer out)` Print out a `Comment`.
`void`	`output(DocType doctype, javax.xml.stream.util.XMLEventConsumer out)` Print out the `DocType`.
`void`	`output(Document doc, javax.xml.stream.util.XMLEventConsumer out)` This will print the `Document` to the given Writer.
`void`	`output(Element element, javax.xml.stream.util.XMLEventConsumer out)` Print out an `Element`, including its `Attribute`s, and all contained (child) elements, etc.
`void`	`output(EntityRef entity, javax.xml.stream.util.XMLEventConsumer out)` Print out an `EntityRef`.
`void`	`output(java.util.List<? extends Content> list, javax.xml.stream.util.XMLEventConsumer out)` This will handle printing out a list of nodes.
`void`	`output(ProcessingInstruction pi, javax.xml.stream.util.XMLEventConsumer out)` Print out a `ProcessingInstruction`.
`void`	`output(Text text, javax.xml.stream.util.XMLEventConsumer out)` Print out a `Text` node.
`void`	`outputElementContent(Element element, javax.xml.stream.util.XMLEventConsumer out)` This will handle printing out an `Element`'s content only, not including its tag, and attributes.
`void`	`setEventFactory(javax.xml.stream.XMLEventFactory myEventFactory)`
`void`	`setFormat(Format newFormat)` Sets the new format logic for the StAXStreamOutputter.
`void`	`setStAXEventProcessor(StAXEventProcessor processor)` Sets a new XMLOutputProcessor instance for this StAXStreamOutputter.
`java.lang.String`	`toString()` Return a string listing of the settings for this StAXStreamOutputter instance.

从类继承的方法 java.lang.Object
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

- 构造器详细资料
  - StAXEventOutputter
```
public StAXEventOutputter(Format format,
                          StAXEventProcessor processor,
                          javax.xml.stream.XMLEventFactory eventfactory)
```
    This will create an StAXStreamOutputter with the specified format characteristics.
    Note: the format object is cloned internally before use. If you want to modify the Format after constructing the StAXStreamOutputter you can modify the Format instance getFormat() returns.
    
    参数:
    
    format - The Format instance to use. This instance will be cloned() and as a consequence, changes made to the specified format instance will not be reflected in this StAXStreamOutputter. A null input format indicates that StAXStreamOutputter should use the default Format.getRawFormat()
    
    processor - The XMLOutputProcessor to delegate output to. If null the StAXStreamOutputter will use the default XMLOutputProcessor.
    
    eventfactory - The factory to use to create XMLEvent instances.
  - StAXEventOutputter
```
public StAXEventOutputter()
```
    This will create an StAXStreamOutputter with a default Format and XMLOutputProcessor.
  - StAXEventOutputter
```
public StAXEventOutputter(Format format)
```
    This will create an StAXStreamOutputter with the specified format characteristics.
    Note: the format object is cloned internally before use.
    
    参数:
    
    format - The Format instance to use. This instance will be cloned() and as a consequence, changes made to the specified format instance will not be reflected in this StAXStreamOutputter. A null input format indicates that StAXStreamOutputter should use the default Format.getRawFormat()
  - StAXEventOutputter
```
public StAXEventOutputter(StAXEventProcessor processor)
```
    This will create an StAXStreamOutputter with the specified XMLOutputProcessor.
    
    参数:
    
    processor - The XMLOutputProcessor to delegate output to. If null the StAXStreamOutputter will use the default XMLOutputProcessor.
  - StAXEventOutputter
```
public StAXEventOutputter(javax.xml.stream.XMLEventFactory eventfactory)
```
    This will create an StAXStreamOutputter with the specified XMLOutputProcessor.
    
    参数:
    
    eventfactory - The XMLEventFactory to use to create XMLEvent instances.
- 方法详细资料
  - setFormat
```
public void setFormat(Format newFormat)
```
    Sets the new format logic for the StAXStreamOutputter. Note the Format object is cloned internally before use.
    
    参数:
    
    newFormat - the format to use for subsequent output
    
    另请参阅:
    
    getFormat()
  - getFormat
```
public Format getFormat()
```
    Returns the current format in use by the StAXStreamOutputter. Note the Format object returned is not a clone of the one used internally, thus, an StAXStreamOutputter instance is able to have it's Format changed by changing the settings on the Format instance returned by this method.
    
    返回:
    
    the current Format instance used by this StAXStreamOutputter.
  - getStAXStream
```
public StAXEventProcessor getStAXStream()
```
    Returns the current XMLOutputProcessor instance in use by the StAXStreamOutputter.
    
    返回:
    
    the current XMLOutputProcessor instance.
  - setStAXEventProcessor
```
public void setStAXEventProcessor(StAXEventProcessor processor)
```
    Sets a new XMLOutputProcessor instance for this StAXStreamOutputter. Note the processor object is expected to be thread-safe.
    
    参数:
    
    processor - the new XMLOutputProcesor to use for output
  - getEventFactory
```
public javax.xml.stream.XMLEventFactory getEventFactory()
```
    返回:
    
    the current XMLEventFactory used by this StAXEventOutputter
  - setEventFactory
```
public void setEventFactory(javax.xml.stream.XMLEventFactory myEventFactory)
```
    参数:
    
    myEventFactory - the XMLEventFactory to use for subsequent output.
  - output
```
public final void output(Document doc,
                         javax.xml.stream.util.XMLEventConsumer out)
                  throws javax.xml.stream.XMLStreamException
```
    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.
    
    参数:
    
    doc - Document to format.
    
    out - XMLEventConsumer to use.
    
    抛出:
    
    javax.xml.stream.XMLStreamException - - if there's any problem writing.
    
    java.lang.NullPointerException - if the specified content is null.
  - output
```
public final void output(DocType doctype,
                         javax.xml.stream.util.XMLEventConsumer out)
                  throws javax.xml.stream.XMLStreamException
```
    Print out the DocType.
    
    参数:
    
    doctype - DocType to output.
    
    out - XMLEventConsumer to use.
    
    抛出:
    
    javax.xml.stream.XMLStreamException - - if there's any problem writing.
    
    java.lang.NullPointerException - if the specified content is null.
  - output
```
public final void output(Element element,
                         javax.xml.stream.util.XMLEventConsumer out)
                  throws javax.xml.stream.XMLStreamException
```
    Print out an Element, including its Attributes, and all contained (child) elements, etc.
    
    参数:
    
    element - Element to output.
    
    out - XMLEventConsumer to use.
    
    抛出:
    
    javax.xml.stream.XMLStreamException - - if there's any problem writing.
    
    java.lang.NullPointerException - if the specified content is null.
  - outputElementContent
```
public final void outputElementContent(Element element,
                                       javax.xml.stream.util.XMLEventConsumer out)
                                throws javax.xml.stream.XMLStreamException
```
    This will handle printing out an Element's content only, not including its tag, and attributes. This can be useful for printing the content of an element that contains HTML, like "<description>JDOM is <b>fun>!</description>".
    
    参数:
    
    element - Element to output.
    
    out - XMLEventConsumer to use.
    
    抛出:
    
    javax.xml.stream.XMLStreamException - - if there's any problem writing.
    
    java.lang.NullPointerException - if the specified content is null.
  - output
```
public final void output(java.util.List<? extends Content> list,
                         javax.xml.stream.util.XMLEventConsumer out)
                  throws javax.xml.stream.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>".
    
    参数:
    
    list - List of nodes.
    
    out - XMLEventConsumer to use.
    
    抛出:
    
    javax.xml.stream.XMLStreamException - - if there's any problem writing.
    
    java.lang.NullPointerException - if the specified content is null.
  - output
```
public final void output(CDATA cdata,
                         javax.xml.stream.util.XMLEventConsumer out)
                  throws javax.xml.stream.XMLStreamException
```
    Print out a CDATA node.
    
    参数:
    
    cdata - CDATA to output.
    
    out - XMLEventConsumer to use.
    
    抛出:
    
    javax.xml.stream.XMLStreamException - - if there's any problem writing.
    
    java.lang.NullPointerException - if the specified content is null.
  - output
```
public final void output(Text text,
                         javax.xml.stream.util.XMLEventConsumer out)
                  throws javax.xml.stream.XMLStreamException
```
    Print out a Text node. Perfoms the necessary entity escaping and whitespace stripping.
    
    参数:
    
    text - Text to output.
    
    out - XMLEventConsumer to use.
    
    抛出:
    
    javax.xml.stream.XMLStreamException - - if there's any problem writing.
    
    java.lang.NullPointerException - if the specified content is null.
  - output
```
public final void output(Comment comment,
                         javax.xml.stream.util.XMLEventConsumer out)
                  throws javax.xml.stream.XMLStreamException
```
    Print out a Comment.
    
    参数:
    
    comment - Comment to output.
    
    out - XMLEventConsumer to use.
    
    抛出:
    
    javax.xml.stream.XMLStreamException - - if there's any problem writing.
    
    java.lang.NullPointerException - if the specified content is null.
  - output
```
public final void output(ProcessingInstruction pi,
                         javax.xml.stream.util.XMLEventConsumer out)
                  throws javax.xml.stream.XMLStreamException
```
    Print out a ProcessingInstruction.
    
    参数:
    
    pi - ProcessingInstruction to output.
    
    out - XMLEventConsumer to use.
    
    抛出:
    
    javax.xml.stream.XMLStreamException - - if there's any problem writing.
    
    java.lang.NullPointerException - if the specified content is null.
  - output
```
public final void output(EntityRef entity,
                         javax.xml.stream.util.XMLEventConsumer out)
                  throws javax.xml.stream.XMLStreamException
```
    Print out an EntityRef.
    
    参数:
    
    entity - EntityRef to output.
    
    out - XMLEventConsumer to use.
    
    抛出:
    
    javax.xml.stream.XMLStreamException - - if there's any problem writing.
    
    java.lang.NullPointerException - if the specified content is null.
  - clone
```
public StAXEventOutputter clone()
```
    Returns a cloned copy of this StAXStreamOutputter.
    
    覆盖:
    
    clone 在类中 java.lang.Object
  - toString
```
public java.lang.String toString()
```
    Return a string listing of the settings for this StAXStreamOutputter instance.
    
    覆盖:
    
    toString 在类中 java.lang.Object
    
    返回:
    
    a string listing the settings for this StAXStreamOutputter instance

类 StAXEventOutputter

构造器概要

方法概要

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

构造器详细资料

StAXEventOutputter

StAXEventOutputter

StAXEventOutputter

StAXEventOutputter

StAXEventOutputter

方法详细资料

setFormat

getFormat

getStAXStream

setStAXEventProcessor

getEventFactory

setEventFactory

output

output

output

outputElementContent

output

output

output

output

output

output

clone

toString