FileDocCategorySizeDatePackage
StAXResult.javaAPI DocJava SE 6 API6101Tue Jun 10 00:27:14 BST 2008javax.xml.transform.stax

StAXResult

public class StAXResult extends Object implements Result

Acts as a holder for an XML {@link Result} in the form of a StAX writer,i.e. {@link XMLStreamWriter} or {@link XMLEventWriter}. StAXResult can be used in all cases that accept a Result, e.g. {@link javax.xml.transform.Transformer}, {@link javax.xml.validation.Validator} which accept Result as input.

author
Neeraj Bajaj
author
Jeff Suttor
version
$Revision: 1.4 $, $Date: 2006/04/24 13:42:26 $
see
JSR 173: Streaming API for XML
see
XMLStreamWriter
see
XMLEventWriter
since
1.6

Fields Summary
public static final String
FEATURE
If {@link javax.xml.transform.TransformerFactory#getFeature(String name)} returns true when passed this value as an argument, the Transformer supports Result output of this type.
private XMLEventWriter
xmlEventWriter

XMLEventWriter to be used for Result output.

private XMLStreamWriter
xmlStreamWriter

XMLStreamWriter to be used for Result output.

private String
systemId

System identifier for this StAXResult.

Constructors Summary
public StAXResult(XMLEventWriter xmlEventWriter)

Creates a new instance of a StAXResult by supplying an {@link XMLEventWriter}.

XMLEventWriter must be a non-null reference.

param
xmlEventWriter XMLEventWriter used to create this StAXResult.
throws
IllegalArgumentException If xmlEventWriter == null.


                                             
        

        if (xmlEventWriter == null) {
            throw new IllegalArgumentException(
                    "StAXResult(XMLEventWriter) with XMLEventWriter == null");
        }

        this.xmlEventWriter = xmlEventWriter;
    
public StAXResult(XMLStreamWriter xmlStreamWriter)

Creates a new instance of a StAXResult by supplying an {@link XMLStreamWriter}.

XMLStreamWriter must be a non-null reference.

param
xmlStreamWriter XMLStreamWriter used to create this StAXResult.
throws
IllegalArgumentException If xmlStreamWriter == null.


        if (xmlStreamWriter == null) {
            throw new IllegalArgumentException(
                    "StAXResult(XMLStreamWriter) with XMLStreamWriter == null");
        }

        this.xmlStreamWriter = xmlStreamWriter;
    
Methods Summary
public java.lang.StringgetSystemId()

The returned system identifier is always null.

return
The returned system identifier is always null.


        return null;
    
public javax.xml.stream.XMLEventWritergetXMLEventWriter()

Get the XMLEventWriter used by this StAXResult.

XMLEventWriter will be null if this StAXResult was created with a XMLStreamWriter.

return
XMLEventWriter used by this StAXResult.


        return xmlEventWriter;
    
public javax.xml.stream.XMLStreamWritergetXMLStreamWriter()

Get the XMLStreamWriter used by this StAXResult.

XMLStreamWriter will be null if this StAXResult was created with a XMLEventWriter.

return
XMLStreamWriter used by this StAXResult.


        return xmlStreamWriter;
    
public voidsetSystemId(java.lang.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 {@link UnsupportedOperationException} is always thrown by this method.

param
systemId Ignored.
throws
UnsupportedOperationException Is always thrown by this method.


        throw new UnsupportedOperationException(
                "StAXResult#setSystemId(systemId) cannot set the "
                + "system identifier for a StAXResult");