javax.xml.transform.stax
class StAXResult

java.lang.Object javax.xml.transform.stax.StAXResult

All Implemented Interfaces:

Result

public class StAXResult
extends Object
implements Result

Acts as a holder for an XML {@link Result} in the form of a StAX writer,i.e. {@link XMLStreamWriter} or {@link XMLEventWriter}. StAXResult can be used in all cases that accept a Result, e.g. {@link javax.xml.transform.Transformer}, {@link javax.xml.validation.Validator} which accept Result as input.

FEATURE

public static final String FEATURE

If {@link javax.xml.transform.TransformerFactory#getFeature(String name)} returns true when passed this value as an argument, the Transformer supports Result output of this type.

StAXResult

public StAXResult(XMLEventWriter xmlEventWriter)

Creates a new instance of a StAXResult by supplying an {@link XMLEventWriter}.

XMLEventWriter must be a non-null reference.

Parameters:

xmlEventWriter - XMLEventWriter used to create this StAXResult.

StAXResult

public StAXResult(XMLStreamWriter xmlStreamWriter)

Creates a new instance of a StAXResult by supplying an {@link XMLStreamWriter}.

XMLStreamWriter must be a non-null reference.

Parameters:

xmlStreamWriter - XMLStreamWriter used to create this StAXResult.

getSystemId

public String getSystemId()

The returned system identifier is always null.

Returns:

The returned system identifier is always null.

getXMLEventWriter

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.

getXMLStreamWriter

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.

setSystemId

public void setSystemId(String systemId)

In the context of a StAXResult, it is not appropriate to explicitly set the system identifier. The XMLEventWriter or XMLStreamWriter used to construct this StAXResult determines the system identifier of the XML result.

An {@link UnsupportedOperationException} is always thrown by this method.

Parameters:

systemId - Ignored.