OpenJDK 1.23 · com.sun.org.apache.xerces.internal.impl.XMLStreamReaderImpl

Modifier and Type	Field and Description
pack-priv static final boolean	DEBUG debug flag
protected static final String	ENTITY_MANAGER Property identifier: entity manager.
protected static final String	ERROR_REPORTER Property identifier: Error Reporter.
private String	fDTDDecl
protected XMLEntityManager	fEntityManager
protected XMLEntityScanner	fEntityScanner Entity scanner, this alwasy works on last entity that was opened.
protected StaxErrorReporter	fErrorReporter
private int	fEventType current event type
protected XMLInputSource	fInputSource Input Source
protected NamespaceContextWrapper	fNamespaceContextWrapper
protected PropertyManager	fPropertyManager Store properties
private boolean	fReaderInDefinedState
private boolean	fReuse more to scan
protected XMLDocumentScannerImpl	fScanner Document scanner.
private SymbolTable	fSymbolTable
protected static final String	READER_IN_DEFINED_STATE
protected static final String	SYMBOL_TABLE Property identifier: Symbol table.
private String	versionStr

Access	Constructor and Description
public	XMLStreamReaderImpl(InputStream inputStream, PropertyManager props)
public	XMLStreamReaderImpl(String systemid, PropertyManager props)
public	XMLStreamReaderImpl(InputStream inputStream, String encoding, PropertyManager props)
public	XMLStreamReaderImpl(Reader reader, PropertyManager props)
public	XMLStreamReaderImpl(XMLInputSource inputSource, PropertyManager props)

Method Summary

