public class XMLStreamPlayer
extends java.lang.Object
implements javax.xml.stream.XMLStreamReader
Creates an XMLStreamReader over a non-xml ascii format
Constructor and Description |
---|
XMLStreamPlayer() |
XMLStreamPlayer(java.io.InputStream stream) |
XMLStreamPlayer(java.io.Reader reader) |
Modifier and Type | Method and Description |
---|---|
void |
close()
Frees any resources associated with this Reader.
|
boolean |
endDocumentIsPresent() |
int |
getAttributeCount()
Returns the count of attributes on this START_ELEMENT,
this method is only valid on a START_ELEMENT or ATTRIBUTE.
|
java.lang.String |
getAttributeLocalName(int index)
Returns the localName of the attribute at the provided
index
|
javax.xml.namespace.QName |
getAttributeName(int index)
Returns the qname of the attribute at the provided index
|
java.lang.String |
getAttributeNamespace(int index)
Returns the namespace of the attribute at the provided
index
|
java.lang.String |
getAttributePrefix(int index)
Returns the prefix of this attribute at the
provided index
|
java.lang.String |
getAttributeType(int index)
Returns the XML type of the attribute at the provided
index
|
java.lang.String |
getAttributeValue(int index)
Returns the value of the attribute at the
index
|
java.lang.String |
getAttributeValue(java.lang.String namespaceUri,
java.lang.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
|
java.lang.String |
getCharacterEncodingScheme()
Returns the character encoding declared on the xml declaration
Returns null if none was declared
|
java.lang.String |
getElementText()
Reads the content of a text-only element, an exception is thrown if this is
not a text-only element.
|
java.lang.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.
|
java.lang.String |
getLocalName()
Returns the (local) name of the current event.
|
javax.xml.stream.Location |
getLocation()
Return the current location of the processor.
|
javax.xml.namespace.QName |
getName()
Returns a QName for the current START_ELEMENT or END_ELEMENT event
|
javax.xml.namespace.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.
|
java.lang.String |
getNamespacePrefix(int index)
Returns the prefix for the namespace declared at the
index.
|
java.lang.String |
getNamespaceURI()
If the current event is a START_ELEMENT or END_ELEMENT this method
returns the URI of the current element (URI mapping to the prefix
element/attribute has, if any; or if no prefix, null for attribute,
and the default namespace URI for the element).
|
java.lang.String |
getNamespaceURI(int index)
Returns the uri for the namespace declared at the
index.
|
java.lang.String |
getNamespaceURI(java.lang.String prefix)
Return the uri for the given prefix.
|
java.lang.String |
getPIData()
Get the data section of a processing instruction
|
java.lang.String |
getPITarget()
Get the target of a processing instruction
|
java.lang.String |
getPrefix()
Returns the prefix of the current event or null if the event does not
have a prefix
|
java.lang.Object |
getProperty(java.lang.String name)
Get the value of a feature/property from the underlying implementation
|
java.lang.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 src,
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.
|
java.io.Reader |
getTextStream() |
java.lang.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, if one found
(
XMLStreamReader.standaloneSet() returns true if one was specified). |
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
|
static void |
main(java.lang.String[] args) |
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,
java.lang.String namespaceURI,
java.lang.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.
|
boolean |
standaloneSet()
Checks if standalone was set in the document
|
javax.xml.stream.XMLStreamReader |
subReader() |
public XMLStreamPlayer()
public XMLStreamPlayer(java.io.InputStream stream)
public XMLStreamPlayer(java.io.Reader reader)
public java.lang.Object getProperty(java.lang.String name) throws java.lang.IllegalArgumentException
javax.xml.stream.XMLStreamReader
getProperty
in interface javax.xml.stream.XMLStreamReader
name
- The name of the property, may not be nulljava.lang.IllegalArgumentException
- if name is nullpublic int next() throws javax.xml.stream.XMLStreamException
javax.xml.stream.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 javax.xml.stream.XMLStreamReader
javax.xml.stream.XMLStreamException
- if there is an error processing the underlying XML sourceXMLEvent
public void require(int type, java.lang.String namespaceURI, java.lang.String localName) throws javax.xml.stream.XMLStreamException
javax.xml.stream.XMLStreamReader
require
in interface javax.xml.stream.XMLStreamReader
type
- the event typenamespaceURI
- the uri of the event, may be nulllocalName
- the localName of the event, may be nulljavax.xml.stream.XMLStreamException
- if the required values are not matched.public java.lang.String getElementText() throws javax.xml.stream.XMLStreamException
javax.xml.stream.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 javax.xml.stream.XMLStreamReader
javax.xml.stream.XMLStreamException
- if the current event is not a START_ELEMENT
or if a non text element is encounteredpublic int nextTag() throws javax.xml.stream.XMLStreamException
javax.xml.stream.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 javax.xml.stream.XMLStreamReader
javax.xml.stream.XMLStreamException
- if the current event is not white space, PROCESSING_INSTRUCTION,
START_ELEMENT or END_ELEMENTpublic boolean hasNext() throws javax.xml.stream.XMLStreamException
javax.xml.stream.XMLStreamReader
hasNext
in interface javax.xml.stream.XMLStreamReader
javax.xml.stream.XMLStreamException
- if there is a fatal error detecting the next statepublic void close() throws javax.xml.stream.XMLStreamException
javax.xml.stream.XMLStreamReader
close
in interface javax.xml.stream.XMLStreamReader
javax.xml.stream.XMLStreamException
- if there are errors freeing associated resourcespublic java.lang.String getNamespaceURI(java.lang.String prefix)
javax.xml.stream.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 javax.xml.stream.XMLStreamReader
prefix
- The prefix to lookup, may not be nullpublic boolean isStartElement()
javax.xml.stream.XMLStreamReader
isStartElement
in interface javax.xml.stream.XMLStreamReader
public boolean isEndElement()
javax.xml.stream.XMLStreamReader
isEndElement
in interface javax.xml.stream.XMLStreamReader
public boolean isCharacters()
javax.xml.stream.XMLStreamReader
isCharacters
in interface javax.xml.stream.XMLStreamReader
public boolean isWhiteSpace()
javax.xml.stream.XMLStreamReader
isWhiteSpace
in interface javax.xml.stream.XMLStreamReader
public java.lang.String getAttributeValue(java.lang.String namespaceUri, java.lang.String localName)
javax.xml.stream.XMLStreamReader
getAttributeValue
in interface javax.xml.stream.XMLStreamReader
namespaceUri
- the namespace of the attributelocalName
- the local name of the attribute, cannot be nullpublic int getAttributeCount()
javax.xml.stream.XMLStreamReader
getAttributeCount
in interface javax.xml.stream.XMLStreamReader
public javax.xml.namespace.QName getAttributeName(int index)
javax.xml.stream.XMLStreamReader
getAttributeName
in interface javax.xml.stream.XMLStreamReader
index
- the position of the attributepublic java.lang.String getAttributeNamespace(int index)
javax.xml.stream.XMLStreamReader
getAttributeNamespace
in interface javax.xml.stream.XMLStreamReader
index
- the position of the attributepublic java.lang.String getAttributeLocalName(int index)
javax.xml.stream.XMLStreamReader
getAttributeLocalName
in interface javax.xml.stream.XMLStreamReader
index
- the position of the attributepublic java.lang.String getAttributePrefix(int index)
javax.xml.stream.XMLStreamReader
getAttributePrefix
in interface javax.xml.stream.XMLStreamReader
index
- the position of the attributepublic java.lang.String getAttributeType(int index)
javax.xml.stream.XMLStreamReader
getAttributeType
in interface javax.xml.stream.XMLStreamReader
index
- the position of the attributepublic java.lang.String getAttributeValue(int index)
javax.xml.stream.XMLStreamReader
getAttributeValue
in interface javax.xml.stream.XMLStreamReader
index
- the position of the attributepublic boolean isAttributeSpecified(int index)
javax.xml.stream.XMLStreamReader
isAttributeSpecified
in interface javax.xml.stream.XMLStreamReader
index
- the position of the attributepublic int getNamespaceCount()
javax.xml.stream.XMLStreamReader
getNamespaceCount
in interface javax.xml.stream.XMLStreamReader
public java.lang.String getNamespacePrefix(int index)
javax.xml.stream.XMLStreamReader
getNamespacePrefix
in interface javax.xml.stream.XMLStreamReader
index
- the position of the namespace declarationpublic java.lang.String getNamespaceURI(int index)
javax.xml.stream.XMLStreamReader
getNamespaceURI
in interface javax.xml.stream.XMLStreamReader
index
- the position of the namespace declarationpublic javax.xml.namespace.NamespaceContext getNamespaceContext()
javax.xml.stream.XMLStreamReader
getNamespaceContext
in interface javax.xml.stream.XMLStreamReader
public javax.xml.stream.XMLStreamReader subReader() throws javax.xml.stream.XMLStreamException
javax.xml.stream.XMLStreamException
public int getEventType()
javax.xml.stream.XMLStreamReader
getEventType
in interface javax.xml.stream.XMLStreamReader
public java.lang.String getText()
javax.xml.stream.XMLStreamReader
getText
in interface javax.xml.stream.XMLStreamReader
public java.io.Reader getTextStream()
public char[] getTextCharacters()
javax.xml.stream.XMLStreamReader
getTextCharacters
in interface javax.xml.stream.XMLStreamReader
public int getTextCharacters(int src, char[] target, int targetStart, int length) throws javax.xml.stream.XMLStreamException
javax.xml.stream.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 javax.xml.stream.XMLStreamReader
src
- 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 copyjavax.xml.stream.XMLStreamException
- if the underlying XML source is not well-formedpublic int getTextStart()
javax.xml.stream.XMLStreamReader
getTextStart
in interface javax.xml.stream.XMLStreamReader
public int getTextLength()
javax.xml.stream.XMLStreamReader
getTextLength
in interface javax.xml.stream.XMLStreamReader
public java.lang.String getEncoding()
javax.xml.stream.XMLStreamReader
getEncoding
in interface javax.xml.stream.XMLStreamReader
public boolean hasText()
javax.xml.stream.XMLStreamReader
hasText
in interface javax.xml.stream.XMLStreamReader
public javax.xml.stream.Location getLocation()
javax.xml.stream.XMLStreamReader
getLocation
in interface javax.xml.stream.XMLStreamReader
public javax.xml.namespace.QName getName()
javax.xml.stream.XMLStreamReader
getName
in interface javax.xml.stream.XMLStreamReader
public java.lang.String getLocalName()
javax.xml.stream.XMLStreamReader
getLocalName
in interface javax.xml.stream.XMLStreamReader
public boolean hasName()
javax.xml.stream.XMLStreamReader
hasName
in interface javax.xml.stream.XMLStreamReader
public java.lang.String getNamespaceURI()
javax.xml.stream.XMLStreamReader
getNamespaceURI
in interface javax.xml.stream.XMLStreamReader
public java.lang.String getPrefix()
javax.xml.stream.XMLStreamReader
getPrefix
in interface javax.xml.stream.XMLStreamReader
public java.lang.String getVersion()
javax.xml.stream.XMLStreamReader
getVersion
in interface javax.xml.stream.XMLStreamReader
public boolean isStandalone()
javax.xml.stream.XMLStreamReader
XMLStreamReader.standaloneSet()
returns true if one was specified).isStandalone
in interface javax.xml.stream.XMLStreamReader
public boolean standaloneSet()
javax.xml.stream.XMLStreamReader
standaloneSet
in interface javax.xml.stream.XMLStreamReader
public java.lang.String getCharacterEncodingScheme()
javax.xml.stream.XMLStreamReader
getCharacterEncodingScheme
in interface javax.xml.stream.XMLStreamReader
public java.lang.String getPITarget()
javax.xml.stream.XMLStreamReader
getPITarget
in interface javax.xml.stream.XMLStreamReader
public java.lang.String getPIData()
javax.xml.stream.XMLStreamReader
getPIData
in interface javax.xml.stream.XMLStreamReader
public boolean endDocumentIsPresent()
public static void main(java.lang.String[] args) throws java.lang.Exception
java.lang.Exception