|
Java™ Platform Standard Ed. 6 |
|||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||
java.lang.Objectjavax.xml.stream.util.StreamReaderDelegate
public class StreamReaderDelegate
This is the base class for deriving an XMLStreamReader filter This class is designed to sit between an XMLStreamReader and an application's XMLStreamReader. By default each method does nothing but call the corresponding method on the parent interface.
XMLStreamReader,
EventReaderDelegate| Field Summary |
|---|
| Fields inherited from interface javax.xml.stream.XMLStreamConstants |
|---|
ATTRIBUTE, CDATA, CHARACTERS, COMMENT, DTD, END_DOCUMENT, END_ELEMENT, ENTITY_DECLARATION, ENTITY_REFERENCE, NAMESPACE, NOTATION_DECLARATION, PROCESSING_INSTRUCTION, SPACE, START_DOCUMENT, START_ELEMENT |
| Constructor Summary | |
|---|---|
StreamReaderDelegate()
Construct an empty filter with no parent. |
|
StreamReaderDelegate(XMLStreamReader reader)
Construct an filter with the specified parent. |
|
| Method Summary | |
|---|---|
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 namespaceUri,
String localName)
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 prefix)
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 name)
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 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. |
void |
setParent(XMLStreamReader reader)
Set the parent of this instance. |
boolean |
standaloneSet()
Checks if standalone was set in the document |
| Methods inherited from class java.lang.Object |
|---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
| Constructor Detail |
|---|
public StreamReaderDelegate()
public StreamReaderDelegate(XMLStreamReader reader)
reader - the parent| Method Detail |
|---|
public 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>. This method will throw an IllegalStateException if it is called after hasNext() returns false.
next in interface XMLStreamReaderXMLStreamException - if there is an error processing the underlying XML sourceXMLEvent
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 XMLStreamReaderXMLStreamException - if the current event is not white space, PROCESSING_INSTRUCTION,
START_ELEMENT or END_ELEMENT
public 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 XMLStreamReaderXMLStreamException - 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 XMLStreamReadertype - the event typenamespaceURI - the uri of the event, may be nulllocalName - 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 XMLStreamReaderXMLStreamException - if there is a fatal error detecting the next state
public void close()
throws XMLStreamException
XMLStreamReader
close in interface XMLStreamReaderXMLStreamException - 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 XMLStreamReaderprefix - The prefix to lookup, may not be null
public NamespaceContext getNamespaceContext()
XMLStreamReader
getNamespaceContext in interface XMLStreamReaderpublic boolean isStartElement()
XMLStreamReader
isStartElement in interface XMLStreamReaderpublic boolean isEndElement()
XMLStreamReader
isEndElement in interface XMLStreamReaderpublic boolean isCharacters()
XMLStreamReader
isCharacters in interface XMLStreamReaderpublic boolean isWhiteSpace()
XMLStreamReader
isWhiteSpace in interface XMLStreamReader
public String getAttributeValue(String namespaceUri,
String localName)
XMLStreamReader
getAttributeValue in interface XMLStreamReadernamespaceUri - the namespace of the attributelocalName - the local name of the attribute, cannot be null
public int getAttributeCount()
XMLStreamReader
getAttributeCount in interface XMLStreamReaderpublic QName getAttributeName(int index)
XMLStreamReader
getAttributeName in interface XMLStreamReaderindex - the position of the attribute
public String getAttributePrefix(int index)
XMLStreamReader
getAttributePrefix in interface XMLStreamReaderindex - the position of the attribute
public String getAttributeNamespace(int index)
XMLStreamReader
getAttributeNamespace in interface XMLStreamReaderindex - the position of the attribute
public String getAttributeLocalName(int index)
XMLStreamReader
getAttributeLocalName in interface XMLStreamReaderindex - the position of the attribute
public String getAttributeType(int index)
XMLStreamReader
getAttributeType in interface XMLStreamReaderindex - the position of the attribute
public String getAttributeValue(int index)
XMLStreamReader
getAttributeValue in interface XMLStreamReaderindex - the position of the attribute
public boolean isAttributeSpecified(int index)
XMLStreamReader
isAttributeSpecified in interface XMLStreamReaderindex - the position of the attribute
public int getNamespaceCount()
XMLStreamReader
getNamespaceCount in interface XMLStreamReaderpublic String getNamespacePrefix(int index)
XMLStreamReader
getNamespacePrefix in interface XMLStreamReaderindex - the position of the namespace declaration
public String getNamespaceURI(int index)
XMLStreamReader
getNamespaceURI in interface XMLStreamReaderindex - the position of the namespace declaration
public int getEventType()
XMLStreamReader
getEventType in interface XMLStreamReaderpublic String getText()
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 XMLStreamReadersourceStart - 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 copy
XMLStreamException - if the underlying XML source is not well-formedpublic char[] getTextCharacters()
XMLStreamReader
getTextCharacters in interface XMLStreamReaderpublic int getTextStart()
XMLStreamReader
getTextStart in interface XMLStreamReaderpublic int getTextLength()
XMLStreamReader
getTextLength in interface XMLStreamReaderpublic String getEncoding()
XMLStreamReader
getEncoding in interface XMLStreamReaderpublic boolean hasText()
XMLStreamReader
hasText in interface XMLStreamReaderpublic Location getLocation()
XMLStreamReader
getLocation in interface XMLStreamReaderpublic QName getName()
XMLStreamReader
getName in interface XMLStreamReaderpublic String getLocalName()
XMLStreamReader
getLocalName in interface XMLStreamReaderpublic boolean hasName()
XMLStreamReader
hasName in interface XMLStreamReaderpublic String getNamespaceURI()
XMLStreamReader
getNamespaceURI in interface XMLStreamReaderpublic String getPrefix()
XMLStreamReader
getPrefix in interface XMLStreamReaderpublic String getVersion()
XMLStreamReader
getVersion in interface XMLStreamReaderpublic boolean isStandalone()
XMLStreamReader
isStandalone in interface XMLStreamReaderpublic boolean standaloneSet()
XMLStreamReader
standaloneSet in interface XMLStreamReaderpublic String getCharacterEncodingScheme()
XMLStreamReader
getCharacterEncodingScheme in interface XMLStreamReaderpublic String getPITarget()
XMLStreamReader
getPITarget in interface XMLStreamReaderpublic String getPIData()
XMLStreamReader
getPIData in interface XMLStreamReaderpublic Object getProperty(String name)
XMLStreamReader
getProperty in interface XMLStreamReadername - The name of the property, may not be null
|
Java™ Platform Standard Ed. 6 |
|||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||
Copyright © 1993, 2010, Oracle and/or its affiliates. All rights reserved.