Modifier and Type	Method and Description
public boolean	canReuse() This function tells if this instances is available for reuse.
public void	close() Implements javax.xml.stream.XMLStreamReader.close. Frees any resources associated with this Reader.
public QName	convertXNIQNametoJavaxQName(QName qname)
public int	Returns: returns the number of attributes getAttributeCount() Implements javax.xml.stream.XMLStreamReader.getAttributeCount. Returns the count of attributes on this START_ELEMENT, this method is only valid on a START_ELEMENT or ATTRIBUTE.
public String	getAttributeLocalName(int index) Implements javax.xml.stream.XMLStreamReader.getAttributeLocalName. Returns the localName of the attribute at the provided index
public QName	Returns: the localName of the attribute getAttributeName(int the position of the attribute index) Implements javax.xml.stream.XMLStreamReader.getAttributeName. Returns the localName of the attribute at the provided index
public String	Returns: the namespace URI (can be null) getAttributeNamespace(int the position of the attribute index) Implements javax.xml.stream.XMLStreamReader.getAttributeNamespace. Returns the namespace of the attribute at the provided index
public String	Returns: the prefix of the attribute getAttributePrefix(int the position of the attribute index) Implements javax.xml.stream.XMLStreamReader.getAttributePrefix. Returns the prefix of this attribute at the provided index
public QName	Returns: the QName of the attribute getAttributeQName(int the position of the attribute index) Returns the qname of the attribute at the provided index
public String	Returns: the XML type of the attribute getAttributeType(int the position of the attribute index) Implements javax.xml.stream.XMLStreamReader.getAttributeType. Returns the XML type of the attribute at the provided index
public String	Returns: the attribute value getAttributeValue(int the position of the attribute index) Implements javax.xml.stream.XMLStreamReader.getAttributeValue. Returns the value of the attribute at the index
public String	getAttributeValue(String namespaceURI, String localName) Implements javax.xml.stream.XMLStreamReader.getAttributeValue. Returns the normalized attribute value of the attribute with the namespace and localName If the namespaceURI is null the namespace is not checked for equality
public String	Returns: the encoding declared in the document or null getCharacterEncodingScheme() Implements javax.xml.stream.XMLStreamReader.getCharacterEncodingScheme. Returns the character encoding declared on the xml declaration Returns null if none was declared
public int	getColumnNumber()
public String	getElementText() Implements javax.xml.stream.XMLStreamReader.getElementText. Reads the content of a text-only element.
public String	Returns: the encoding of this instance or null getEncoding() Implements javax.xml.stream.XMLStreamReader.getEncoding. Return input encoding if known or null if unknown.
protected List<EntityDeclaration>	getEntityDecls()
public int	Returns: the current text or null getEventType() Implements javax.xml.stream.XMLStreamReader.getEventType. Returns the current value of the parse event as a string, this returns the string value of a CHARACTERS event, returns the value of a COMMENT, the replacement value for an ENTITY_REFERENCE, the string value of a CDATA section, the string value for a SPACE event, or the String value of the internal subset of the DTD.
pack-priv static final String	getEventTypeString(int eventType)
public int	getLineNumber()
public String	getLocalName() Implements javax.xml.stream.XMLStreamReader.getLocalName. Returns the (local) name of the current event.
public Location	getLocation() Implements javax.xml.stream.XMLStreamReader.getLocation. Return the current location of the processor.
public QName	Returns: the QName for the current START_ELEMENT or END_ELEMENT event getName() Implements javax.xml.stream.XMLStreamReader.getName. Returns a QName for the current START_ELEMENT or END_ELEMENT event
public NamespaceContext	Returns: return a namespace context getNamespaceContext() Implements javax.xml.stream.XMLStreamReader.getNamespaceContext. Returns a read only namespace context for the current position.
public int	Returns: returns the number of namespace declarations on this specific element getNamespaceCount() Implements javax.xml.stream.XMLStreamReader.getNamespaceCount. Returns the count of namespaces declared on this START_ELEMENT or END_ELEMENT, this method is only valid on a START_ELEMENT, END_ELEMENT or NAMESPACE.
public String	Returns: returns the namespace prefix getNamespacePrefix(int the position of the namespace declaration index) Implements javax.xml.stream.XMLStreamReader.getNamespacePrefix. Returns the prefix for the namespace declared at the index.
public String	getNamespaceURI() Implements javax.xml.stream.XMLStreamReader.getNamespaceURI. If the current event is a START_ELEMENT or END_ELEMENT this method returns the URI of the prefix or the default namespace.
public String	Returns: returns the namespace uri getNamespaceURI(int the position of the namespace declaration index) Implements javax.xml.stream.XMLStreamReader.getNamespaceURI. Returns the uri for the namespace declared at the index.
public String	Returns: the uri bound to the given prefix or null if it is not bound getNamespaceURI(String The prefix to lookup, may not be null prefix) Implements javax.xml.stream.XMLStreamReader.getNamespaceURI. Return the uri for the given prefix.
protected List<NotationDeclaration>	getNotationDecls()
public String	Returns: the data or null getPIData() Implements javax.xml.stream.XMLStreamReader.getPIData. Get the data section of a processing instruction
public String	Returns: the target or null getPITarget() Implements javax.xml.stream.XMLStreamReader.getPITarget. Get the target of a processing instruction
public String	Returns: the prefix of the current event, or null if the event does not have a prefix. For START_ELEMENT and END_ELEMENT, return XMLConstants.DEFAULT_NS_PREFIX when no prefix is available. getPrefix() Implements javax.xml.stream.XMLStreamReader.getPrefix. Returns the prefix of the current event or null if the event does not have a prefix
public Object	Returns: The value of the property getProperty(String The name of the property, may not be null name) Implements javax.xml.stream.XMLStreamReader.getProperty. Get the value of a feature/property from the underlying implementation
protected PropertyManager	Returns: returns the reference to property manager. getPropertyManager()
public XMLDocumentScannerImpl	getScanner()
public String	Returns: the current text or null getText() Implements javax.xml.stream.XMLStreamReader.getText. Returns the current value of the parse event as a string, this returns the string value of a CHARACTERS event, returns the value of a COMMENT, the replacement value for an ENTITY_REFERENCE, or the String value of the DTD
public char[]	getTextCharacters() Implements javax.xml.stream.XMLStreamReader.getTextCharacters. Returns an array which contains the characters from this event.
public int	Returns: the number of characters actually copied getTextCharacters(int the index of the first character in the source array to copy sourceStart, char[] the destination array target, int the start offset in the target array targetStart, int the number of characters to copy length) Implements javax.xml.stream.XMLStreamReader.getTextCharacters. Gets the the text associated with a CHARACTERS, SPACE or CDATA event.
public int	getTextLength() Implements javax.xml.stream.XMLStreamReader.getTextLength. Returns the length of the sequence of characters for this Text event within the text character array.
public int	getTextStart() Implements javax.xml.stream.XMLStreamReader.getTextStart. Returns the offset into the text character array where the first character (of this text event) is stored.
public String	getValue()
public String	getVersion() Implements javax.xml.stream.XMLStreamReader.getVersion. Get the XML language version of the current document being parsed
public boolean	hasAttributes()
public boolean	hasName() Implements javax.xml.stream.XMLStreamReader.hasName. this Funtion returns true if the current event has name
public boolean	hasNext() Implements javax.xml.stream.XMLStreamReader.hasNext. Returns true if there are more parsing events and false if there are no more events.
public boolean	hasText() Implements javax.xml.stream.XMLStreamReader.hasText. Return true if the current event has text, false otherwise The following events have text: CHARACTERS,DTD ,ENTITY_REFERENCE, COMMENT
public boolean	hasValue()
pack-priv final void	init(PropertyManager propertyManager)
public boolean	Returns: true if this is a default attribute isAttributeSpecified(int the position of the attribute index) Implements javax.xml.stream.XMLStreamReader.isAttributeSpecified. Returns a boolean which indicates if this attribute was created by default
public boolean	Returns: true if the cursor points to character data, false otherwise isCharacters() Implements javax.xml.stream.XMLStreamReader.isCharacters. Returns true if the cursor points to a character data event
public boolean	isEndElement() Implements javax.xml.stream.XMLStreamReader.isEndElement. Returns true if the cursor points to an end tag (otherwise false)
public boolean	isStandalone() Implements javax.xml.stream.XMLStreamReader.isStandalone. Get the standalone declaration from the xml declaration
public boolean	isStartElement() Implements javax.xml.stream.XMLStreamReader.isStartElement. Returns true if the cursor points to a start tag (otherwise false)
public boolean	isWhiteSpace() Implements javax.xml.stream.XMLStreamReader.isWhiteSpace. Returns true if the cursor points to a character data event that consists of all whitespace Application calling this method needs to cache the value and avoid calling this method again for the same event.
public int	next() Implements javax.xml.stream.XMLStreamReader.next. Get next parsing event - a processor may return all contiguous character data in a single chunk, or it may split it into several chunks.
public int	Returns: the event type of the element read nextTag() Implements javax.xml.stream.XMLStreamReader.nextTag. Skips any insignificant events (COMMENT and PROCESSING_INSTRUCTION) until a START_ELEMENT or END_ELEMENT is reached.
pack-priv static void	pr(String str)
public void	require(int the event type type, String the uri of the event, may be null namespaceURI, String the localName of the event, may be null localName) Implements javax.xml.stream.XMLStreamReader.require. Test if the current event is of the given type and if the namespace and name match the current namespace and name of the current event.
public void	reset() Resets this instance so that this instance is ready for reuse.
public final void	setInputSource(XMLInputSource inputSource)
protected void	setPropertyManager(PropertyManager propertyManager)
public boolean	Returns: true if standalone was set in the document, or false otherwise standaloneSet() Implements javax.xml.stream.XMLStreamReader.standaloneSet. Checks if standalone was set in the document
private void	switchToXML11Scanner()

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

