org.apache.xmlbeans.impl.common

Class GenericXmlInputStream

java.lang.Object

org.apache.xmlbeans.impl.common.GenericXmlInputStream

All Implemented Interfaces:

XMLInputStream

Direct Known Subclasses:

ValidatingXMLInputStream

Deprecated.

XMLInputStream was deprecated by XMLStreamReader from STaX - jsr173 API.

public class GenericXmlInputStream
extends Object
implements XMLInputStream

Constructor Summary

Constructors

Constructor and Description
GenericXmlInputStream() Deprecated.

Method Summary

Modifier and Type	Method and Description
void	close() Deprecated. Closes this input stream and releases any system resources associated with the stream.
ReferenceResolver	getReferenceResolver() Deprecated. Returns the reference resolver that was set for this stream, returns null if no ReferenceResolver has been set.
XMLInputStream	getSubStream() Deprecated. getSubStream() returns a stream which points to the entire next element in the current stream.
boolean	hasNext() Deprecated. Check if there are more events to pull of the stream
XMLEvent	next() Deprecated. Get the next XMLEvent on the stream
XMLEvent	peek() Deprecated. Check the next XMLEvent without reading it from the stream.
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.
void	skip() Deprecated. Skip the next stream event
boolean	skip(int eventType) Deprecated. Position the stream at the next XMLEvent of this type.
boolean	skip(XMLName name) Deprecated. Position the stream at the next element of this name.
boolean	skip(XMLName name, int eventType) Deprecated. Position the stream at the next element of this name and this type.
void	skipElement() Deprecated. Skips the entire next start tag / end tag pair.

Methods inherited from class java.lang.Object

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

Constructor Detail

GenericXmlInputStream

public GenericXmlInputStream()

Deprecated.

Method Detail

next

public XMLEvent next()
              throws XMLStreamException

Deprecated.

Description copied from interface: XMLInputStream

Get the next XMLEvent on the stream

Specified by:

next in interface XMLInputStream

Throws:

XMLStreamException

See Also:

XMLEvent

hasNext

public boolean hasNext()
                throws XMLStreamException

Deprecated.

Description copied from interface: XMLInputStream

Check if there are more events to pull of the stream

Specified by:

hasNext in interface XMLInputStream

Throws:

XMLStreamException

See Also:

XMLEvent

skip

public void skip()
          throws XMLStreamException

Deprecated.

Description copied from interface: XMLInputStream

Skip the next stream event

Specified by:

skip in interface XMLInputStream

Throws:

XMLStreamException

skipElement

public void skipElement()
                 throws XMLStreamException

Deprecated.

Description copied from interface: XMLInputStream

Skips the entire next start tag / end tag pair.

Specified by:

skipElement in interface XMLInputStream

Throws:

XMLStreamException

peek

public XMLEvent peek()
              throws XMLStreamException

Deprecated.

Description copied from interface: XMLInputStream

Check the next XMLEvent without reading it from the stream. Returns null if the stream is at EOF or has no more XMLEvents.

Specified by:

peek in interface XMLInputStream

Throws:

XMLStreamException

See Also:

XMLEvent

skip

public boolean skip(int eventType)
             throws XMLStreamException

Deprecated.

Description copied from interface: XMLInputStream

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.

Specified by:

skip in interface XMLInputStream

Parameters:

eventType - An integer code that indicates the element type.

Throws:

XMLStreamException

See Also:

XMLEvent

skip

public boolean skip(XMLName name)
             throws XMLStreamException

Deprecated.

Description copied from interface: XMLInputStream

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.

Specified by:

skip in interface XMLInputStream

Parameters:

name - An object that defines an XML name. If the XMLName.getNameSpaceName() method on the XMLName argument returns null the XMLName will match just the local name. Prefixes are not checked for equality.

Throws:

XMLStreamException

See Also:

XMLName

skip

public boolean skip(XMLName name,
                    int eventType)
             throws XMLStreamException

Deprecated.

Description copied from interface: XMLInputStream

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.

Specified by:

skip in interface XMLInputStream

Parameters:

name - An object that defines an XML name. If the XMLName.getNameSpaceName() method on the XMLName argument returns null the XMLName will match just the local name. Prefixes are not checked for equality.

eventType - An integer code that indicates the element type.

Throws:

XMLStreamException

See Also:

XMLEvent, XMLName

getSubStream

public XMLInputStream getSubStream()
                            throws XMLStreamException

Deprecated.

Description copied from interface: XMLInputStream

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.

Specified by:

getSubStream in interface XMLInputStream

Throws:

XMLStreamException

close

public void close()
           throws XMLStreamException

Deprecated.

Description copied from interface: XMLInputStream

Closes this input stream and releases any system resources associated with the stream.

Specified by:

close in interface XMLInputStream

Throws:

XMLStreamException

getReferenceResolver

public ReferenceResolver getReferenceResolver()

Deprecated.

Description copied from interface: XMLInputStream

Returns the reference resolver that was set for this stream, returns null if no ReferenceResolver has been set.

Specified by:

getReferenceResolver in interface XMLInputStream

See Also:

ReferenceResolver

setReferenceResolver

public void setReferenceResolver(ReferenceResolver resolver)

Deprecated.

Description copied from interface: XMLInputStream

Provides a way to set the ReferenceResolver of the stream, this is mostly needed for handle references to other parts of the document.

Specified by:

setReferenceResolver in interface XMLInputStream

See Also:

ReferenceResolver