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.
XMLStreamWriter,
XMLEventWriter| Modifier and Type | Field and Description |
|---|---|
static 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 and Description |
|---|
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. |
| Modifier and Type | Method and 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(String systemId)
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 ResultsystemId - Ignored.UnsupportedOperationException - Is always
thrown by this method.public String getSystemId()
The returned system identifier is always null.
getSystemId in interface Resultnull. Submit a bug or feature
For further API reference and developer documentation, see Java SE Documentation. That documentation contains more detailed, developer-targeted descriptions, with conceptual overviews, definitions of terms, workarounds, and working code examples.
Copyright © 1993, 2018, Oracle and/or its affiliates. All rights reserved. Use is subject to license terms. Also see the documentation redistribution policy.