Class StAXResult
- 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
Result
in the form of a StAX writer,i.e.XMLStreamWriter
orXMLEventWriter
.StAXResult
can be used in all cases that accept aResult
, e.g.Transformer
,Validator
which acceptResult
as input.- Since:
- 1.6
- See Also:
-
JSR 173: Streaming API for XML,
XMLStreamWriter
,XMLEventWriter
-
-
Field Summary
Fields Modifier and Type Field and Description static String
FEATURE
IfTransformerFactory.getFeature(String name)
returns true when passed this value as an argument, the Transformer supports Result output of this type.-
Fields inherited from interface javax.xml.transform.Result
PI_DISABLE_OUTPUT_ESCAPING, PI_ENABLE_OUTPUT_ESCAPING
-
-
Constructor Summary
Constructors Constructor and Description StAXResult(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
All Methods Instance Methods Concrete Methods Modifier and Type Method and Description String
getSystemId()
The returned system identifier is alwaysnull
.XMLEventWriter
getXMLEventWriter()
Get theXMLEventWriter
used by thisStAXResult
.XMLStreamWriter
getXMLStreamWriter()
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 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
StAXResult
by supplying anXMLEventWriter
.XMLEventWriter
must be a non-null
reference.- Parameters:
-
xmlEventWriter
-XMLEventWriter
used to create thisStAXResult
. - Throws:
-
IllegalArgumentException
- IfxmlEventWriter
==null
.
StAXResult
public StAXResult(XMLStreamWriter xmlStreamWriter)
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 Detail
getXMLEventWriter
public XMLEventWriter getXMLEventWriter()
Get the
XMLEventWriter
used by thisStAXResult
.XMLEventWriter
will benull
if thisStAXResult
was created with aXMLStreamWriter
.- Returns:
-
XMLEventWriter
used by thisStAXResult
.
getXMLStreamWriter
public XMLStreamWriter getXMLStreamWriter()
Get the
XMLStreamWriter
used by thisStAXResult
.XMLStreamWriter
will benull
if thisStAXResult
was created with aXMLEventWriter
.- Returns:
-
XMLStreamWriter
used by thisStAXResult
.
setSystemId
public void setSystemId(String systemId)
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
public String getSystemId()
The returned system identifier is always
null
.- Specified by:
-
getSystemId
in interfaceResult
- Returns:
-
The returned system identifier is always
null
.
-
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, 2022, Oracle and/or its affiliates. All rights reserved. Use is subject to license terms. Also see the documentation redistribution policy.