Constructs the stream readon on behalf of the reader.

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

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 the localName of the attribute at the provided index.

Returns the namespace of the attribute at the provided index.

Returns the prefix of this attribute at the provided index.

Returns the XML type of the attribute at the provided index.

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

Returns the value of the attribute at the index.

Returns the character encoding declared on the XML declaration Returns null if none was declared.

Returns the column number where the current event ends or -1 if none is available.

Reads the content of a text-only element, an exception is thrown if this is not a text-only element. This method always returns coalesced content.
Precondition: the current event is START_ELEMENT.
Postcondition: the current event is the corresponding END_ELEMENT.
The method does the following (implementations are free to be optimized but must do equivalent processing):

 if ( getEventType() != XMLStreamConstants.START_ELEMENT )
 {
     throw new XMLStreamException( "parser must be on START_ELEMENT to read next text", getLocation() );
 }
 int eventType = next();
 StringBuffer content = new StringBuffer();
 while ( eventType != XMLStreamConstants.END_ELEMENT )
 {
     if ( eventType == XMLStreamConstants.CHARACTERS || eventType == XMLStreamConstants.CDATA
         || eventType == XMLStreamConstants.SPACE || eventType == XMLStreamConstants.ENTITY_REFERENCE )
     {
         buf.append( getText() );
     }
     else if ( eventType == XMLStreamConstants.PROCESSING_INSTRUCTION || eventType == XMLStreamConstants.COMMENT )
     {
         // skipping
     }
     else if ( eventType == XMLStreamConstants.END_DOCUMENT )
     {
         throw new XMLStreamException( "unexpected end of document when reading element text content", this );
     }
     else if ( eventType == XMLStreamConstants.START_ELEMENT )
     {
         throw new XMLStreamException( "element text content may not contain START_ELEMENT", getLocation() );
     }
     else
     {
         throw new XMLStreamException( "Unexpected event type " + eventType, getLocation() );
     }
     eventType = next();
 }
 return buf.toString();
 

Return input encoding if known or null if unknown.

Returns an integer code that indicates the type of the event the cursor is pointing to.

Returns the line number where the current event ends or -1 if none is available.

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 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 the prefix for the namespace declared at the index. Returns null if this is the default namespace declaration.

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/

Returns the uri for the namespace declared at the index.

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.

Get the data section of a processing instruction.

Get the target of a processing instruction.

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

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 the length of the sequence of characters for this Text event within the text character array.

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

Get the xml version declared on the xml declaration. Returns null if none was declared.

Reads a sub-tree of the XML document and parses it as XML object.

The stream must be positioned on a START_ELEMENT. Do not call the method when the stream is positioned at document's root element. This would cause the whole document to be parsed into a single XML what may lead to an out-of-memory condition. Instead use #next() to navigate to sub-elements and invoke getXMLObject() there. Do not keep references to more than the currently processed XML to keep memory consumption low. The method reads the stream up to the matching END_ELEMENT. When the method returns the current event is the END_ELEMENT event.

Identifies if the current event has a name (is a START_ELEMENT or END_ELEMENT)

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

Indicates if the current event has text. The following events have text: CHARACTERS,DTD ,ENTITY_REFERENCE, COMMENT, SPACE.

Identifies if this attribute was created by default.

Identifies if the cursor points to a character data event.

Identifies if the cursor points to an end tag.

Get the standalone declaration from the xml declaration.

Identifies if the cursor points to a start tag.

Identifies if the cursor points to a character data event that consists of all whitespace.

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><!--description-->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>. This method will throw an IllegalStateException if it is called after hasNext() returns false.

Skips any white space (isWhiteSpace() returns true), COMMENT, or PROCESSING_INSTRUCTION, until a START_ELEMENT or END_ELEMENT is reached. If other than white space characters, COMMENT, PROCESSING_INSTRUCTION, START_ELEMENT, END_ELEMENT are encountered, an exception is thrown. This method should be used when processing element-only content separated by white space.
Precondition: none
Postcondition: the current event is START_ELEMENT or END_ELEMENT and cursor may have moved over any whitespace event.
Essentially it does the following (implementations are free to optimized but must do equivalent processing):

 int eventType = next();
 while ( (eventType == XMLStreamConstants.CHARACTERS && isWhiteSpace() )
       || (eventType == XMLStreamConstants.CDATA && isWhiteSpace())
       || eventType == XMLStreamConstants.SPACE
       || eventType == XMLStreamConstants.PROCESSING_INSTRUCTION
       || eventType == XMLStreamConstants.COMMENT )
 {
     eventType = next();
 }
 if ( eventType != XMLStreamConstants.START_ELEMENT && eventType != XMLStreamConstants.END_ELEMENT )
 {
     throw new String XMLStreamException( "expected start or end tag", getLocation() );
 }
 return eventType;
 

Reads the content of a text-only element, an exception is thrown if this is not a text-only element. This method always returns coalesced content.
Precondition: the current event is START_ELEMENT.
Postcondition: the current event is the corresponding END_ELEMENT.
The method does the following (implementations are free to be optimized but must do equivalent processing):

 if ( getEventType() != XMLStreamConstants.START_ELEMENT )
 {
     throw new XMLStreamException( "parser must be on START_ELEMENT to read next text", getLocation() );
 }
 int eventType = next();
 StringBuffer content = new StringBuffer();
 while ( eventType != XMLStreamConstants.END_ELEMENT )
 {
     if ( eventType == XMLStreamConstants.CHARACTERS || eventType == XMLStreamConstants.CDATA
         || eventType == XMLStreamConstants.SPACE || eventType == XMLStreamConstants.ENTITY_REFERENCE )
     {
         buf.append( getText() );
     }
     else if ( eventType == XMLStreamConstants.PROCESSING_INSTRUCTION || eventType == XMLStreamConstants.COMMENT )
     {
         // skipping
     }
     else if ( eventType == XMLStreamConstants.END_DOCUMENT )
     {
         throw new XMLStreamException( "unexpected end of document when reading element text content", this );
     }
     else if ( eventType == XMLStreamConstants.START_ELEMENT )
     {
         throw new XMLStreamException( "element text content may not contain START_ELEMENT", getLocation() );
     }
     else
     {
         throw new XMLStreamException( "Unexpected event type " + eventType, getLocation() );
     }
     eventType = next();
 }
 return buf.toString();
 

Reads a sub-tree of the XML document and parses it as XML object.

The stream must be positioned on a START_ELEMENT. Do not call the method when the stream is positioned at document's root element. This would cause the whole document to be parsed into a single XML what may lead to an out-of-memory condition. Instead use #next() to navigate to sub-elements and invoke getXMLObject() there. Do not keep references to more than the currently processed XML to keep memory consumption low. The method reads the stream up to the matching END_ELEMENT. When the method returns the current event is the END_ELEMENT event.

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.

Identifies if standalone was set in the document.