DEBUG	back to summary
pack-priv static final boolean DEBUG debug flag

ENTITY_MANAGER	back to summary
protected static final String ENTITY_MANAGER Property identifier: entity manager.

ERROR_REPORTER	back to summary
protected static final String ERROR_REPORTER Property identifier: Error Reporter.

fDTDDecl	back to summary
private String fDTDDecl

fEntityManager	back to summary
protected XMLEntityManager fEntityManager

fEntityScanner	back to summary
protected XMLEntityScanner fEntityScanner Entity scanner, this alwasy works on last entity that was opened.

fErrorReporter	back to summary
protected StaxErrorReporter fErrorReporter

fEventType	back to summary
private int fEventType current event type

fInputSource	back to summary
protected XMLInputSource fInputSource Input Source

fNamespaceContextWrapper	back to summary
protected NamespaceContextWrapper fNamespaceContextWrapper

fPropertyManager	back to summary
protected PropertyManager fPropertyManager Store properties

fReaderInDefinedState	back to summary
private boolean fReaderInDefinedState

fReuse	back to summary
private boolean fReuse more to scan

fScanner	back to summary
protected XMLDocumentScannerImpl fScanner Document scanner.

fSymbolTable	back to summary
private SymbolTable fSymbolTable

READER_IN_DEFINED_STATE	back to summary
protected static final String READER_IN_DEFINED_STATE

SYMBOL_TABLE	back to summary
protected static final String SYMBOL_TABLE Property identifier: Symbol table.

versionStr	back to summary
private String versionStr

XMLStreamReaderImpl	back to summary
public XMLStreamReaderImpl(InputStream inputStream, PropertyManager props) throws XMLStreamException

XMLStreamReaderImpl	back to summary
public XMLStreamReaderImpl(String systemid, PropertyManager props) throws XMLStreamException

XMLStreamReaderImpl	back to summary
public XMLStreamReaderImpl(InputStream inputStream, String encoding, PropertyManager props) throws XMLStreamException

XMLStreamReaderImpl	back to summary
public XMLStreamReaderImpl(Reader reader, PropertyManager props) throws XMLStreamException

XMLStreamReaderImpl	back to summary
public XMLStreamReaderImpl(XMLInputSource inputSource, PropertyManager props) throws XMLStreamException

Method Detail

canReuse	back to summary
public boolean canReuse() This function tells if this instances is available for reuse. One must call reset() and setInputSource() to be able to reuse this instance.

close	back to summary
public void close() throws XMLStreamException Implements javax.xml.stream.XMLStreamReader.close. Frees any resources associated with this Reader. This method does not close the underlying input source. Exceptions XMLStreamException: if there are errors freeing associated resources

back to summary

public void close() throws XMLStreamException

Implements javax.xml.stream.XMLStreamReader.close.

Frees any resources associated with this Reader. This method does not close the underlying input source.

Exceptions

XMLStreamException:: if there are errors freeing associated resources

convertXNIQNametoJavaxQName	back to summary
public QName convertXNIQNametoJavaxQName(QName qname)

getAttributeCount	back to summary
public int getAttributeCount() Implements javax.xml.stream.XMLStreamReader.getAttributeCount. Returns the count of attributes on this START_ELEMENT, this method is only valid on a START_ELEMENT or ATTRIBUTE. This count excludes namespace definitions. Attribute indices are zero-based. Returns:int returns the number of attributes Exceptions IllegalStateException: if this is not a START_ELEMENT or ATTRIBUTE

