Home » xmlbeans-2.5.0-src » org.apache.xmlbeans.xml » stream » [javadoc | source]
org.apache.xmlbeans.xml.stream
public interface: XMLInputStream [javadoc | source]

All Known Implementing Classes:
    GenericXmlInputStream, BufferedXMLInputStream, ValidatingXMLInputStream, XmlInputStreamImpl

Deprecated! XMLInputStream - was deprecated by XMLStreamReader from STaX - jsr173 API.

This is the top level interface for iterating over XML Events in an XML document.

Difference from SAX

An event stream can be thought of encapsulating SAX events. It applies an iterator/pull metaphor to the parser allowing procedural, stream-based, handling of input XML rather than having to write chained event handlers to handle complex XML documents.

Difference from DOM

The pull metaphor allows single-pass, stream-based parsing of the document rather than tree based manipulation.

Method from org.apache.xmlbeans.xml.stream.XMLInputStream Summary:
close,   getReferenceResolver,   getSubStream,   hasNext,   next,   peek,   setReferenceResolver,   skip,   skip,   skip,   skip,   skipElement
Method from org.apache.xmlbeans.xml.stream.XMLInputStream Detail:
 public  void close() throws XMLStreamException       Deprecated!
    Closes this input stream and releases any system resources associated with the stream.
 public ReferenceResolver getReferenceResolver()       Deprecated!
    Returns the reference resolver that was set for this stream, returns null if no ReferenceResolver has been set.
 public XMLInputStream getSubStream() throws XMLStreamException       Deprecated!
    getSubStream() returns a stream which points to the entire next element in the current stream. For example: take a document that has a root node A, where the children of A are B, C, and D. If the stream is pointing to the start element of A, getSubStream() will return A, B, C and D including the start element of A and the end element of A. The position of the parent stream is not changed and the events read by the substream are written back to its parent.
 public boolean hasNext() throws XMLStreamException       Deprecated!
    Check if there are more events to pull of the stream
 public XMLEvent next() throws XMLStreamException       Deprecated!
    Get the next XMLEvent on the stream
 public XMLEvent peek() throws XMLStreamException       Deprecated!
    Check the next XMLEvent without reading it from the stream. Returns null if the stream is at EOF or has no more XMLEvents.
 public  void setReferenceResolver(ReferenceResolver resolver)       Deprecated!
    Provides a way to set the ReferenceResolver of the stream, this is mostly needed for handle references to other parts of the document.
 public  void skip() throws XMLStreamException       Deprecated!
    Skip the next stream event
 public boolean skip(int eventType) throws XMLStreamException       Deprecated!
    Position the stream at the next XMLEvent of this type. The method returns true if the stream contains another XMLEvent of this type and false otherwise.
 public boolean skip(XMLName name) throws XMLStreamException       Deprecated!
    Position the stream at the next element of this name. The method returns true if the stream contains another element with this name and false otherwise. Skip is a forward operator only. It does not look backward in the stream.
 public boolean skip(XMLName name,
    int eventType) throws XMLStreamException       Deprecated!
    Position the stream at the next element of this name and this type. The method returns true if the stream contains another element with this name of this type and false otherwise.
 public  void skipElement() throws XMLStreamException       Deprecated!
    Skips the entire next start tag / end tag pair.