Java Doc for XMLStreamReader.java in  » 6.0-JDK-Modules » jsr173-Stax » javax » xml » stream » Java Source Code / Java DocumentationJava Source Code and Java Documentation

Java Source Code / Java Documentation
1. 6.0 JDK Core
2. 6.0 JDK Modules
3. 6.0 JDK Modules com.sun
4. 6.0 JDK Modules com.sun.java
5. 6.0 JDK Modules sun
6. 6.0 JDK Platform
7. Ajax
8. Apache Harmony Java SE
9. Aspect oriented
10. Authentication Authorization
11. Blogger System
12. Build
13. Byte Code
14. Cache
15. Chart
16. Chat
17. Code Analyzer
18. Collaboration
19. Content Management System
20. Database Client
21. Database DBMS
22. Database JDBC Connection Pool
23. Database ORM
24. Development
25. EJB Server geronimo
26. EJB Server GlassFish
27. EJB Server JBoss 4.2.1
28. EJB Server resin 3.1.5
29. ERP CRM Financial
30. ESB
31. Forum
32. GIS
33. Graphic Library
34. Groupware
35. HTML Parser
36. IDE
37. IDE Eclipse
38. IDE Netbeans
39. Installer
40. Internationalization Localization
41. Inversion of Control
42. Issue Tracking
43. J2EE
44. JBoss
45. JMS
46. JMX
47. Library
48. Mail Clients
49. Net
50. Parser
51. PDF
52. Portal
53. Profiler
54. Project Management
55. Report
56. RSS RDF
57. Rule Engine
58. Science
59. Scripting
60. Search Engine
61. Security
62. Sevlet Container
63. Source Control
64. Swing Library
65. Template Engine
66. Test Coverage
67. Testing
68. UML
69. Web Crawler
70. Web Framework
71. Web Mail
72. Web Server
73. Web Services
74. Web Services apache cxf 2.0.1
75. Web Services AXIS2
76. Wiki Engine
77. Workflow Engines
78. XML
79. XML UI
Java
Java Tutorial
Java Open Source
Jar File Download
Java Articles
Java Products
Java by API
Photoshop Tutorials
Maya Tutorials
Flash Tutorials
3ds-Max Tutorials
Illustrator Tutorials
GIMP Tutorials
C# / C Sharp
C# / CSharp Tutorial
C# / CSharp Open Source
ASP.Net
ASP.NET Tutorial
JavaScript DHTML
JavaScript Tutorial
JavaScript Reference
HTML / CSS
HTML CSS Reference
C / ANSI-C
C Tutorial
C++
C++ Tutorial
Ruby
PHP
Python
Python Tutorial
Python Open Source
SQL Server / T-SQL
SQL Server / T-SQL Tutorial
Oracle PL / SQL
Oracle PL/SQL Tutorial
PostgreSQL
SQL / MySQL
MySQL Tutorial
VB.Net
VB.Net Tutorial
Flash / Flex / ActionScript
VBA / Excel / Access / Word
XML
XML Tutorial
Microsoft Office PowerPoint 2007 Tutorial
Microsoft Office Excel 2007 Tutorial
Microsoft Office Word 2007 Tutorial
Java Source Code / Java Documentation » 6.0 JDK Modules » jsr173 Stax » javax.xml.stream 
Source Cross Reference  Class Diagram Java Document (Java Doc) 


javax.xml.stream.XMLStreamReader

All known Subclasses:   javax.xml.stream.util.StreamReaderDelegate,
XMLStreamReader
public interface XMLStreamReader extends XMLStreamConstants(Code)
The XMLStreamReader interface allows forward, read-only access to XML. It is designed to be the lowest level and most efficient way to read XML data.

The XMLStreamReader is designed to iterate over XML using next() and hasNext(). The data can be accessed using methods such as getEventType(), getNamespaceURI(), getLocalName() and getText();

The next() method causes the reader to read the next parse event. The next() method returns an integer which identifies the type of event just read.

The event type can be determined using getEventType().

Parsing events are defined as the XML Declaration, a DTD, start tag, character data, white space, end tag, comment, or processing instruction. An attribute or namespace event may be encountered at the root level of a document as the result of a query operation.