getAttributeCount

back to summary

public int getAttributeCount()

Implements javax.xml.stream.XMLStreamReader.getAttributeCount.

Returns the count of attributes on this START_ELEMENT, this method is only valid on a START_ELEMENT or ATTRIBUTE. This count excludes namespace definitions. Attribute indices are zero-based.

Returns:int

returns the number of attributes

Exceptions

IllegalStateException:: if this is not a START_ELEMENT or ATTRIBUTE

getAttributeLocalName	back to summary
public String getAttributeLocalName(int index) Implements javax.xml.stream.XMLStreamReader.getAttributeLocalName. Doc from javax.xml.stream.XMLStreamReader.getAttributeLocalName. Returns the localName of the attribute at the provided index

getAttributeLocalName

back to summary

public String getAttributeLocalName(int index)

Implements javax.xml.stream.XMLStreamReader.getAttributeLocalName.

Doc from javax.xml.stream.XMLStreamReader.getAttributeLocalName.

Returns the localName of the attribute at the provided index

getAttributeName	back to summary
public QName getAttributeName(int index) Implements javax.xml.stream.XMLStreamReader.getAttributeName. Returns the localName of the attribute at the provided index Parameters index:int the position of the attribute Returns:QName the localName of the attribute Exceptions IllegalStateException: if this is not a START_ELEMENT or ATTRIBUTE

getAttributeName

back to summary

public QName getAttributeName(int index)

Implements javax.xml.stream.XMLStreamReader.getAttributeName.

Returns the localName of the attribute at the provided index

Parameters

index:int: the position of the attribute

Returns:QName

the localName of the attribute

Exceptions

IllegalStateException:: if this is not a START_ELEMENT or ATTRIBUTE

getAttributeNamespace	back to summary
public String getAttributeNamespace(int index) Implements javax.xml.stream.XMLStreamReader.getAttributeNamespace. Returns the namespace of the attribute at the provided index Parameters index:int the position of the attribute Returns:String the namespace URI (can be null) Exceptions IllegalStateException: if this is not a START_ELEMENT or ATTRIBUTE

getAttributeNamespace

back to summary

public String getAttributeNamespace(int index)

Implements javax.xml.stream.XMLStreamReader.getAttributeNamespace.

Returns the namespace of the attribute at the provided index

Parameters

index:int: the position of the attribute

Returns:String

the namespace URI (can be null)

Exceptions

IllegalStateException:: if this is not a START_ELEMENT or ATTRIBUTE

getAttributePrefix	back to summary
public String getAttributePrefix(int index) Implements javax.xml.stream.XMLStreamReader.getAttributePrefix. Returns the prefix of this attribute at the provided index Parameters index:int the position of the attribute Returns:String the prefix of the attribute Exceptions IllegalStateException: if this is not a START_ELEMENT or ATTRIBUTE

getAttributePrefix

back to summary

public String getAttributePrefix(int index)

Implements javax.xml.stream.XMLStreamReader.getAttributePrefix.

Returns the prefix of this attribute at the provided index

Parameters

index:int: the position of the attribute

Returns:String

the prefix of the attribute

Exceptions

IllegalStateException:: if this is not a START_ELEMENT or ATTRIBUTE

getAttributeQName	back to summary
public QName getAttributeQName(int index) Returns the qname of the attribute at the provided index Parameters index:int the position of the attribute Returns:QName the QName of the attribute Exceptions IllegalStateException: if this is not a START_ELEMENT or ATTRIBUTE

getAttributeQName

back to summary

public QName getAttributeQName(int index)

Returns the qname of the attribute at the provided index

Parameters

index:int: the position of the attribute

Returns:QName

the QName of the attribute

Exceptions

IllegalStateException:: if this is not a START_ELEMENT or ATTRIBUTE

getAttributeType	back to summary
public String getAttributeType(int index) Implements javax.xml.stream.XMLStreamReader.getAttributeType. Returns the XML type of the attribute at the provided index Parameters index:int the position of the attribute Returns:String the XML type of the attribute Exceptions IllegalStateException: if this is not a START_ELEMENT or ATTRIBUTE

getAttributeType

back to summary

public String getAttributeType(int index)

Implements javax.xml.stream.XMLStreamReader.getAttributeType.

Returns the XML type of the attribute at the provided index

Parameters

index:int: the position of the attribute

Returns:String

the XML type of the attribute

Exceptions

IllegalStateException:: if this is not a START_ELEMENT or ATTRIBUTE

getAttributeValue	back to summary
public String getAttributeValue(int index) Implements javax.xml.stream.XMLStreamReader.getAttributeValue. Returns the value of the attribute at the index Parameters index:int the position of the attribute Returns:String the attribute value Exceptions IllegalStateException: if this is not a START_ELEMENT or ATTRIBUTE

getAttributeValue

back to summary

public String getAttributeValue(int index)

