Java Doc for XMLStreamReader.java in  » Development » Javolution » javolution » xml » stream » Java Source Code / Java DocumentationJava Source Code and Java Documentation

This interface is similar to javax.xml.stream.XMLStreamReader; but it does not forces dynamic allocation when parsing (its methods returns CharArray 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 CharArray instances returned by this reader supports fast primitive conversions as illustrated below:[code] // Creates a new reader (potentially recycled). XMLInputFactory factory = XMLInputFactory.newInstance(); 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("hour").toInt(); time.minute = reader.getAttributeValue("minute").toInt(); time.second = reader.getAttributeValue("second").toInt(); } ... break; } } reader.close(); // Recycles the reader. inputStream.close(); // Underlying stream has to be closed explicitly. [/code]
author:
   Jean-Marie Dautelle
version:
   4.0, September 4, 2006

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

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. the uri bound to the given prefix or null if it isnot bound

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. the integer code corresponding to the current parse event
throws:
  NoSuchElementException - if this is called when hasNext() returns false
throws:
  XMLStreamException - if there is an error processing the underlying XML source

 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;