For XML 1.0 compliance an XML processor must pass the identifiers of declared unparsed entities, notation declarations and their associated identifiers to the application. This information is provided through the property API on this interface. The following two properties allow access to this information: javax.xml.stream.notations and javax.xml.stream.entities. When the current event is a DTD the following call will return a list of Notations List l = (List) getProperty("javax.xml.stream.notations"); The following call will return a list of entity declarations: List l = (List) getProperty("javax.xml.stream.entities"); These properties can only be accessed during a DTD event and are defined to return null if the information is not available.

The following table describes which methods are valid in what state. If a method is called in an invalid state the method will throw a java.lang.IllegalStateException.
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()

version:
   1.0
author:
   Copyright (c) 2003 by BEA Systems. All Rights Reserved.
See Also:   javax.xml.stream.events.XMLEvent
See Also:   XMLInputFactory
See Also:   XMLStreamWriter





Method Summary
public  voidclose()
     Frees any resources associated with this Reader.
public  intgetAttributeCount()
     Returns the count of attributes on this START_ELEMENT, this method is only valid on a START_ELEMENT or ATTRIBUTE.
public  StringgetAttributeLocalName(int index)
    
public  QNamegetAttributeName(int index)
    
public  StringgetAttributeNamespace(int index)
    
public  StringgetAttributePrefix(int index)
    
public  StringgetAttributeType(int index)
    
public  StringgetAttributeValue(String namespaceURI, String localName)
    
public  StringgetAttributeValue(int index)
    
public  StringgetCharacterEncodingScheme()
    
public  StringgetElementText()
     Reads the content of a text-only element, an exception is thrown if this is not a text-only element.
public  StringgetEncoding()
     Return input encoding if known or null if unknown.
public  intgetEventType()
     Returns an integer code that indicates the type of the event the cursor is pointing to.
public  StringgetLocalName()
     Returns the (local) name of the current event.
public  LocationgetLocation()
     Return the current location of the processor.
public  QNamegetName()
    
public  NamespaceContextgetNamespaceContext()
     Returns a read only namespace context for the current position.
public  intgetNamespaceCount()
     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  StringgetNamespacePrefix(int index)
     Returns the prefix for the namespace declared at the index.
public  StringgetNamespaceURI(String prefix)
     Return the uri for the given prefix.
public  StringgetNamespaceURI(int index)
     Returns the uri for the namespace declared at the index.
public  StringgetNamespaceURI()
     If the current event is a START_ELEMENT or END_ELEMENT this method returns the URI of the prefix or the default namespace.
public  StringgetPIData()
    
public  StringgetPITarget()
    
public  StringgetPrefix()
    
public  ObjectgetProperty(java.lang.String name)
    
public  StringgetText()
     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. This array should be treated as read-only and transient.
public  intgetTextCharacters(int sourceStart, char[] target, int targetStart, int length)
     Gets the the text associated with a CHARACTERS, SPACE or CDATA event.
public  intgetTextLength()
     Returns the length of the sequence of characters for this Text event within the text character array.
public  intgetTextStart()
     Returns the offset into the text character array where the first character (of this text event) is stored.
public  StringgetVersion()
    
public  booleanhasName()
    
public  booleanhasNext()
     Returns true if there are more parsing events and false if there are no more events.
public  booleanhasText()
    
public  booleanisAttributeSpecified(int index)
    
public  booleanisCharacters()
    
public  booleanisEndElement()
    
public  booleanisStandalone()
    
public  booleanisStartElement()
    
public  booleanisWhiteSpace()
    
public  intnext()
     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.
public  intnextTag()
     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.
public  voidrequire(int type, String namespaceURI, String localName)
     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  booleanstandaloneSet()
    



Method Detail
close
public void close() throws XMLStreamException(Code)
Frees any resources associated with this Reader. This method does not close the underlying input source.
throws:
  XMLStreamException - if there are errors freeing associated resources



getAttributeCount
public int getAttributeCount()(Code)
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 number of attributes
throws:
  IllegalStateException - if this is not a START_ELEMENT or ATTRIBUTE



getAttributeLocalName
public String getAttributeLocalName(int index)(Code)
Returns the localName of the attribute at the provided index
Parameters:
  index - the position of the attribute the localName of the attribute