Implements javax.xml.stream.XMLStreamReader.getAttributeValue.

Returns the value of the attribute at the index

Parameters

index:int: the position of the attribute

Returns:String

the attribute value

Exceptions

IllegalStateException:: if this is not a START_ELEMENT or ATTRIBUTE

getAttributeValue	back to summary
public String getAttributeValue(String namespaceURI, String localName) Implements javax.xml.stream.XMLStreamReader.getAttributeValue. Doc from javax.xml.stream.XMLStreamReader.getAttributeValue. Returns the normalized attribute value of the attribute with the namespace and localName If the namespaceURI is null the namespace is not checked for equality

getAttributeValue

back to summary

public String getAttributeValue(String namespaceURI, String localName)

Implements javax.xml.stream.XMLStreamReader.getAttributeValue.

Doc from javax.xml.stream.XMLStreamReader.getAttributeValue.

Returns the normalized attribute value of the attribute with the namespace and localName If the namespaceURI is null the namespace is not checked for equality

getCharacterEncodingScheme	back to summary
public String getCharacterEncodingScheme() Implements javax.xml.stream.XMLStreamReader.getCharacterEncodingScheme. Returns the character encoding declared on the xml declaration Returns null if none was declared Returns:String the encoding declared in the document or null

getCharacterEncodingScheme

back to summary

public String getCharacterEncodingScheme()

Implements javax.xml.stream.XMLStreamReader.getCharacterEncodingScheme.

Returns the character encoding declared on the xml declaration Returns null if none was declared

Returns:String: the encoding declared in the document or null

getColumnNumber	back to summary
public int getColumnNumber()

getElementText	back to summary
public String getElementText() throws XMLStreamException Implements javax.xml.stream.XMLStreamReader.getElementText. Reads the content of a text-only element. Precondition the current event is START_ELEMENT. Postcondition: The current event is the corresponding END_ELEMENT. Returns:String Doc from javax.xml.stream.XMLStreamReader.getElementText. the content of a text-only element Exceptions XMLStreamException: if the current event is not a START_ELEMENT or if a non text element is encountered

getElementText

back to summary

public String getElementText() throws XMLStreamException

Implements javax.xml.stream.XMLStreamReader.getElementText.

Reads the content of a text-only element.

Precondition

the current event is START_ELEMENT. Postcondition: The current event is the corresponding END_ELEMENT.

Returns:String

Doc from javax.xml.stream.XMLStreamReader.getElementText.

the content of a text-only element

Exceptions

XMLStreamException:: if the current event is not a START_ELEMENT or if a non text element is encountered

getEncoding	back to summary
public String getEncoding() Implements javax.xml.stream.XMLStreamReader.getEncoding. Return input encoding if known or null if unknown. Returns:String the encoding of this instance or null

getEncoding

back to summary

public String getEncoding()

Implements javax.xml.stream.XMLStreamReader.getEncoding.

Return input encoding if known or null if unknown.

Returns:String: the encoding of this instance or null

getEntityDecls	back to summary
protected List<EntityDeclaration> getEntityDecls()

getEventType	back to summary
public int getEventType() Implements javax.xml.stream.XMLStreamReader.getEventType. Returns the current value of the parse event as a string, this returns the string value of a CHARACTERS event, returns the value of a COMMENT, the replacement value for an ENTITY_REFERENCE, the string value of a CDATA section, the string value for a SPACE event, or the String value of the internal subset of the DTD. If an ENTITY_REFERENCE has been resolved, any character data will be reported as CHARACTERS events. Returns:int the current text or null

getEventType

back to summary

public int getEventType()

Implements javax.xml.stream.XMLStreamReader.getEventType.

Returns the current value of the parse event as a string, this returns the string value of a CHARACTERS event, returns the value of a COMMENT, the replacement value for an ENTITY_REFERENCE, the string value of a CDATA section, the string value for a SPACE event, or the String value of the internal subset of the DTD. If an ENTITY_REFERENCE has been resolved, any character data will be reported as CHARACTERS events.

Returns:int: the current text or null

getEventTypeString	back to summary
pack-priv static final String getEventTypeString(int eventType)

getLineNumber	back to summary
public int getLineNumber()

getLocalName	back to summary
public String getLocalName() Implements javax.xml.stream.XMLStreamReader.getLocalName. Doc from javax.xml.stream.XMLStreamReader.getLocalName. Returns the (local) name of the current event. For START_ELEMENT or END_ELEMENT returns the (local) name of the current element. For ENTITY_REFERENCE it returns entity name. The current event must be START_ELEMENT or END_ELEMENT, or ENTITY_REFERENCE Returns:String the localName

getLocalName

back to summary

public String getLocalName()

Implements javax.xml.stream.XMLStreamReader.getLocalName.

Doc from javax.xml.stream.XMLStreamReader.getLocalName.

Returns the (local) name of the current event. For START_ELEMENT or END_ELEMENT returns the (local) name of the current element. For ENTITY_REFERENCE it returns entity name. The current event must be START_ELEMENT or END_ELEMENT, or ENTITY_REFERENCE

