Inheritance diagram for javolution.xml.stream.XMLStreamReader:

Collaboration diagram for javolution.xml.stream.XMLStreamReader:

Public Member Functions
Object	getProperty (String name) throws IllegalArgumentException

int	next () throws XMLStreamException

void	require (int type, CharSequence namespaceURI, CharSequence localName) throws XMLStreamException

CharArray	getElementText () throws XMLStreamException

int	nextTag () throws XMLStreamException

boolean	hasNext () throws XMLStreamException

void	close () throws XMLStreamException

CharArray	getNamespaceURI (CharSequence prefix)

boolean	isStartElement ()

boolean	isEndElement ()

boolean	isCharacters ()

boolean	isWhiteSpace ()

CharArray	getAttributeValue (CharSequence namespaceURI, CharSequence localName)

int	getAttributeCount ()

CharArray	getAttributeNamespace (int index)

CharArray	getAttributeLocalName (int index)

CharArray	getAttributePrefix (int index)

CharArray	getAttributeType (int index)

CharArray	getAttributeValue (int index)

boolean	isAttributeSpecified (int index)

int	getNamespaceCount ()

CharArray	getNamespacePrefix (int index)

CharArray	getNamespaceURI (int index)

NamespaceContext	getNamespaceContext ()

int	getEventType ()

CharArray	getText ()

char[]	getTextCharacters ()

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

int	getTextStart ()

int	getTextLength ()

String	getEncoding ()

boolean	hasText ()

Location	getLocation ()

CharArray	getLocalName ()

boolean	hasName ()

CharArray	getNamespaceURI ()

CharArray	getPrefix ()

CharArray	getVersion ()

boolean	isStandalone ()

boolean	standaloneSet ()

CharArray	getCharacterEncodingScheme ()

CharArray	getPITarget ()

CharArray	getPIData ()

Static Public Attributes
static final int	START_ELEMENT = 1

static final int	END_ELEMENT = 2

static final int	PROCESSING_INSTRUCTION = 3

static final int	CHARACTERS = 4

static final int	COMMENT = 5

static final int	SPACE = 6

static final int	START_DOCUMENT = 7

static final int	END_DOCUMENT = 8

static final int	ENTITY_REFERENCE = 9

static final int	ATTRIBUTE = 10

static final int	DTD = 11

static final int	CDATA = 12

static final int	NAMESPACE = 13

static final int	NOTATION_DECLARATION = 14

static final int	ENTITY_DECLARATION = 15

Detailed Description

This interface is similar to javax.xml.stream.XMLStreamReader; but it does not forces dynamic allocation when parsing (its methods returns CharArray instances instead of String).

Except for the speed (faster) and its real-time characteristics
the usage/behavior is about the same as its StAX counterpart.

The CharArray instances returned by this reader supports fast primitive conversions as illustrated below. [code] // Creates a new reader (potentially recycled). XMLInputFactory factory = OSGiServices.getXMLInputFactory(); XMLStreamReader reader = factory.createXMLStreamReader(inputStream);

