public class StreamReaderDelegate extends Objectimplements XMLStreamReader
XMLStreamReader,
EventReaderDelegate
ATTRIBUTE, CDATA, CHARACTERS, COMMENT, DTD, END_DOCUMENT, END_ELEMENT, ENTITY_DECLARATION, ENTITY_REFERENCE, NAMESPACE, NOTATION_DECLARATION, PROCESSING_INSTRUCTION, SPACE, START_DOCUMENT, START_ELEMENT| Constructor and Description |
|---|
StreamReaderDelegate()
Construct an empty filter with no parent.
|
StreamReaderDelegate(XMLStreamReader
Construct an filter with the specified parent.
|
| Modifier and Type | Method and 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(int index)
Returns the localName of the attribute at the provided index
|
QName |
getAttributeName(int index)
Returns the qname of the attribute at the provided index
|
String |
getAttributeNamespace(int index)
Returns the namespace of the attribute at the provided index
|
String |
getAttributePrefix(int index)
Returns the prefix of this attribute at the provided index
|
String |
getAttributeType(int index)
Returns the XML type of the attribute at the provided index
|
String |
getAttributeValue(int index)
Returns the value of the attribute at the index
|
String |
getAttributeValue(String
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(int index)
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(int index)
Returns the uri for the namespace declared at the index.
|
String |
getNamespaceURI(String
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(String
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(int sourceStart, char[] target, int targetStart, int length)
Gets the 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 true if the current event has a name (is a START_ELEMENT or END_ELEMENT) returns false otherwise
|
boolean |
hasNext()
Returns true if there are more parsing events and false if there are no more events.
|
boolean |
hasText()
Return true if the current event has text, false otherwise The following events have text: CHARACTERS,DTD ,ENTITY_REFERENCE, COMMENT, SPACE
|
boolean |
isAttributeSpecified(int index)
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(int type, String
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(XMLStreamReader
Set the parent of this instance.
|
boolean |
standaloneSet()
Checks if standalone was set in the document
|
public StreamReaderDelegate()
public StreamReaderDelegate(XMLStreamReaderreader)
reader - the parent
public void setParent(XMLStreamReaderreader)
reader - the new parent
public XMLStreamReadergetParent()
public int next()
throws XMLStreamException
XMLStreamReader
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.
next in interface
XMLStreamReader
XMLStreamException - if there is an error processing the underlying XML source
XMLEvent
public 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_ELEMENT
public StringgetElementText() 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 encountered
public void require(int type,
String namespaceURI,
String localName)
throws XMLStreamException
XMLStreamReader
require in interface
XMLStreamReader
type - the event type
namespaceURI - the uri of the event, may be null
localName - the localName of the event, may be null
XMLStreamException - if the required values are not matched.
public boolean hasNext()
throws XMLStreamException
XMLStreamReader
hasNext in interface
XMLStreamReader
XMLStreamException - if there is a fatal error detecting the next state
public void close()
throws XMLStreamException
XMLStreamReader
close in interface
XMLStreamReader
XMLStreamException - if there are errors freeing associated resources
public StringgetNamespaceURI(String prefix)
XMLStreamReader
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/
getNamespaceURI in interface
XMLStreamReader
prefix - The prefix to lookup, may not be null
public NamespaceContextgetNamespaceContext()
XMLStreamReader
getNamespaceContext in interface
XMLStreamReader
public boolean isStartElement()
XMLStreamReader
isStartElement in interface
XMLStreamReader
public boolean isEndElement()
XMLStreamReader
isEndElement in interface
XMLStreamReader
public boolean isCharacters()
XMLStreamReader
isCharacters in interface
XMLStreamReader
public boolean isWhiteSpace()
XMLStreamReader
isWhiteSpace in interface
XMLStreamReader
public StringgetAttributeValue(String namespaceUri, String localName)
XMLStreamReader
getAttributeValue in interface
XMLStreamReader
namespaceUri - the namespace of the attribute
localName - the local name of the attribute, cannot be null
public int getAttributeCount()
XMLStreamReader
getAttributeCount in interface
XMLStreamReader
public QNamegetAttributeName(int index)
XMLStreamReader
getAttributeName in interface
XMLStreamReader
index - the position of the attribute
public StringgetAttributePrefix(int index)
XMLStreamReader
getAttributePrefix in interface
XMLStreamReader
index - the position of the attribute
public StringgetAttributeNamespace(int index)
XMLStreamReader
getAttributeNamespace in interface
XMLStreamReader
index - the position of the attribute
public StringgetAttributeLocalName(int index)
XMLStreamReader
getAttributeLocalName in interface
XMLStreamReader
index - the position of the attribute
public StringgetAttributeType(int index)
XMLStreamReader
getAttributeType in interface
XMLStreamReader
index - the position of the attribute
public StringgetAttributeValue(int index)
XMLStreamReader
getAttributeValue in interface
XMLStreamReader
index - the position of the attribute
public boolean isAttributeSpecified(int index)
XMLStreamReader
isAttributeSpecified in interface
XMLStreamReader
index - the position of the attribute
public int getNamespaceCount()
XMLStreamReader
getNamespaceCount in interface
XMLStreamReader
public StringgetNamespacePrefix(int index)
XMLStreamReader
getNamespacePrefix in interface
XMLStreamReader
index - the position of the namespace declaration
public StringgetNamespaceURI(int index)
XMLStreamReader
getNamespaceURI in interface
XMLStreamReader
index - the position of the namespace declaration
public int getEventType()
XMLStreamReader
public StringgetText()
XMLStreamReader
getText 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; } 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".
getTextCharacters in interface
XMLStreamReader
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
XMLStreamException - if the underlying XML source is not well-formed
public char[] getTextCharacters()
XMLStreamReader
getTextCharacters in interface
XMLStreamReader
public int getTextStart()
XMLStreamReader
public int getTextLength()
XMLStreamReader
public StringgetEncoding()
XMLStreamReader
getEncoding in interface
XMLStreamReader
public boolean hasText()
XMLStreamReader
public LocationgetLocation()
XMLStreamReader
public QNamegetName()
XMLStreamReader
getName in interface
XMLStreamReader
public StringgetLocalName()
XMLStreamReader
getLocalName in interface
XMLStreamReader
public boolean hasName()
XMLStreamReader
public StringgetNamespaceURI()
XMLStreamReader
getNamespaceURI in interface
XMLStreamReader
public StringgetPrefix()
XMLStreamReader
getPrefix in interface
XMLStreamReader
public StringgetVersion()
XMLStreamReader
getVersion in interface
XMLStreamReader
public boolean isStandalone()
XMLStreamReader
isStandalone in interface
XMLStreamReader
public boolean standaloneSet()
XMLStreamReader
standaloneSet in interface
XMLStreamReader
public StringgetCharacterEncodingScheme()
XMLStreamReader
getCharacterEncodingScheme in interface
XMLStreamReader
public StringgetPITarget()
XMLStreamReader
getPITarget in interface
XMLStreamReader
public StringgetPIData()
XMLStreamReader
getPIData in interface
XMLStreamReader
public ObjectgetProperty(String name)
XMLStreamReader
getProperty in interface
XMLStreamReader
name - The name of the property, may not be null