Package com.sun.xml.ws.util.xml

Class StAXSource

java.lang.Object

javax.xml.transform.sax.SAXSource

com.sun.xml.ws.util.xml.StAXSource

All Implemented Interfaces:

Source

public class StAXSource
extends SAXSource

A JAXP Source implementation that wraps the specified XMLStreamReader or XMLEventReader for use by applications that expect a Source.

The fact that StAXSource derives from SAXSource is an implementation detail. Thus in general applications are strongly discouraged from accessing methods defined on SAXSource. In particular:

• The setXMLReader and setInputSource methods shall never be called.
• The XMLReader object obtained by the getXMLReader method shall be used only for parsing the InputSource object returned by the getInputSource method.
• The InputSource object obtained by the getInputSource method shall be used only for being parsed by the XMLReader object returned by the getXMLReader method.

Example:

    // create a StAXSource
    XMLStreamReader reader = XMLInputFactory.newInstance().createXMLStreamReader(new FileReader(args[0]));
    Source staxSource = new StAXSource(reader);

    // create a StreamResult
    Result streamResult = new StreamResult(System.out);

    // run the transform
    TransformerFactory.newInstance().newTransformer().transform(staxSource, streamResult);
 

Version:

1.0

Author:

Ryan.Shoemaker@Sun.COM

Field Summary

Fields inherited from class javax.xml.transform.sax.SAXSource

FEATURE

Constructor Summary

Constructors

Constructor	Description
StAXSource(XMLStreamReader reader, boolean eagerQuit)	Creates a new Source for the given XMLStreamReader.
StAXSource(XMLStreamReader reader, boolean eagerQuit, String[] inscope)	Creates a new Source for the given XMLStreamReader.

Method Summary

Methods inherited from class javax.xml.transform.sax.SAXSource

getInputSource, getSystemId, getXMLReader, isEmpty, setInputSource, setSystemId, setXMLReader, sourceToInputSource

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

StAXSource

public StAXSource(XMLStreamReader reader,
                  boolean eagerQuit)

Creates a new Source for the given XMLStreamReader.

Parameters:

reader - XMLStreamReader that will be exposed as a Source

eagerQuit - if true, when the conversion is completed, leave the cursor to the last event that was fired (such as end element)

See Also:

StAXSource(XMLStreamReader, boolean, String[])

StAXSource

public StAXSource(XMLStreamReader reader,
                  boolean eagerQuit,
                  @NotNull
                  String[] inscope)

Creates a new Source for the given XMLStreamReader. The XMLStreamReader must be pointing at either a XMLStreamConstants.START_DOCUMENT or XMLStreamConstants.START_ELEMENT event.

Parameters:

reader - XMLStreamReader that will be exposed as a Source

eagerQuit - if true, when the conversion is completed, leave the cursor to the last event that was fired (such as end element)

inscope - inscope Namespaces array of the even length of the form { prefix0, uri0, prefix1, uri1, ... }

Throws:

IllegalArgumentException - iff the reader is null

IllegalStateException - iff the reader is not pointing at either a START_DOCUMENT or START_ELEMENT event