public class

StAXResult

extends Object
implements Result
java.lang.Object
   ↳ javax.xml.transform.stax.StAXResult

Class Overview

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

See Also

Summary

Constants
String FEATURE If getFeature(String) returns true when passed this value as an argument, the Transformer supports Result output of this type.
[Expand]
Inherited Constants
From interface javax.xml.transform.Result
Public Constructors
StAXResult(XMLEventWriter xmlEventWriter)

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

StAXResult(XMLStreamWriter xmlStreamWriter)

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

Public Methods
String getSystemId()

The returned system identifier is always null.

XMLEventWriter getXMLEventWriter()

Get the XMLEventWriter used by this StAXResult.

XMLStreamWriter getXMLStreamWriter()

Get the XMLStreamWriter used by this StAXResult.

void setSystemId(String systemId)

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

[Expand]
Inherited Methods
From class java.lang.Object
From interface javax.xml.transform.Result

Constants

public static final String FEATURE

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

Constant Value: "http://javax.xml.transform.stax.StAXResult/feature"

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

Public Methods

public String getSystemId ()

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)

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 UnsupportedOperationException is always thrown by this method.

Parameters
systemId Ignored.
Throws
UnsupportedOperationException Is always thrown by this method.