- All Implemented Interfaces:
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.
- Since:
- 1.6
- See Also:
-
Field Summary
Modifier and TypeFieldDescriptionstatic final String
IfTransformerFactory.getFeature(String name)
returns true when passed this value as an argument, the Transformer supports Result output of this type.Fields declared in interface javax.xml.transform.Result
PI_DISABLE_OUTPUT_ESCAPING, PI_ENABLE_OUTPUT_ESCAPING
-
Constructor Summary
ConstructorDescriptionStAXResult
(XMLEventWriter xmlEventWriter) Creates a new instance of aStAXResult
by supplying anXMLEventWriter
.StAXResult
(XMLStreamWriter xmlStreamWriter) Creates a new instance of aStAXResult
by supplying anXMLStreamWriter
. -
Method Summary
Modifier and TypeMethodDescriptionThe returned system identifier is alwaysnull
.Get theXMLEventWriter
used by thisStAXResult
.Get theXMLStreamWriter
used by thisStAXResult
.void
setSystemId
(String systemId) In the context of aStAXResult
, it is not appropriate to explicitly set the system identifier.
-
Field Details
-
FEATURE
IfTransformerFactory.getFeature(String name)
returns true when passed this value as an argument, the Transformer supports Result output of this type.- See Also:
-
-
Constructor Details
-
StAXResult
Creates a new instance of a
StAXResult
by supplying anXMLEventWriter
.XMLEventWriter
must be a non-null
reference.- Parameters:
xmlEventWriter
-XMLEventWriter
used to create thisStAXResult
.- Throws:
IllegalArgumentException
- IfxmlEventWriter
==null
.
-
StAXResult
Creates a new instance of a
StAXResult
by supplying anXMLStreamWriter
.XMLStreamWriter
must be a non-null
reference.- Parameters:
xmlStreamWriter
-XMLStreamWriter
used to create thisStAXResult
.- Throws:
IllegalArgumentException
- IfxmlStreamWriter
==null
.
-
-
Method Details
-
getXMLEventWriter
Get the
XMLEventWriter
used by thisStAXResult
.XMLEventWriter
will benull
if thisStAXResult
was created with aXMLStreamWriter
.- Returns:
XMLEventWriter
used by thisStAXResult
.
-
getXMLStreamWriter
Get the
XMLStreamWriter
used by thisStAXResult
.XMLStreamWriter
will benull
if thisStAXResult
was created with aXMLEventWriter
.- Returns:
XMLStreamWriter
used by thisStAXResult
.
-
setSystemId
In the context of a
StAXResult
, it is not appropriate to explicitly set the system identifier. TheXMLEventWriter
orXMLStreamWriter
used to construct thisStAXResult
determines the system identifier of the XML result.An
UnsupportedOperationException
is always thrown by this method.- Specified by:
setSystemId
in interfaceResult
- Parameters:
systemId
- Ignored.- Throws:
UnsupportedOperationException
- Is always thrown by this method.
-
getSystemId
The returned system identifier is always
null
.- Specified by:
getSystemId
in interfaceResult
- Returns:
- The returned system identifier is always
null
.
-