while (reader.getEventType() != XMLStreamConstants.END_DOCUMENT) { switch (reader.next()) { case XMLStreamConstants.START_ELEMENT: if (reader.getLocalName().equals("Time")) { // Reads primitive types (int) attributes directly (no memory allocation). time.hour = reader.getAttributeValue(null, "hour").toInt(); time.minute = reader.getAttributeValue(null, "minute").toInt(); time.second = reader.getAttributeValue(null, "second").toInt(); } ... break; }
} reader.close(); // Close the reader (does not close underlying input stream). [/code]

Author: Jean-Marie Dautelle

Version: 6.0 December 12, 2012

Definition at line 50 of file XMLStreamReader.java.

Member Function Documentation

◆ close()

void javolution.xml.stream.XMLStreamReader.close ( ) throws XMLStreamException

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

Implemented in javolution.xml.internal.stream.XMLStreamReaderImpl.

◆ getAttributeCount()

int javolution.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: returns the number of attributes.

Exceptions

IllegalStateException if not a START_ELEMENT or ATTRIBUTE.

Implemented in javolution.xml.internal.stream.XMLStreamReaderImpl.

Referenced by javolution.xml.ws.WebServiceClient.readResponse().

Here is the caller graph for this function:

◆ getAttributeLocalName()

CharArray javolution.xml.stream.XMLStreamReader.getAttributeLocalName ( int index )

Returns the localName of the attribute at the provided index.

Parameters

index the position of the attribute.

Returns: the localName of the attribute.

Exceptions

IllegalStateException if not a START_ELEMENT or ATTRIBUTE.

Implemented in javolution.xml.internal.stream.XMLStreamReaderImpl.

Referenced by javolution.xml.ws.WebServiceClient.readResponse().

Here is the caller graph for this function:

◆ getAttributeNamespace()

CharArray javolution.xml.stream.XMLStreamReader.getAttributeNamespace ( int index )

Returns the namespace of the attribute at the provided index

Parameters

index the position of the attribute.

Returns: the namespace URI or null if no prefix.

Exceptions

IllegalStateException if not a START_ELEMENT or ATTRIBUTE.

Implemented in javolution.xml.internal.stream.XMLStreamReaderImpl.

Referenced by javolution.xml.ws.WebServiceClient.readResponse().

Here is the caller graph for this function:

◆ getAttributePrefix()

CharArray javolution.xml.stream.XMLStreamReader.getAttributePrefix ( int index )

Returns the prefix of this attribute at the provided index

Parameters

index the position of the attribute.

Returns: the prefix of the attribute or null if no prefix.

Exceptions

IllegalStateException if not a START_ELEMENT or ATTRIBUTE.

Implemented in javolution.xml.internal.stream.XMLStreamReaderImpl.

◆ getAttributeType()

CharArray javolution.xml.stream.XMLStreamReader.getAttributeType ( int index )

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

Parameters

index the position of the attribute

Returns: the XML type of the attribute.

Exceptions

IllegalStateException if not a START_ELEMENT or ATTRIBUTE.

Implemented in javolution.xml.internal.stream.XMLStreamReaderImpl.

◆ getAttributeValue() [1/2]

CharArray javolution.xml.stream.XMLStreamReader.getAttributeValue	(	CharSequence	namespaceURI,
		CharSequence	localName
	)

Returns the normalized attribute value of the attribute with the namespace and localName.

Parameters

namespaceURI	the namespace of the attribute or `null`.
localName	the local name of the attribute.

Returns: returns the value of the attribute or null.

Exceptions

IllegalStateException if not a START_ELEMENT or ATTRIBUTE.

Implemented in javolution.xml.internal.stream.XMLStreamReaderImpl.

Referenced by javolution.xml.ws.WebServiceClient.readResponse().

Here is the caller graph for this function:

◆ getAttributeValue() [2/2]

CharArray javolution.xml.stream.XMLStreamReader.getAttributeValue ( int index )

Returns the value of the attribute at the index.

Parameters

index the position of the attribute.

Returns: the attribute value.

Exceptions

IllegalStateException if not a START_ELEMENT or ATTRIBUTE.

Implemented in javolution.xml.internal.stream.XMLStreamReaderImpl.

◆ getCharacterEncodingScheme()

CharArray javolution.xml.stream.XMLStreamReader.getCharacterEncodingScheme ( )

Returns the character encoding declared on the xml declaration.

Returns: the encoding declared in the document or null

Implemented in javolution.xml.internal.stream.XMLStreamReaderImpl.

◆ getElementText()

CharArray javolution.xml.stream.XMLStreamReader.getElementText ( ) throws XMLStreamException

Reads the content of a text-only element, an exception is thrown if this is not a text-only element. Regardless of the 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();

Exceptions

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

Implemented in javolution.xml.internal.stream.XMLStreamReaderImpl.

◆ getEncoding()

String javolution.xml.stream.XMLStreamReader.getEncoding ( )

Returns the input encoding if known or null if unknown.

Returns: the encoding of this instance or null.

Implemented in javolution.xml.internal.stream.XMLStreamReaderImpl.

◆ getEventType()

int javolution.xml.stream.XMLStreamReader.getEventType ( )

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

Returns: the event type.

Implemented in javolution.xml.internal.stream.XMLStreamReaderImpl.

◆ getLocalName()

CharArray javolution.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: the localName.

Exceptions

IllegalStateException if this not a START_ELEMENT, END_ELEMENT or ENTITY_REFERENCE

Implemented in javolution.xml.internal.stream.XMLStreamReaderImpl.

Referenced by javolution.xml.ws.WebServiceClient.invoke(), and javolution.xml.ws.WebServiceClient.readResponse().

Here is the caller graph for this function:

◆ getLocation()

Location javolution.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: the current location.

Implemented in javolution.xml.internal.stream.XMLStreamReaderImpl.

◆ getNamespaceContext()

NamespaceContext javolution.xml.stream.XMLStreamReader.getNamespaceContext ( )

Returns a read only namespace context for the current position.

Returns: return a namespace context

Implemented in javolution.xml.internal.stream.XMLStreamReaderImpl.

◆ getNamespaceCount()

int javolution.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: returns the number of namespace declarations on this specific element.

Exceptions

IllegalStateException if not a START_ELEMENT or END_ELEMENT.

Implemented in javolution.xml.internal.stream.XMLStreamReaderImpl.

◆ getNamespacePrefix()

CharArray javolution.xml.stream.XMLStreamReader.getNamespacePrefix ( int index )

Returns the prefix for the namespace declared at the index.

Parameters

index the position of the namespace declaration.

Returns: returns the namespace prefix or null if no prefix.

Exceptions

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

Implemented in javolution.xml.internal.stream.XMLStreamReaderImpl.

◆ getNamespaceURI() [1/3]

CharArray javolution.xml.stream.XMLStreamReader.getNamespaceURI ( )

If the current event is a START_ELEMENT or END_ELEMENT this method returns the URI of the current element (URI mapping to the prefix element/attribute has; or if no prefix null).

Returns: the URI bound to this elements prefix or null.

Exceptions

IllegalStateException if not a START_ELEMENT, END_ELEMENT or ATTRIBUTE.

Implemented in javolution.xml.internal.stream.XMLStreamReaderImpl.

◆ getNamespaceURI() [2/3]

CharArray javolution.xml.stream.XMLStreamReader.getNamespaceURI ( CharSequence prefix )

Returns 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 the prefix to lookup.

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

Implemented in javolution.xml.internal.stream.XMLStreamReaderImpl.

Referenced by javolution.xml.ws.WebServiceClient.invoke(), and javolution.xml.ws.WebServiceClient.readResponse().

Here is the caller graph for this function:

◆ getNamespaceURI() [3/3]

CharArray javolution.xml.stream.XMLStreamReader.getNamespaceURI ( int index )

Returns the URI for the namespace declared at the index.

Parameters

index the position of the namespace declaration.

Returns: returns the namespace uri or null if no prefix.

Exceptions

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

Implemented in javolution.xml.internal.stream.XMLStreamReaderImpl.

◆ getPIData()

CharArray javolution.xml.stream.XMLStreamReader.getPIData ( )

Get the data section of a processing instruction.

Returns: the data (if processing instruction has any) or null if the processing instruction only has target.

Exceptions

IllegalStateException if the current event is not a XMLStreamConstants#PROCESSING_INSTRUCTION

Implemented in javolution.xml.internal.stream.XMLStreamReaderImpl.

◆ getPITarget()

CharArray javolution.xml.stream.XMLStreamReader.getPITarget ( )

Returns the target of a processing instruction.

Returns: the target.

Exceptions

IllegalStateException if the current event is not a XMLStreamConstants#PROCESSING_INSTRUCTION

Implemented in javolution.xml.internal.stream.XMLStreamReaderImpl.

◆ getPrefix()

CharArray javolution.xml.stream.XMLStreamReader.getPrefix ( )

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

Returns: the prefix or null

Exceptions

IllegalStateException if not a START_ELEMENT or END_ELEMENT.

Implemented in javolution.xml.internal.stream.XMLStreamReaderImpl.

◆ getProperty()

Object javolution.xml.stream.XMLStreamReader.getProperty ( String name ) throws IllegalArgumentException

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

Parameters

name	the name of the property.

Returns: the value of the property.

Implemented in javolution.xml.internal.stream.XMLStreamReaderImpl.

◆ getText()

CharArray javolution.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, 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 current text or null

Exceptions

IllegalStateException if this state is not a valid text state.

Implemented in javolution.xml.internal.stream.XMLStreamReaderImpl.

Referenced by javolution.xml.ws.WebServiceClient.readResponse().

Here is the caller graph for this function:

◆ getTextCharacters() [1/2]

char [] javolution.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.

Returns: the current text or an empty array.

Exceptions

IllegalStateException if this state is not a valid text state.

Implemented in javolution.xml.internal.stream.XMLStreamReaderImpl.

◆ getTextCharacters() [2/2]

int javolution.xml.stream.XMLStreamReader.getTextCharacters	(	int	sourceStart,
		char[]	target,
		int	targetStart,
		int	length
	)		throws XMLStreamException

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".

Parameters

sourceStart	the index of te 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

Returns: the number of characters actually copied

Exceptions

XMLStreamException	if the 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.

Implemented in javolution.xml.internal.stream.XMLStreamReaderImpl.

◆ getTextLength()

int javolution.xml.stream.XMLStreamReader.getTextLength ( )

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

Exceptions

IllegalStateException if this state is not a valid text state.

Implemented in javolution.xml.internal.stream.XMLStreamReaderImpl.

◆ getTextStart()

int javolution.xml.stream.XMLStreamReader.getTextStart ( )

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

Exceptions

IllegalStateException if this state is not a valid text state.

Implemented in javolution.xml.internal.stream.XMLStreamReaderImpl.

◆ getVersion()

CharArray javolution.xml.stream.XMLStreamReader.getVersion ( )

Gets the xml version declared on the xml declaration.

Returns: the XML version or null

Implemented in javolution.xml.internal.stream.XMLStreamReaderImpl.

◆ hasName()

boolean javolution.xml.stream.XMLStreamReader.hasName ( )

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

Returns: true if the current event has a name; false otherwise.

Implemented in javolution.xml.internal.stream.XMLStreamReaderImpl.

◆ hasNext()

boolean javolution.xml.stream.XMLStreamReader.hasNext ( ) throws XMLStreamException

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: true if there are more events, false otherwise.

Exceptions

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

Implemented in javolution.xml.internal.stream.XMLStreamReaderImpl.

Referenced by javolution.xml.ws.WebServiceClient.invoke(), and javolution.xml.ws.WebServiceClient.readResponse().

Here is the caller graph for this function:

◆ hasText()

boolean javolution.xml.stream.XMLStreamReader.hasText ( )

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

Returns: true if the current event as text; false otherwise.

Implemented in javolution.xml.internal.stream.XMLStreamReaderImpl.

◆ isAttributeSpecified()

boolean javolution.xml.stream.XMLStreamReader.isAttributeSpecified ( int index )

Indicates if this attribute was created by default.

Parameters

index the position of the attribute.

Returns: true if this is a default attribute; false otherwise.

Exceptions

IllegalStateException if not a START_ELEMENT or ATTRIBUTE.

Implemented in javolution.xml.internal.stream.XMLStreamReaderImpl.

◆ isCharacters()

boolean javolution.xml.stream.XMLStreamReader.isCharacters ( )

Indicates if the cursor points to character data.

Returns: true if the cursor points to character data; false otherwise.

Implemented in javolution.xml.internal.stream.XMLStreamReaderImpl.

◆ isEndElement()

boolean javolution.xml.stream.XMLStreamReader.isEndElement ( )

Indicates if the cursor points to an end tag.

Returns: true if the cursor points to a end tag; false otherwise.

Implemented in javolution.xml.internal.stream.XMLStreamReaderImpl.

◆ isStandalone()

boolean javolution.xml.stream.XMLStreamReader.isStandalone ( )

Gets the standalone declaration from the xml declaration.

Returns: true if this is standalone; false otherwise.

Implemented in javolution.xml.internal.stream.XMLStreamReaderImpl.

◆ isStartElement()

boolean javolution.xml.stream.XMLStreamReader.isStartElement ( )

Indicates if the cursor points to a start tag.

Returns: true if the cursor points to a start tag; false otherwise.

Implemented in javolution.xml.internal.stream.XMLStreamReaderImpl.

◆ isWhiteSpace()

boolean javolution.xml.stream.XMLStreamReader.isWhiteSpace ( )

Indicates if the cursor points to character data that consists of all whitespace.

Returns: true if the cursor points to whitespaces; false otherwise.

Implemented in javolution.xml.internal.stream.XMLStreamReaderImpl.

◆ next()

int javolution.xml.stream.XMLStreamReader.next ( ) throws XMLStreamException

Gets next parsing event - contiguous character data is returned into a single chunk.

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.

Returns: the integer code corresponding to the current parse event

Exceptions

NoSuchElementException	if this is called when hasNext() returns false
XMLStreamException	if there is an error processing the underlying XML source

Implemented in javolution.xml.internal.stream.XMLStreamReaderImpl.

Referenced by javolution.xml.ws.WebServiceClient.invoke(), and javolution.xml.ws.WebServiceClient.readResponse().

Here is the caller graph for this function:

◆ nextTag()

int javolution.xml.stream.XMLStreamReader.nextTag ( ) throws XMLStreamException

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)

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

Implemented in javolution.xml.internal.stream.XMLStreamReaderImpl.

◆ require()

void javolution.xml.stream.XMLStreamReader.require	(	int	type,
		CharSequence	namespaceURI,
		CharSequence	localName
	)		throws XMLStreamException

Tests 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	the event type.
namespaceURI	the uri of the event, may be null.
localName	the localName of the event, may be null.

Exceptions

XMLStreamException if the required values are not matched.

Implemented in javolution.xml.internal.stream.XMLStreamReaderImpl.

◆ standaloneSet()

boolean javolution.xml.stream.XMLStreamReader.standaloneSet ( )

Checks if standalone was set in the document.

Returns: true if standalone was set; false otherwise.

Implemented in javolution.xml.internal.stream.XMLStreamReaderImpl.

Member Data Documentation

◆ ATTRIBUTE

final int javolution.xml.stream.XMLStreamConstants.ATTRIBUTE = 10

staticinherited

Indicates an event is an attribute.

Definition at line 71 of file XMLStreamConstants.java.

◆ CDATA

final int javolution.xml.stream.XMLStreamConstants.CDATA = 12

staticinherited

Indicates an event is a CDATA section.

Definition at line 81 of file XMLStreamConstants.java.

Referenced by javolution.xml.sax.XMLReaderImpl.parseAll(), and javolution.xml.ws.WebServiceClient.readResponse().

◆ CHARACTERS

final int javolution.xml.stream.XMLStreamConstants.CHARACTERS = 4

staticinherited

Indicates an event is characters.

Definition at line 39 of file XMLStreamConstants.java.

Referenced by javolution.xml.internal.stream.XMLStreamReaderImpl.getElementText(), javolution.xml.internal.stream.XMLStreamReaderImpl.getText(), javolution.xml.internal.stream.XMLStreamReaderImpl.hasText(), javolution.xml.internal.stream.XMLStreamReaderImpl.isCharacters(), javolution.xml.internal.stream.XMLStreamReaderImpl.isEndOfStream(), javolution.xml.internal.stream.XMLStreamReaderImpl.next(), javolution.xml.internal.stream.XMLStreamReaderImpl.nextTag(), javolution.xml.sax.XMLReaderImpl.parseAll(), and javolution.xml.ws.WebServiceClient.readResponse().

◆ COMMENT

final int javolution.xml.stream.XMLStreamConstants.COMMENT = 5

staticinherited

Indicates an event is a comment.

Definition at line 44 of file XMLStreamConstants.java.

Referenced by javolution.xml.internal.stream.XMLStreamReaderImpl.getElementText(), javolution.xml.internal.stream.XMLStreamReaderImpl.getText(), javolution.xml.internal.stream.XMLStreamReaderImpl.hasText(), javolution.xml.internal.stream.XMLStreamReaderImpl.next(), javolution.xml.internal.stream.XMLStreamReaderImpl.nextTag(), javolution.xml.sax.XMLReaderImpl.parseAll(), and javolution.xml.ws.WebServiceClient.readResponse().

◆ DTD

final int javolution.xml.stream.XMLStreamConstants.DTD = 11

staticinherited

Indicates an event is a DTD.

Definition at line 76 of file XMLStreamConstants.java.

Referenced by javolution.xml.internal.stream.XMLStreamReaderImpl.getText(), javolution.xml.internal.stream.XMLStreamReaderImpl.hasText(), javolution.xml.internal.stream.XMLStreamReaderImpl.next(), and javolution.xml.internal.stream.XMLStreamReaderImpl.nextTag().

◆ END_DOCUMENT

final int javolution.xml.stream.XMLStreamConstants.END_DOCUMENT = 8

staticinherited

Indicates an event is an end document.

Definition at line 61 of file XMLStreamConstants.java.

Referenced by javolution.xml.internal.stream.XMLStreamReaderImpl.getElementText(), javolution.xml.internal.stream.XMLStreamReaderImpl.hasNext(), javolution.xml.internal.stream.XMLStreamReaderImpl.isEndOfStream(), javolution.xml.sax.XMLReaderImpl.parseAll(), and javolution.xml.ws.WebServiceClient.readResponse().

◆ END_ELEMENT

final int javolution.xml.stream.XMLStreamConstants.END_ELEMENT = 2

staticinherited

Indicates an event is an end element.

Definition at line 29 of file XMLStreamConstants.java.

◆ ENTITY_DECLARATION

final int javolution.xml.stream.XMLStreamConstants.ENTITY_DECLARATION = 15

staticinherited

Indicates a Entity Declaration.

Definition at line 96 of file XMLStreamConstants.java.

◆ ENTITY_REFERENCE

final int javolution.xml.stream.XMLStreamConstants.ENTITY_REFERENCE = 9

staticinherited

Indicates an event is an entity reference.

Definition at line 66 of file XMLStreamConstants.java.

◆ NAMESPACE

final int javolution.xml.stream.XMLStreamConstants.NAMESPACE = 13

staticinherited

Indicates the event is a namespace declaration.

Definition at line 86 of file XMLStreamConstants.java.

◆ NOTATION_DECLARATION

final int javolution.xml.stream.XMLStreamConstants.NOTATION_DECLARATION = 14

staticinherited

Indicates a Notation.

Definition at line 91 of file XMLStreamConstants.java.

◆ PROCESSING_INSTRUCTION

final int javolution.xml.stream.XMLStreamConstants.PROCESSING_INSTRUCTION = 3

staticinherited

Indicates an event is a processing instruction.

Definition at line 34 of file XMLStreamConstants.java.

Referenced by javolution.xml.internal.stream.XMLStreamReaderImpl.getElementText(), javolution.xml.internal.stream.XMLStreamReaderImpl.getPIData(), javolution.xml.internal.stream.XMLStreamReaderImpl.getPITarget(), javolution.xml.internal.stream.XMLStreamReaderImpl.next(), javolution.xml.internal.stream.XMLStreamReaderImpl.nextTag(), and javolution.xml.sax.XMLReaderImpl.parseAll().

◆ SPACE

final int javolution.xml.stream.XMLStreamConstants.SPACE = 6

staticinherited

The characters are white space (see [XML], 2.10 "White Space Handling"). Events are only reported as SPACE if they are ignorable white space. Otherwise they are reported as CHARACTERS.

Definition at line 51 of file XMLStreamConstants.java.

Referenced by javolution.xml.sax.XMLReaderImpl.parseAll(), and javolution.xml.ws.WebServiceClient.readResponse().

◆ START_DOCUMENT

final int javolution.xml.stream.XMLStreamConstants.START_DOCUMENT = 7

staticinherited

Indicates an event is a start document.

Definition at line 56 of file XMLStreamConstants.java.

Referenced by javolution.xml.sax.XMLReaderImpl.parseAll(), javolution.xml.ws.WebServiceClient.readResponse(), javolution.xml.internal.stream.XMLStreamReaderImpl.reset(), and javolution.xml.internal.stream.XMLStreamReaderImpl.setInput().

◆ START_ELEMENT

final int javolution.xml.stream.XMLStreamConstants.START_ELEMENT = 1

staticinherited

Indicates an event is a start element.

Definition at line 24 of file XMLStreamConstants.java.

The documentation for this interface was generated from the following file:

XMLStreamReader.java

Public Member Functions

Static Public Attributes

Detailed Description

Member Function Documentation

◆ close()

◆ getAttributeCount()

◆ getAttributeLocalName()

◆ getAttributeNamespace()

◆ getAttributePrefix()

◆ getAttributeType()

◆ getAttributeValue() [1/2]

◆ getAttributeValue() [2/2]

◆ getCharacterEncodingScheme()

◆ getElementText()

◆ getEncoding()

◆ getEventType()

◆ getLocalName()

◆ getLocation()

◆ getNamespaceContext()

◆ getNamespaceCount()

◆ getNamespacePrefix()

◆ getNamespaceURI() [1/3]

◆ getNamespaceURI() [2/3]

◆ getNamespaceURI() [3/3]

◆ getPIData()

◆ getPITarget()

◆ getPrefix()

◆ getProperty()

◆ getText()

◆ getTextCharacters() [1/2]

◆ getTextCharacters() [2/2]

◆ getTextLength()

◆ getTextStart()

◆ getVersion()

◆ hasName()

◆ hasNext()

◆ hasText()

◆ isAttributeSpecified()

◆ isCharacters()

◆ isEndElement()

◆ isStandalone()

◆ isStartElement()

◆ isWhiteSpace()

◆ next()

◆ nextTag()

◆ require()

◆ standaloneSet()

Member Data Documentation

◆ ATTRIBUTE

◆ CDATA

◆ CHARACTERS

◆ COMMENT

◆ DTD

◆ END_DOCUMENT

◆ END_ELEMENT

◆ ENTITY_DECLARATION

◆ ENTITY_REFERENCE

◆ NAMESPACE

◆ NOTATION_DECLARATION

◆ PROCESSING_INSTRUCTION

◆ SPACE

◆ START_DOCUMENT

◆ START_ELEMENT