throws:
  IllegalStateException - if this is not a START_ELEMENT or ATTRIBUTE



getAttributeName
public QName getAttributeName(int index)(Code)
Returns the qname of the attribute at the provided index
Parameters:
  index - the position of the attribute the QName of the attribute
throws:
  IllegalStateException - if this is not a START_ELEMENT or ATTRIBUTE



getAttributeNamespace
public String getAttributeNamespace(int index)(Code)
Returns the namespace of the attribute at the provided index
Parameters:
  index - the position of the attribute the namespace URI (can be null)
throws:
  IllegalStateException - if this is not a START_ELEMENT or ATTRIBUTE



getAttributePrefix
public String getAttributePrefix(int index)(Code)
Returns the prefix of this attribute at the provided index
Parameters:
  index - the position of the attribute the prefix of the attribute
throws:
  IllegalStateException - if this is not a START_ELEMENT or ATTRIBUTE



getAttributeType
public String getAttributeType(int index)(Code)
Returns the XML type of the attribute at the provided index
Parameters:
  index - the position of the attribute the XML type of the attribute
throws:
  IllegalStateException - if this is not a START_ELEMENT or ATTRIBUTE



getAttributeValue
public String getAttributeValue(String namespaceURI, String localName)(Code)
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 - the namespace of the attribute
Parameters:
  localName - the local name of the attribute, cannot be null returns the value of the attribute , returns null if not found
throws:
  IllegalStateException - if this is not a START_ELEMENT or ATTRIBUTE



getAttributeValue
public String getAttributeValue(int index)(Code)
Returns the value of the attribute at the index
Parameters:
  index - the position of the attribute the attribute value
throws:
  IllegalStateException - if this is not a START_ELEMENT or ATTRIBUTE



getCharacterEncodingScheme
public String getCharacterEncodingScheme()(Code)
Returns the character encoding declared on the xml declaration Returns null if none was declared the encoding declared in the document or null



getElementText
public String getElementText() throws XMLStreamException(Code)
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



getEncoding
public String getEncoding()(Code)
Return input encoding if known or null if unknown. the encoding of this instance or null



getEventType
public int getEventType()(Code)
Returns an integer code that indicates the type of the event the cursor is pointing to.



getLocalName
public String getLocalName()(Code)
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 the localName
throws:
  IllegalStateException - if this not a START_ELEMENT,END_ELEMENT or ENTITY_REFERENCE



getLocation
public Location getLocation()(Code)
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.



getName
public QName getName()(Code)
Returns a QName for the current START_ELEMENT or END_ELEMENT event the QName for the current START_ELEMENT or END_ELEMENT event
throws:
  IllegalStateException - if this is not a START_ELEMENT orEND_ELEMENT



getNamespaceContext
public NamespaceContext getNamespaceContext()(Code)
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. return a namespace context



getNamespaceCount
public int getNamespaceCount()(Code)
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 number of namespace declarations on this specific element
throws:
  IllegalStateException - if this is not a START_ELEMENT, END_ELEMENT or NAMESPACE



getNamespacePrefix
public String getNamespacePrefix(int index)(Code)
Returns the prefix for the namespace declared at the index. Returns null if this is the default namespace declaration
Parameters:
  index - the position of the namespace declaration returns the namespace prefix
throws:
  IllegalStateException - if this is not a START_ELEMENT, END_ELEMENT or NAMESPACE



getNamespaceURI
public String getNamespaceURI(String prefix)(Code)
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/
Parameters:
  prefix - The prefix to lookup, may not be null the uri bound to the given prefix or null if it is not bound
throws:
  IllegalArgumentException - if the prefix is null




getNamespaceURI
public String getNamespaceURI(int index)(Code)
Returns the uri for the namespace declared at the index.
Parameters:
  index - the position of the namespace declaration returns the namespace uri
throws:
  IllegalStateException - if this is not a START_ELEMENT, END_ELEMENT or NAMESPACE



getNamespaceURI
public String getNamespaceURI()(Code)
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. the URI bound to this elements prefix, the default namespace, or null



getPIData
public String getPIData()(Code)
Get the data section of a processing instruction the data or null