Returns:String: the localName

getLocation	back to summary
public Location getLocation() Implements javax.xml.stream.XMLStreamReader.getLocation. Return the current location of the processor. If the Location is unknown the processor should return an implementation of Location that returns -1 for the location and null for the publicId and systemId. The location information is only valid until next() is called. Returns:Location Doc from javax.xml.stream.XMLStreamReader.getLocation. the location of the cursor

getLocation

back to summary

public Location getLocation()

Implements javax.xml.stream.XMLStreamReader.getLocation.

Return the current location of the processor. If the Location is unknown the processor should return an implementation of Location that returns -1 for the location and null for the publicId and systemId. The location information is only valid until next() is called.

Returns:Location

Doc from javax.xml.stream.XMLStreamReader.getLocation.

the location of the cursor

getName	back to summary
public QName getName() Implements javax.xml.stream.XMLStreamReader.getName. Returns a QName for the current START_ELEMENT or END_ELEMENT event Returns:QName the QName for the current START_ELEMENT or END_ELEMENT event

getName

back to summary

public QName getName()

Implements javax.xml.stream.XMLStreamReader.getName.

Returns a QName for the current START_ELEMENT or END_ELEMENT event

Returns:QName: the QName for the current START_ELEMENT or END_ELEMENT event

getNamespaceContext	back to summary
public NamespaceContext getNamespaceContext() Implements javax.xml.stream.XMLStreamReader.getNamespaceContext. Returns a read only namespace context for the current position. The context is transient and only valid until a call to next() changes the state of the reader. Returns:NamespaceContext return a namespace context

getNamespaceContext

back to summary

public NamespaceContext getNamespaceContext()

Implements javax.xml.stream.XMLStreamReader.getNamespaceContext.

Returns a read only namespace context for the current position. The context is transient and only valid until a call to next() changes the state of the reader.

Returns:NamespaceContext: return a namespace context

getNamespaceCount

back to summary

public int getNamespaceCount()

Implements javax.xml.stream.XMLStreamReader.getNamespaceCount.

Returns the count of namespaces declared on this START_ELEMENT or END_ELEMENT, this method is only valid on a START_ELEMENT, END_ELEMENT or NAMESPACE. On an END_ELEMENT the count is of the namespaces that are about to go out of scope. This is the equivalent of the information reported by SAX callback for an end element event.

Returns:int

returns the number of namespace declarations on this specific element

Exceptions

IllegalStateException:: if this is not a START_ELEMENT, END_ELEMENT or NAMESPACE

getNamespacePrefix

back to summary

public String getNamespacePrefix(int index)

Implements javax.xml.stream.XMLStreamReader.getNamespacePrefix.

Returns the prefix for the namespace declared at the index. Returns null if this is the default namespace declaration

Parameters

index:int: the position of the namespace declaration

Returns:String

returns the namespace prefix

Exceptions

IllegalStateException:: if this is not a START_ELEMENT, END_ELEMENT or NAMESPACE

getNamespaceURI

back to summary

public String getNamespaceURI()

Implements javax.xml.stream.XMLStreamReader.getNamespaceURI.

Doc from javax.xml.stream.XMLStreamReader.getNamespaceURI.

If the current event is a START_ELEMENT or END_ELEMENT this method returns the URI of the prefix or the default namespace. Returns null if the event does not have a prefix.

getNamespaceURI

back to summary

public String getNamespaceURI(int index)

Implements javax.xml.stream.XMLStreamReader.getNamespaceURI.

Returns the uri for the namespace declared at the index.

Parameters

index:int: the position of the namespace declaration

Returns:String

returns the namespace uri

Exceptions

IllegalStateException:: if this is not a START_ELEMENT, END_ELEMENT or NAMESPACE

getNamespaceURI

back to summary

public String getNamespaceURI(String prefix)

Implements javax.xml.stream.XMLStreamReader.getNamespaceURI.

Return the uri for the given prefix. The uri returned depends on the current state of the processor.

Note

The 'xml' prefix is bound as defined in Namespaces in XML specification to "http://www.w3.org/XML/1998/namespace".

Note

The 'xmlns' prefix must be resolved to following namespace http://www.w3.org/2000/xmlns/

Parameters

prefix:String: The prefix to lookup, may not be null

Returns:String

the uri bound to the given prefix or null if it is not bound

Exceptions

IllegalStateException:: - if the prefix is null

getNotationDecls	back to summary
protected List<NotationDeclaration> getNotationDecls()

getPIData

back to summary

public String getPIData()

Implements javax.xml.stream.XMLStreamReader.getPIData.

Get the data section of a processing instruction

Returns:String: the data or null

getPITarget

back to summary

public String getPITarget()

Implements javax.xml.stream.XMLStreamReader.getPITarget.

Get the target of a processing instruction

Returns:String: the target or null

getPrefix

back to summary

public String getPrefix()

