XMLStreamReader JDK 1.6)

Valid methods for each state
Event Type	Valid Methods
All States	getProperty(), hasNext(), require(), close(), getNamespaceURI(), isStartElement(), isEndElement(), isCharacters(), isWhiteSpace(), getNamespaceContext(), getEventType(),getLocation(), hasText(), hasName()
START_ELEMENT	next(), getName(), getLocalName(), hasName(), getPrefix(), getAttributeXXX(), isAttributeSpecified(), getNamespaceXXX(), getElementText(), nextTag()
ATTRIBUTE	next(), nextTag() getAttributeXXX(), isAttributeSpecified(),
NAMESPACE	next(), nextTag() getNamespaceXXX()
END_ELEMENT	next(), getName(), getLocalName(), hasName(), getPrefix(), getNamespaceXXX(), nextTag()
CHARACTERS	next(), getTextXXX(), nextTag()
CDATA	next(), getTextXXX(), nextTag()
COMMENT	next(), getTextXXX(), nextTag()
SPACE	next(), getTextXXX(), nextTag()
START_DOCUMENT	next(), getEncoding(), getVersion(), isStandalone(), standaloneSet(), getCharacterEncodingScheme(), nextTag()
END_DOCUMENT	close()
PROCESSING_INSTRUCTION	next(), getPITarget(), getPIData(), nextTag()
ENTITY_REFERENCE	next(), getLocalName(), getText(), nextTag()
DTD	next(), getText(), nextTag()

Hide/Show inherited methods

public void close () throws XMLStreamException

Frees any resources associated with this Reader.

public int 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)

Returns the localName of the attribute at the provided index

public QName getAttributeName (int index)

Returns the qname of the attribute at the provided index

public String getAttributeNamespace (int index)

Returns the namespace of the attribute at the provided index

public String getAttributePrefix (int index)

Returns the prefix of this attribute at the provided index

public String getAttributeType (int index)

Returns the XML type of the attribute at the provided index

public String getAttributeValue (int index)

Returns the value of the attribute at the index

public String getAttributeValue (String namespaceURI, String localName)

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

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

public String getElementText () throws XMLStreamException

Reads the content of a text-only element, an exception is thrown if this is not a text-only element.

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.

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

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

public String getEncoding ()

Return input encoding if known or null if unknown.

public int getEventType ()

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

public String getLocalName ()

Returns the (local) name of the current event.

public Location getLocation ()

Return the current location of the processor.

public QName getName ()

Returns a QName for the current START_ELEMENT or END_ELEMENT event

public NamespaceContext getNamespaceContext ()

Returns a read only namespace context for the current position.

public int 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 getNamespacePrefix (int index)

Returns the prefix for the namespace declared at the index.

public String 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 getNamespaceURI (int index)

Returns the uri for the namespace declared at the index.

public String getNamespaceURI (String prefix)

Return the uri for the given prefix.

public String getPIData ()

Get the data section of a processing instruction

public String getPITarget ()

Get the target of a processing instruction

public String getPrefix ()

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

public Object getProperty (String name) throws IllegalArgumentException

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

public String 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, 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.

public char getTextCharacters ()

Returns an array which contains the characters from this event.

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

Gets the the text associated with a CHARACTERS, SPACE or CDATA event.

Gets the 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;
 }

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".
Returns: the number of characters actually copied
Parameters:
- sourceStart - the index of the first character in the source array to copy
- target - the destination array
- targetStart - the start offset in the target array
- length - the number of characters to copy
Throws:
- XMLStreamException - if the underlying XML source is not well-formed
- IndexOutOfBoundsException - if targetStart < 0 or > than the length of target
- IndexOutOfBoundsException - if length < 0 or targetStart + length > length of target
- UnsupportedOperationException - if this method is not supported
- NullPointerException - is if target is null

public int getTextLength ()

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

public int getTextStart ()

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

public String getVersion ()

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

public boolean hasName ()

returns true if the current event has a name (is a START_ELEMENT or END_ELEMENT) returns false otherwise

public boolean hasNext () throws XMLStreamException

Returns true if there are more parsing events and false if there are no more events.

public boolean hasText ()

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

public boolean isAttributeSpecified (int index)

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

public boolean isCharacters ()

Returns true if the cursor points to a character data event

public boolean isEndElement ()

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

public boolean isStandalone ()

Get the standalone declaration from the xml declaration

public boolean isStartElement ()

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

public boolean isWhiteSpace ()

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

public int next () throws XMLStreamException

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 nextTag () throws XMLStreamException

Skips any white space (isWhiteSpace() returns true), COMMENT, or PROCESSING_INSTRUCTION, until a START_ELEMENT or END_ELEMENT is reached.

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 seperated 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()) // 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: the event type of the element read (START_ELEMENT or END_ELEMENT)
Throws:
- 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

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

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 boolean standaloneSet ()

Checks if standalone was set in the document