Result
public class StAXResult extends Object implements Result
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.
Modifier and Type | Field | Description |
---|---|---|
static final String |
FEATURE |
If TransformerFactory.getFeature(String name) returns true when passed this value as an argument, the Transformer supports Result output of this type. |
PI_DISABLE_OUTPUT_ESCAPING, PI_ENABLE_OUTPUT_ESCAPING
Constructor | Description |
---|---|
StAXResult |
Creates a new instance of a StAXResult by supplying an XMLEventWriter . |
StAXResult |
Creates a new instance of a StAXResult by supplying an XMLStreamWriter . |
Modifier and Type | Method | Description |
---|---|---|
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 |
In the context of a StAXResult , it is not appropriate to explicitly set the system identifier. |
public static final String FEATURE
TransformerFactory.getFeature(String name)
returns true when passed this value as an argument, the Transformer supports Result output of this type.public StAXResult(XMLEventWriter xmlEventWriter)
Creates a new instance of a StAXResult
by supplying an XMLEventWriter
.
XMLEventWriter
must be a non-null
reference.
xmlEventWriter
- XMLEventWriter
used to create this StAXResult
.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.
xmlStreamWriter
- XMLStreamWriter
used to create this StAXResult
.IllegalArgumentException
- If xmlStreamWriter
== null
.public XMLEventWriter getXMLEventWriter()
Get the XMLEventWriter
used by this StAXResult
.
XMLEventWriter
will be null
if this StAXResult
was created with a XMLStreamWriter
.
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
.
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.
setSystemId
in interface Result
systemId
- Ignored.UnsupportedOperationException
- Is always thrown by this method.public String getSystemId()
The returned system identifier is always null
.
getSystemId
in interface Result
null
.
© 1993, 2023, Oracle and/or its affiliates. All rights reserved.
Documentation extracted from Debian's OpenJDK Development Kit package.
Licensed under the GNU General Public License, version 2, with the Classpath Exception.
Various third party code in OpenJDK is licensed under different licenses (see Debian package).
Java and OpenJDK are trademarks or registered trademarks of Oracle and/or its affiliates.
https://docs.oracle.com/en/java/javase/21/docs/api/java.xml/javax/xml/transform/stax/StAXResult.html