Implements javax.xml.stream.XMLStreamReader.getPrefix.

Doc from javax.xml.stream.XMLStreamReader.getPrefix.

Returns the prefix of the current event or null if the event does not have a prefix

Returns:String: the prefix of the current event, or null if the event does not have a prefix. For START_ELEMENT and END_ELEMENT, return XMLConstants.DEFAULT_NS_PREFIX when no prefix is available.

getProperty

back to summary

public Object getProperty(String name) throws IllegalArgumentException

Implements javax.xml.stream.XMLStreamReader.getProperty.

Get the value of a feature/property from the underlying implementation

Parameters

name:String: The name of the property, may not be null

Returns:Object

The value of the property

Exceptions

IllegalArgumentException:: if name is null

getPropertyManager	back to summary
protected PropertyManager getPropertyManager() Returns:PropertyManager returns the reference to property manager.

getScanner	back to summary
public XMLDocumentScannerImpl getScanner()

getText

back to summary

public String getText()

Implements javax.xml.stream.XMLStreamReader.getText.

Returns:String

the current text or null

Exceptions

IllegalStateException:: if this state is not a valid text state.

getTextCharacters

back to summary

public char[] getTextCharacters()

Implements javax.xml.stream.XMLStreamReader.getTextCharacters.

Doc from javax.xml.stream.XMLStreamReader.getTextCharacters.

Returns an array which contains the characters from this event. This array should be treated as read-only and transient. I.e. the array will contain the text characters until the XMLStreamReader moves on to the next event. Attempts to hold onto the character array beyond that time or modify the contents of the array are breaches of the contract for this interface.

getTextCharacters back to summary

public int getTextCharacters(int sourceStart, char[] target, int targetStart, int length) throws XMLStreamException

Implements javax.xml.stream.XMLStreamReader.getTextCharacters.

Gets the the text associated with a CHARACTERS, SPACE or CDATA event. Text starting a "sourceStart" is copied into "destination" starting at "targetStart". Up to "length" characters are copied. The number of characters actually copied is returned. The "sourceStart" argument must be greater or equal to 0 and less than or equal to the number of characters associated with the event. Usually, one requests text starting at a "sourceStart" of 0. If the number of characters actually copied is less than the "length", then there is no more text. Otherwise, subsequent calls need to be made until all text has been retrieved. For example: int length = 1024; char[] myBuffer = new char[ length ]; for ( int sourceStart = 0 ; ; sourceStart += length ) { int nCopied = stream.getTextCharacters( sourceStart, myBuffer, 0, length ); if (nCopied < length) break; } XMLStreamException may be thrown if there are any XML errors in the underlying source. The "targetStart" argument must be greater than or equal to 0 and less than the length of "target", Length must be greater than 0 and "targetStart + length" must be less than or equal to length of "target".

Parameters

sourceStart:int: the index of the first character in the source array to copy
target:char[]: the destination array
targetStart:int: the start offset in the target array
length:int: the number of characters to copy

Returns:int

the number of characters actually copied

Exceptions

XMLStreamException:

if the underlying XML source is not well-formed

IndexOutOfBoundsException:

if targetStart < 0 or > than the length of target
if length < 0 or targetStart + length > length of target

UnsupportedOperationException:

if this method is not supported

NullPointerException:

is if target is null

getTextLength

back to summary

public int getTextLength()

Implements javax.xml.stream.XMLStreamReader.getTextLength.

Doc from javax.xml.stream.XMLStreamReader.getTextLength.

Returns the length of the sequence of characters for this Text event within the text character array.

getTextStart

back to summary

public int getTextStart()

Implements javax.xml.stream.XMLStreamReader.getTextStart.

Doc from javax.xml.stream.XMLStreamReader.getTextStart.

Returns the offset into the text character array where the first character (of this text event) is stored.

getValue	back to summary
public String getValue()

getVersion

back to summary

public String getVersion()

Implements javax.xml.stream.XMLStreamReader.getVersion.

Get the XML language version of the current document being parsed

Returns:String

Doc from javax.xml.stream.XMLStreamReader.getVersion.

the XML version or null

hasAttributes	back to summary
public boolean hasAttributes()

hasName

back to summary

public boolean hasName()

Implements javax.xml.stream.XMLStreamReader.hasName.

this Funtion returns true if the current event has name

Returns:boolean

Doc from javax.xml.stream.XMLStreamReader.hasName.

true if the event has a name, false otherwise

hasNext

back to summary

public boolean hasNext() throws XMLStreamException

Implements javax.xml.stream.XMLStreamReader.hasNext.

Doc from javax.xml.stream.XMLStreamReader.hasNext.

Returns true if there are more parsing events and false if there are no more events. This method will return false if the current state of the XMLStreamReader is END_DOCUMENT

Exceptions

XMLStreamException:: if there is a fatal error detecting the next state

hasText

back to summary

public boolean hasText()

Implements javax.xml.stream.XMLStreamReader.hasText.

