public Interface XMLStreamReader

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

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

Returns the localName of the attribute at the provided index

Parameters

index:int

the position of the attribute

Returns:String

the localName of the attribute

Exceptions

IllegalStateException:

if this is not a START_ELEMENT or ATTRIBUTE

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

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

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

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

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

Parameters

namespaceURI:String

the namespace of the attribute

localName:String

the local name of the attribute, cannot be null

Returns:String

returns the value of the attribute , returns null if not found

Exceptions

IllegalStateException:

if this is not a START_ELEMENT or ATTRIBUTE

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

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

Reads the content of a text-only element, an exception is thrown if this is not a text-only element. Regardless of value of javax.xml.stream.isCoalescing this method always returns coalesced content.

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();

Returns:String

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

Return input encoding if known or null if unknown.

Returns:String

the encoding of this instance or null

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

Returns:int

the type of the current event

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

Exceptions

IllegalStateException:

if this not a START_ELEMENT, END_ELEMENT or ENTITY_REFERENCE

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

the location of the cursor

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

Exceptions

IllegalStateException:

if this is not a START_ELEMENT or END_ELEMENT

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

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

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

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

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

IllegalArgumentException:

if the prefix is null

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

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.

Returns:String

the URI bound to this elements prefix, the default namespace, or null

Get the data section of a processing instruction

Returns:String

the data or null

Get the target of a processing instruction

Returns:String

the target or null

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

Returns:String

the prefix or null

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

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:String

the current text or null

Exceptions

IllegalStateException:

if this state is not a valid text state.

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.

Returns:char[]

the current text or an empty array

Exceptions

IllegalStateException:

if this state is not a valid text state.

Gets the text associated with a CHARACTERS, SPACE or CDATA event. Text starting a "sourceStart" is copied into "target" 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;
}
 

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

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

Returns:int

the length of the text

Exceptions

IllegalStateException:

if this state is not a valid text state.

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

Returns:int

the starting position of the text in the character array

Exceptions

IllegalStateException:

if this state is not a valid text state.

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

Returns:String

the XML version or null

returns a boolean indicating whether the current event has a name (is a START_ELEMENT or END_ELEMENT).

Returns:boolean

true if the event has a name, false otherwise

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

Returns:boolean

true if there are more events, false otherwise

Exceptions

XMLStreamException:

if there is a fatal error detecting the next state

Return a boolean indicating whether the current event has text. The following events have text: CHARACTERS,DTD ,ENTITY_REFERENCE, COMMENT, SPACE

Returns:boolean

true if the event has text, false otherwise

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

Returns true if the cursor points to a character data event

Returns:boolean

true if the cursor points to character data, false otherwise

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

Returns:boolean

true if the cursor points to an end tag, false otherwise

Get the standalone declaration from the xml declaration

Returns:boolean

true if this is standalone, or false otherwise

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

Returns:boolean

true if the cursor points to a start tag, false otherwise

Returns true if the cursor points to a character data event that consists of all whitespace

Returns:boolean

true if the cursor points to all whitespace, false otherwise

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

Returns:int

the integer code corresponding to the current parse event

Exceptions

XMLStreamException:

if there is an error processing the underlying XML source

NoSuchElementException:

if this is called when hasNext() returns false

See Also

javax.xml.stream.events.XMLEvent

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.

 int eventType = next();
while((eventType == XMLStreamConstants.CHARACTERS && isWhiteSpace()) // skip whitespace
|| (eventType == XMLStreamConstants.CDATA && isWhiteSpace())
// skip whitespace
|| 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; 

Returns:int

the event type of the element read (START_ELEMENT or END_ELEMENT)

Exceptions

XMLStreamException:

if the current event is not white space, PROCESSING_INSTRUCTION, START_ELEMENT or END_ELEMENT

NoSuchElementException:

if this is called when hasNext() returns false

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.

Checks if standalone was set in the document

Returns:boolean

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