- java.lang.Object
-
- javax.xml.transform.stax.StAXResult
-
- All Implemented Interfaces:
Result
public class StAXResult extends Object implements Result
Acts as a holder for an XML
Resultin the form of a StAX writer,i.e.XMLStreamWriterorXMLEventWriter.StAXResultcan be used in all cases that accept aResult, e.g.Transformer,Validatorwhich acceptResultas input.- Since:
- 1.6
- See Also:
-
JSR 173: Streaming API for XML,
XMLStreamWriter,XMLEventWriter
-
-
Field Summary
Fields Modifier and Type Field Description static StringFEATUREIfTransformerFactory.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
Constructors Constructor Description StAXResult(XMLEventWriter xmlEventWriter)Creates a new instance of aStAXResultby supplying anXMLEventWriter.StAXResult(XMLStreamWriter xmlStreamWriter)Creates a new instance of aStAXResultby supplying anXMLStreamWriter.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description StringgetSystemId()The returned system identifier is alwaysnull.XMLEventWritergetXMLEventWriter()Get theXMLEventWriterused by thisStAXResult.XMLStreamWritergetXMLStreamWriter()Get theXMLStreamWriterused by thisStAXResult.voidsetSystemId(String systemId)In the context of aStAXResult, it is not appropriate to explicitly set the system identifier.
-
-
-
Field Detail
-
FEATURE
public static final String FEATURE
IfTransformerFactory.getFeature(String name)returns true when passed this value as an argument, the Transformer supports Result output of this type.- See Also:
- Constant Field Values
-
-
Constructor Detail
-
StAXResult
public StAXResult(XMLEventWriter xmlEventWriter)
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
public StAXResult(XMLStreamWriter xmlStreamWriter)
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 Detail
-
getXMLEventWriter
public XMLEventWriter getXMLEventWriter()
Get the
XMLEventWriterused by thisStAXResult.XMLEventWriterwill benullif thisStAXResultwas created with aXMLStreamWriter.- Returns:
XMLEventWriterused by thisStAXResult.
-
getXMLStreamWriter
public XMLStreamWriter getXMLStreamWriter()
Get the
XMLStreamWriterused by thisStAXResult.XMLStreamWriterwill benullif thisStAXResultwas created with aXMLEventWriter.- Returns:
XMLStreamWriterused by thisStAXResult.
-
setSystemId
public void setSystemId(String systemId)
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
public String getSystemId()
The returned system identifier is always
null.- Specified by:
getSystemIdin interfaceResult- Returns:
- The returned system identifier is always
null.
-
-