Return true if the current event has text, false otherwise The following events have text: CHARACTERS,DTD ,ENTITY_REFERENCE, COMMENT

Returns:boolean

Doc from javax.xml.stream.XMLStreamReader.hasText.

true if the event has text, false otherwise

hasValue	back to summary
public boolean hasValue()

init	back to summary
pack-priv final void init(PropertyManager propertyManager) throws XMLStreamException

isAttributeSpecified

back to summary

public boolean isAttributeSpecified(int index)

Implements javax.xml.stream.XMLStreamReader.isAttributeSpecified.

Returns a boolean which indicates if this attribute was created by default

Parameters

index:int: the position of the attribute

Returns:boolean

true if this is a default attribute

Exceptions

IllegalStateException:: if this is not a START_ELEMENT or ATTRIBUTE

isCharacters

back to summary

public boolean isCharacters()

Implements javax.xml.stream.XMLStreamReader.isCharacters.

Returns true if the cursor points to a character data event

Returns:boolean: true if the cursor points to character data, false otherwise

isEndElement

back to summary

public boolean isEndElement()

Implements javax.xml.stream.XMLStreamReader.isEndElement.

Doc from javax.xml.stream.XMLStreamReader.isEndElement.

Returns true if the cursor points to an end tag (otherwise false)

isStandalone

back to summary

public boolean isStandalone()

Implements javax.xml.stream.XMLStreamReader.isStandalone.

Doc from javax.xml.stream.XMLStreamReader.isStandalone.

Get the standalone declaration from the xml declaration

isStartElement

back to summary

public boolean isStartElement()

Implements javax.xml.stream.XMLStreamReader.isStartElement.

Doc from javax.xml.stream.XMLStreamReader.isStartElement.

Returns true if the cursor points to a start tag (otherwise false)

isWhiteSpace

back to summary

public boolean isWhiteSpace()

Implements javax.xml.stream.XMLStreamReader.isWhiteSpace.

Returns true if the cursor points to a character data event that consists of all whitespace Application calling this method needs to cache the value and avoid calling this method again for the same event.

next back to summary

public int next() throws XMLStreamException

Implements javax.xml.stream.XMLStreamReader.next.

Doc from javax.xml.stream.XMLStreamReader.next.

Get next parsing event - a processor may return all contiguous character data in a single chunk, or it may split it into several chunks. If the property javax.xml.stream.isCoalescing is set to true element content must be coalesced and only one CHARACTERS event must be returned for contiguous element content or CDATA Sections. By default entity references must be expanded and reported transparently to the application. An exception will be thrown if an entity reference cannot be expanded. If element content is empty (i.e. content is "") then no CHARACTERS event will be reported.

Given the following XML:
<foo>content text<![CDATA[<greeting>Hello>/greeting>]]>other content>/foo>
The behavior of calling next() when being on foo will be:
1- the comment (COMMENT)
2- then the characters section (CHARACTERS)
3- then the CDATA section (another CHARACTERS)
4- then the next characters section (another CHARACTERS)
5- then the END_ELEMENT

Note

empty element (such as <tag/>) will be reported with two separate events: START_ELEMENT, END_ELEMENT - This preserves parsing equivalency of empty element to <tag></tag>.

Exceptions

XMLStreamException:: if there is an error processing the underlying XML source

nextTag

back to summary

public int nextTag() throws XMLStreamException

Implements javax.xml.stream.XMLStreamReader.nextTag.

Skips any insignificant events (COMMENT and PROCESSING_INSTRUCTION) until a START_ELEMENT or END_ELEMENT is reached. If other than space characters are encountered, an exception is thrown. This method should be used when processing element-only content because the parser is not able to recognize ignorable whitespace if then DTD is missing or not interpreted.

Returns:int

the event type of the element read

Exceptions

XMLStreamException:: if the current event is not white space

pr	back to summary
pack-priv static void pr(String str)

require

back to summary

public void require(int type, String namespaceURI, String localName) throws XMLStreamException

Implements javax.xml.stream.XMLStreamReader.require.

Test if the current event is of the given type and if the namespace and name match the current namespace and name of the current event. If the namespaceURI is null it is not checked for equality, if the localName is null it is not checked for equality.

Parameters

type:int: the event type
namespaceURI:String: the uri of the event, may be null
localName:String: the localName of the event, may be null

Exceptions

XMLStreamException:: if the required values are not matched.

reset	back to summary
public void reset() Resets this instance so that this instance is ready for reuse.

setInputSource	back to summary
public final void setInputSource(XMLInputSource inputSource) throws XMLStreamException

setPropertyManager	back to summary
protected void setPropertyManager(PropertyManager propertyManager)

standaloneSet

back to summary

public boolean standaloneSet()

Implements javax.xml.stream.XMLStreamReader.standaloneSet.

Checks if standalone was set in the document

Returns:boolean: true if standalone was set in the document, or false otherwise

switchToXML11Scanner	back to summary
private void switchToXML11Scanner() throws IOException

public Class XMLStreamReaderImpl

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail