XMLStreamConstants, XMLStreamReader
public class StreamReaderDelegate extends Object implements XMLStreamReader
ATTRIBUTE, CDATA, CHARACTERS, COMMENT, DTD, END_DOCUMENT, END_ELEMENT, ENTITY_DECLARATION, ENTITY_REFERENCE, NAMESPACE, NOTATION_DECLARATION, PROCESSING_INSTRUCTION, SPACE, START_DOCUMENT, START_ELEMENT
| Constructor | Description | 
|---|---|
| StreamReaderDelegate() | Construct an empty filter with no parent. | 
| StreamReaderDelegate | Construct an filter with the specified parent. | 
| Modifier and Type | Method | Description | 
|---|---|---|
| void | close() | Frees any resources associated with this Reader. | 
| int | getAttributeCount() | Returns the count of attributes on this START_ELEMENT, this method is only valid on a START_ELEMENT or ATTRIBUTE. | 
| String | getAttributeLocalName | Returns the localName of the attribute at the provided index | 
| QName | getAttributeName | Returns the qname of the attribute at the provided index | 
| String | getAttributeNamespace | Returns the namespace of the attribute at the provided index | 
| String | getAttributePrefix | Returns the prefix of this attribute at the provided index | 
| String | getAttributeType | Returns the XML type of the attribute at the provided index | 
| String | getAttributeValue | Returns the value of the attribute at the index | 
| String | getAttributeValue | 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 | 
| String | getCharacterEncodingScheme() | Returns the character encoding declared on the xml declaration Returns null if none was declared | 
| String | getElementText() | Reads the content of a text-only element, an exception is thrown if this is not a text-only element. | 
| String | getEncoding() | Return input encoding if known or null if unknown. | 
| int | getEventType() | Returns an integer code that indicates the type of the event the cursor is pointing to. | 
| String | getLocalName() | Returns the (local) name of the current event. | 
| Location | getLocation() | Return the current location of the processor. | 
| QName | getName() | Returns a QName for the current START_ELEMENT or END_ELEMENT event | 
| NamespaceContext | getNamespaceContext() | Returns a read only namespace context for the current position. | 
| 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. | 
| String | getNamespacePrefix | Returns the prefix for the namespace declared at the index. | 
| 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. | 
| String | getNamespaceURI | Returns the uri for the namespace declared at the index. | 
| String | getNamespaceURI | Return the uri for the given prefix. | 
| XMLStreamReader | getParent() | Get the parent of this instance. | 
| String | getPIData() | Get the data section of a processing instruction | 
| String | getPITarget() | Get the target of a processing instruction | 
| String | getPrefix() | Returns the prefix of the current event or null if the event does not have a prefix | 
| Object | getProperty | Get the value of a feature/property from the underlying implementation | 
| 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. | 
| char[] | getTextCharacters() | Returns an array which contains the characters from this event. | 
| int | getTextCharacters | Gets the text associated with a CHARACTERS, SPACE or CDATA event. | 
| int | getTextLength() | Returns the length of the sequence of characters for this Text event within the text character array. | 
| int | getTextStart() | Returns the offset into the text character array where the first character (of this text event) is stored. | 
| String | getVersion() | Get the xml version declared on the xml declaration Returns null if none was declared | 
| boolean | hasName() | returns a boolean indicating whether the current event has a name (is a START_ELEMENT or END_ELEMENT). | 
| boolean | hasNext() | Returns true if there are more parsing events and false if there are no more events. | 
| boolean | hasText() | Return a boolean indicating whether the current event has text. | 
| boolean | isAttributeSpecified | Returns a boolean which indicates if this attribute was created by default | 
| boolean | isCharacters() | Returns true if the cursor points to a character data event | 
| boolean | isEndElement() | Returns true if the cursor points to an end tag (otherwise false) | 
| boolean | isStandalone() | Get the standalone declaration from the xml declaration | 
| boolean | isStartElement() | Returns true if the cursor points to a start tag (otherwise false) | 
| boolean | isWhiteSpace() | Returns true if the cursor points to a character data event that consists of all whitespace | 
| int | next() | Get next parsing event - a processor may return all contiguous character data in a single chunk, or it may split it into several chunks. | 
| int | nextTag() | Skips any white space (isWhiteSpace() returns true), COMMENT, or PROCESSING_INSTRUCTION, until a START_ELEMENT or END_ELEMENT is reached. | 
| void | require | 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. | 
| void | setParent | Set the parent of this instance. | 
| boolean | standaloneSet() | Checks if standalone was set in the document | 
public StreamReaderDelegate()
public StreamReaderDelegate(XMLStreamReader reader)
reader - the parentpublic void setParent(XMLStreamReader reader)
reader - the new parentpublic XMLStreamReader getParent()
public int next() throws XMLStreamException
XMLStreamReaderGiven 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>.
next in interface XMLStreamReader
XMLStreamException - if there is an error processing the underlying XML sourcepublic int nextTag() throws XMLStreamException
XMLStreamReader 
 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; 
 
nextTag in interface XMLStreamReader
XMLStreamException - if the current event is not white space, PROCESSING_INSTRUCTION, START_ELEMENT or END_ELEMENTpublic String getElementText() throws XMLStreamException
XMLStreamReader
 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();
 
