StAXResult JDK 1.6)

Description

public class StAXResult

Acts as a holder for an XML Result in the form of a StAX writer,i.e.

See also: JSR 173: Streaming API for XML XMLStreamWriter XMLEventWriter

Constructors

public StAXResult (XMLEventWriter xmlEventWriter)

Creates a new instance of a StAXResult by supplying an XMLEventWriter.

XMLEventWriter must be a non-null reference.

Parameters:
- xmlEventWriter - XMLEventWriter used to create this StAXResult.
Throws:
- IllegalArgumentException - If xmlEventWriter == null.

public StAXResult (XMLStreamWriter xmlStreamWriter)

Creates a new instance of a StAXResult by supplying an XMLStreamWriter.

XMLStreamWriter must be a non-null reference.

Parameters:
- xmlStreamWriter - XMLStreamWriter used to create this StAXResult.
Throws:
- IllegalArgumentException - If xmlStreamWriter == null.

Methods

Hide/Show inherited methods

public String getSystemId () [Specified in Result]

The returned system identifier is always null.

Returns: The returned system identifier is always null.

public XMLEventWriter getXMLEventWriter ()

Get the XMLEventWriter used by this StAXResult.

XMLEventWriter will be null if this StAXResult was created with a XMLStreamWriter.

Returns: XMLEventWriter used by this StAXResult.

public XMLStreamWriter getXMLStreamWriter ()

Get the XMLStreamWriter used by this StAXResult.

XMLStreamWriter will be null if this StAXResult was created with a XMLEventWriter.

Returns: XMLStreamWriter used by this StAXResult.

public void setSystemId (String systemId) [Specified in Result]

In the context of a StAXResult, it is not appropriate to explicitly set the system identifier.

Fields

Hide/Show inherited fields

publicfinalstatic String FEATURE = "http://javax.xml.transform.stax.StAXResult/feature"

If TransformerFactory.getFeature(String name) returns true when passed this value as an argument, the Transformer supports Result output of this type.

publicfinalstatic String PI_DISABLE_OUTPUT_ESCAPING = "javax.xml.transform.disable-output-escaping" [Inherited From Result]

The name of the processing instruction that is sent if the result tree disables output escaping.

publicfinalstatic String PI_ENABLE_OUTPUT_ESCAPING = "javax.xml.transform.enable-output-escaping" [Inherited From Result]

The name of the processing instruction that is sent if the result tree enables output escaping at some point after having received a PI_DISABLE_OUTPUT_ESCAPING processing instruction.