Class StAXResult
- 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
FieldsModifier and TypeFieldDescriptionstatic final StringIfTransformerFactory.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
ConstructorsConstructorDescriptionStAXResult(XMLEventWriter xmlEventWriter) Creates a new instance of aStAXResultby supplying anXMLEventWriter.StAXResult(XMLStreamWriter xmlStreamWriter) Creates a new instance of aStAXResultby supplying anXMLStreamWriter. -
Method Summary
Modifier and TypeMethodDescriptionThe returned system identifier is alwaysnull.Get theXMLEventWriterused by thisStAXResult.Get theXMLStreamWriterused by thisStAXResult.voidsetSystemId(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
StAXResultby supplying anXMLEventWriter.XMLEventWritermust be a non-nullreference.- Parameters:
xmlEventWriter-XMLEventWriterused to create thisStAXResult.- Throws:
IllegalArgumentException- IfxmlEventWriter==null.
-
StAXResult
Creates a new instance of a
StAXResultby supplying anXMLStreamWriter.XMLStreamWritermust be a non-nullreference.- Parameters:
xmlStreamWriter-XMLStreamWriterused to create thisStAXResult.- Throws:
IllegalArgumentException- IfxmlStreamWriter==null.
-
-
Method Details
-
getXMLEventWriter
Get the
XMLEventWriterused by thisStAXResult.XMLEventWriterwill benullif thisStAXResultwas created with aXMLStreamWriter.- Returns:
XMLEventWriterused by thisStAXResult.
-
getXMLStreamWriter
Get the
XMLStreamWriterused by thisStAXResult.XMLStreamWriterwill benullif thisStAXResultwas created with aXMLEventWriter.- Returns:
XMLStreamWriterused by thisStAXResult.
-
setSystemId
In the context of a
StAXResult, it is not appropriate to explicitly set the system identifier. TheXMLEventWriterorXMLStreamWriterused to construct thisStAXResultdetermines the system identifier of the XML result.An
UnsupportedOperationExceptionis always thrown by this method.- Specified by:
setSystemIdin interfaceResult- Parameters:
systemId- Ignored.- Throws:
UnsupportedOperationException- Is always thrown by this method.
-
getSystemId
The returned system identifier is always
null.- Specified by:
getSystemIdin interfaceResult- Returns:
- The returned system identifier is always
null.
-