getElementText in interface XMLStreamReader
XMLStreamException - if the current event is not a START_ELEMENT or if a non text element is encounteredpublic void require(int type, String namespaceURI, String localName) throws XMLStreamException
XMLStreamReaderrequire in interface XMLStreamReader
type - the event typenamespaceURI - the uri of the event, may be nulllocalName - the localName of the event, may be nullXMLStreamException - if the required values are not matched.public boolean hasNext() throws XMLStreamException
XMLStreamReaderhasNext in interface XMLStreamReader
XMLStreamException - if there is a fatal error detecting the next statepublic void close() throws XMLStreamException
XMLStreamReaderclose in interface XMLStreamReader
XMLStreamException - if there are errors freeing associated resourcespublic String getNamespaceURI(String prefix)
XMLStreamReaderNOTE: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/
getNamespaceURI in interface XMLStreamReader
prefix - The prefix to lookup, may not be nullpublic NamespaceContext getNamespaceContext()
XMLStreamReadergetNamespaceContext in interface XMLStreamReader
public boolean isStartElement()
XMLStreamReaderisStartElement in interface XMLStreamReader
public boolean isEndElement()
XMLStreamReaderisEndElement in interface XMLStreamReader
public boolean isCharacters()
XMLStreamReaderisCharacters in interface XMLStreamReader
public boolean isWhiteSpace()
XMLStreamReaderisWhiteSpace in interface XMLStreamReader
public String getAttributeValue(String namespaceUri, String localName)
XMLStreamReadergetAttributeValue in interface XMLStreamReader
namespaceUri - the namespace of the attributelocalName - the local name of the attribute, cannot be nullpublic int getAttributeCount()
XMLStreamReadergetAttributeCount in interface XMLStreamReader
public QName getAttributeName(int index)
XMLStreamReadergetAttributeName in interface XMLStreamReader
index - the position of the attributepublic String getAttributePrefix(int index)
XMLStreamReadergetAttributePrefix in interface XMLStreamReader
index - the position of the attributepublic String getAttributeNamespace(int index)
XMLStreamReadergetAttributeNamespace in interface XMLStreamReader
index - the position of the attributepublic String getAttributeLocalName(int index)
XMLStreamReadergetAttributeLocalName in interface XMLStreamReader
index - the position of the attributepublic String getAttributeType(int index)
XMLStreamReadergetAttributeType in interface XMLStreamReader
index - the position of the attributepublic String getAttributeValue(int index)
XMLStreamReadergetAttributeValue in interface XMLStreamReader
index - the position of the attributepublic boolean isAttributeSpecified(int index)
XMLStreamReaderisAttributeSpecified in interface XMLStreamReader
index - the position of the attributepublic int getNamespaceCount()
XMLStreamReadergetNamespaceCount in interface XMLStreamReader
public String getNamespacePrefix(int index)
XMLStreamReadergetNamespacePrefix in interface XMLStreamReader
index - the position of the namespace declarationpublic String getNamespaceURI(int index)
XMLStreamReadergetNamespaceURI in interface XMLStreamReader
index - the position of the namespace declarationpublic int getEventType()
XMLStreamReaderXMLStreamConstants.START_DOCUMENT.getEventType in interface XMLStreamReader
public String getText()
XMLStreamReadergetText in interface XMLStreamReader
public int getTextCharacters(int sourceStart, char[] target, int targetStart, int length) throws XMLStreamException
XMLStreamReader
 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;
 }
  getTextCharacters in interface XMLStreamReader
sourceStart - the index of the first character in the source array to copytarget - the destination arraytargetStart - the start offset in the target arraylength - the number of characters to copyXMLStreamException - if the underlying XML source is not well-formedpublic char[] getTextCharacters()
XMLStreamReadergetTextCharacters in interface XMLStreamReader
public int getTextStart()
XMLStreamReadergetTextStart in interface XMLStreamReader
public int getTextLength()
XMLStreamReadergetTextLength in interface XMLStreamReader
public String getEncoding()
XMLStreamReadergetEncoding in interface XMLStreamReader
public boolean hasText()
XMLStreamReaderhasText in interface XMLStreamReader
public Location getLocation()
XMLStreamReadergetLocation in interface XMLStreamReader
public QName getName()
XMLStreamReadergetName in interface XMLStreamReader
public String getLocalName()
XMLStreamReadergetLocalName in interface XMLStreamReader
public boolean hasName()
XMLStreamReaderhasName in interface XMLStreamReader
public String getNamespaceURI()
XMLStreamReadergetNamespaceURI in interface XMLStreamReader
public String getPrefix()
XMLStreamReadergetPrefix in interface XMLStreamReader
public String getVersion()
XMLStreamReadergetVersion in interface XMLStreamReader
public boolean isStandalone()
XMLStreamReaderisStandalone in interface XMLStreamReader
public boolean standaloneSet()
XMLStreamReaderstandaloneSet in interface XMLStreamReader
public String getCharacterEncodingScheme()
XMLStreamReadergetCharacterEncodingScheme in interface XMLStreamReader
public String getPITarget()
XMLStreamReadergetPITarget in interface XMLStreamReader
public String getPIData()
XMLStreamReadergetPIData in interface XMLStreamReader
public Object getProperty(String name)
XMLStreamReadergetProperty in interface XMLStreamReader
name - The name of the property, may not be null
    © 1993, 2023, Oracle and/or its affiliates. All rights reserved.
Documentation extracted from Debian's OpenJDK Development Kit package.
Licensed under the GNU General Public License, version 2, with the Classpath Exception.
Various third party code in OpenJDK is licensed under different licenses (see Debian package).
Java and OpenJDK are trademarks or registered trademarks of Oracle and/or its affiliates.
    https://docs.oracle.com/en/java/javase/21/docs/api/java.xml/javax/xml/stream/util/StreamReaderDelegate.html