StAXResult (Java Platform SE 6) (original) (raw)
javax.xml.transform.stax
Class StAXResult
java.lang.Object
javax.xml.transform.stax.StAXResult
All Implemented Interfaces:
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 acceptResult as input.
Since:
1.6
See Also:
JSR 173: Streaming API for XML, XMLStreamWriter, XMLEventWriter
| Field Summary | |
|---|---|
| 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. |
| Fields inherited from interface javax.xml.transform.Result |
|---|
| PI_DISABLE_OUTPUT_ESCAPING, PI_ENABLE_OUTPUT_ESCAPING |
| Constructor Summary |
|---|
| 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. |
| Method Summary | |
|---|---|
| String | getSystemId() The returned system identifier is always null. |
| XMLEventWriter | getXMLEventWriter() Get the XMLEventWriter used by thisStAXResult. |
| XMLStreamWriter | getXMLStreamWriter() Get the XMLStreamWriter used by thisStAXResult. |
| void | setSystemId(String systemId) In the context of a StAXResult, it is not appropriate to explicitly set the system identifier. |
| Methods inherited from class java.lang.Object |
|---|
| clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, [wait](../../../../java/lang/Object.html#wait%28long, int%29) |
| Field Detail |
|---|
FEATURE
public static final String FEATURE
If TransformerFactory.getFeature(String name) returns true when passed this value as an argument, the Transformer supports Result output of this type.
See Also:
| Constructor Detail |
|---|
StAXResult
public StAXResult(XMLEventWriter xmlEventWriter)
Creates a new instance of a StAXResult by supplying an XMLEventWriter.
XMLEventWriter must be a non-null reference.
Parameters:
xmlEventWriter - XMLEventWriter used to create this StAXResult.
Throws:
[IllegalArgumentException](../../../../java/lang/IllegalArgumentException.html "class in java.lang") - If xmlEventWriter ==null.
StAXResult
public StAXResult(XMLStreamWriter xmlStreamWriter)
Creates a new instance of a StAXResult by supplying an XMLStreamWriter.
XMLStreamWriter must be a non-null reference.
Parameters:
xmlStreamWriter - XMLStreamWriter used to create this StAXResult.
Throws:
[IllegalArgumentException](../../../../java/lang/IllegalArgumentException.html "class in java.lang") - If xmlStreamWriter ==null.
| Method Detail |
|---|
getXMLEventWriter
public XMLEventWriter getXMLEventWriter()
Get the XMLEventWriter used by thisStAXResult.
XMLEventWriter will be null if this StAXResult was created with aXMLStreamWriter.
Returns:
XMLEventWriter used by thisStAXResult.
getXMLStreamWriter
public XMLStreamWriter getXMLStreamWriter()
Get the XMLStreamWriter used by thisStAXResult.
XMLStreamWriter will be null if this StAXResult 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. 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.
Specified by:
[setSystemId](../../../../javax/xml/transform/Result.html#setSystemId%28java.lang.String%29) in interface [Result](../../../../javax/xml/transform/Result.html "interface in javax.xml.transform")
Parameters:
systemId - Ignored.
Throws:
[UnsupportedOperationException](../../../../java/lang/UnsupportedOperationException.html "class in java.lang") - Is always thrown by this method.
getSystemId
public String getSystemId()
The returned system identifier is always null.
Specified by:
[getSystemId](../../../../javax/xml/transform/Result.html#getSystemId%28%29) in interface [Result](../../../../javax/xml/transform/Result.html "interface in javax.xml.transform")
Returns:
The returned system identifier is always null.
Submit a bug or feature
For further API reference and developer documentation, see Java SE Developer Documentation. That documentation contains more detailed, developer-targeted descriptions, with conceptual overviews, definitions of terms, workarounds, and working code examples.
Copyright © 1993, 2015, Oracle and/or its affiliates. All rights reserved. Use is subject to license terms. Also see the documentation redistribution policy.
Scripting on this page tracks web page traffic, but does not change the content in any way.