getPITarget
public String getPITarget()(Code)
Get the target of a processing instruction the target or null



getPrefix
public String getPrefix()(Code)
Returns the prefix of the current event or null if the event does not have a prefix the prefix or null



getProperty
public Object getProperty(java.lang.String name) throws java.lang.IllegalArgumentException(Code)
Get the value of a feature/property from the underlying implementation
Parameters:
  name - The name of the property, may not be null The value of the property
throws:
  IllegalArgumentException - if name is null



getText
public String getText()(Code)
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. the current text or null
throws:
  java.lang.IllegalStateException - if this state is nota valid text state.



getTextCharacters
public char[] getTextCharacters()(Code)
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. the current text or an empty array
throws:
  java.lang.IllegalStateException - if this state is nota valid text state.



getTextCharacters
public int getTextCharacters(int sourceStart, char[] target, int targetStart, int length) throws XMLStreamException(Code)
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 the first character in the source array to copy
Parameters:
  target - the destination array
Parameters:
  targetStart - the start offset in the target array
Parameters:
  length - the number of characters to copy the number of characters actually copied
throws:
  XMLStreamException - if the underlying XML source is not well-formed
throws:
  IndexOutOfBoundsException - if targetStart < 0 or > than the length of target
throws:
  IndexOutOfBoundsException - if length < 0 or targetStart + length > length of target
throws:
  UnsupportedOperationException - if this method is not supported
throws:
  NullPointerException - is if target is null



getTextLength
public int getTextLength()(Code)
Returns the length of the sequence of characters for this Text event within the text character array.
throws:
  java.lang.IllegalStateException - if this state is nota valid text state.



getTextStart
public int getTextStart()(Code)
Returns the offset into the text character array where the first character (of this text event) is stored.
throws:
  java.lang.IllegalStateException - if this state is nota valid text state.



getVersion
public String getVersion()(Code)
Get the xml version declared on the xml declaration Returns null if none was declared the XML version or null



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



hasNext
public boolean hasNext() throws XMLStreamException(Code)
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 true if there are more events, false otherwise
throws:
  XMLStreamException - if there is a fatal error detecting the next state



hasText
public boolean hasText()(Code)
Return true if the current event has text, false otherwise The following events have text: CHARACTERS,DTD ,ENTITY_REFERENCE, COMMENT, SPACE



isAttributeSpecified
public boolean isAttributeSpecified(int index)(Code)
Returns a boolean which indicates if this attribute was created by default
Parameters:
  index - the position of the attribute true if this is a default attribute
throws:
  IllegalStateException - if this is not a START_ELEMENT or ATTRIBUTE



isCharacters
public boolean isCharacters()(Code)
Returns true if the cursor points to a character data event true if the cursor points to character data, false otherwise



isEndElement
public boolean isEndElement()(Code)
Returns true if the cursor points to an end tag (otherwise false) true if the cursor points to an end tag, false otherwise



isStandalone
public boolean isStandalone()(Code)
Get the standalone declaration from the xml declaration true if this is standalone, or false otherwise



isStartElement
public boolean isStartElement()(Code)
Returns true if the cursor points to a start tag (otherwise false) true if the cursor points to a start tag, false otherwise



isWhiteSpace
public boolean isWhiteSpace()(Code)
Returns true if the cursor points to a character data event that consists of all whitespace true if the cursor points to all whitespace, false otherwise



next
public int next() throws XMLStreamException(Code)
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.
See Also:   javax.xml.stream.events.XMLEvent 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




nextTag
public int nextTag() throws XMLStreamException(Code)
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;
 
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
throws:
  NoSuchElementException - if this is called when hasNext() returns false



require
public void require(int type, String namespaceURI, String localName) throws XMLStreamException(Code)
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 - the event type
Parameters:
  namespaceURI - the uri of the event, may be null
Parameters:
  localName - the localName of the event, may be null
throws:
  XMLStreamException - if the required values are not matched.



standaloneSet
public boolean standaloneSet()(Code)
Checks if standalone was set in the document true if standalone was set in the document, or false otherwise



www.java2java.com | Contact Us
Copyright 2009 - 12 Demo Source and Support. All rights reserved.
All other trademarks are property of their respective owners.