Class MXParser
- All Implemented Interfaces:
Location
,XMLStreamConstants
,XMLStreamReader
- Author:
- Aleksander Slominski
-
Field Summary
FieldsModifier and TypeFieldDescriptionprotected boolean
Implementation notice: the is instance variable that controls if newString() is interning.protected int
protected String[]
protected int[]
protected String[]
protected String[]
protected String[]
protected char[]
Logics for this should be clarified...protected int
protected int
protected int
protected int
protected int
protected static final char
protected String
protected char[]
This buffer is used for expanding single character (non-surrogate) character entity expansions.protected char[]
This buffer is used in cases where an entity expands to a surrogate pair.protected int
protected HashMap
protected int
protected String[]
protected int[]
protected String[]
protected char[][]
protected int[]
protected String[]
protected boolean
protected static final char[]
protected int
protected String[]
protected char[][]
protected int[]
protected String
protected String[]
protected char[][]
protected char[]
Replacement value for the current entity, when automatic entity expansion is disabled.protected int
protected static final String
static final String
static final String
static final String
static final String
protected static final String
protected String
protected int
protected int
protected String[]
protected int[]
protected String[]
protected static final int
protected static final char
protected static boolean[]
protected static boolean[]
protected static final int
protected com.wutka.dtd.DTD
If the internal DTD subset was parsed, this object will be non-null, and can be used for accessing entities, elements and notations declared in the internal subset.protected int
protected String[]
protected int[]
protected String[]
protected static final char[]
static final String
This constant defines URI used for "no namespace" (when the default namespace not defined, for elements; when attribute has no prefix, or for all URIs if namespace support is disabled).protected boolean
protected char[]
protected int
protected int
protected String
protected String
protected int
protected int
protected int
protected boolean
protected boolean
protected static final int
protected Reader
protected boolean
protected boolean
protected boolean
protected boolean
protected boolean
protected boolean
protected boolean
protected boolean
Flag that indicates whether 'standalone="yes"' was found from the xml declaration.protected static final char[]
protected boolean
protected String
Lazily-constructed String that contains what getText() returns; cleared by tokenizer before parsing new eventsprotected boolean
static final String[]
These constants are used for diagnostics messages, and need to match with ones fromXMLStreamConstants
.protected boolean
protected static final char[]
protected String
XML version found from the xml declaration, if any.protected static final char[]
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
Constructors -
Method Summary
Modifier and TypeMethodDescriptionprotected void
addDefaultAttributes
(String elementName) protected void
checkCharValidity
(int ch, boolean surrogatesOk) boolean
void
close()
Frees any resources associated with this Reader.void
defineEntityReplacementText
(String entityName, String replacementText) protected void
ensureAttributesCapacity
(int size) Make sure that in attributes temporary array is enough space.protected void
Make sure that we have enough space to keep element stack if passed size.protected void
protected void
ensureLocalNamespacesCapacity
(int size) protected void
ensureNamespacesCapacity
(int size) protected void
ensurePC
(int end) protected static final int
fastHash
(char[] ch, int off, int len) simplistic implementation of hash function that has constant time to compute - so it also means diminishing hash quality for long strings but for XML parsing it should be good enough ...protected void
fillBuf()
int
Returns the count of attributes on this START_ELEMENT, this method is only valid on a START_ELEMENT or ATTRIBUTE.getAttributeLocalName
(int index) Returns the localName of the attribute at the provided indexgetAttributeName
(int index) Returns the qname of the attribute at the provided indexgetAttributeNamespace
(int index) Returns the namespace of the attribute at the provided indexgetAttributePrefix
(int index) Returns the prefix of this attribute at the provided indexgetAttributeType
(int index) Returns the XML type of the attribute at the provided indexgetAttributeValue
(int index) Returns the value of the attribute at the indexgetAttributeValue
(String namespace, String name) Returns the normalized attribute value of the attribute with the namespace and localName If the namespaceURI is null the namespace is not checked for equalityReturns the character encoding declared on the xml declaration Returns null if none was declaredint
Return the byte or character offset into the input source this location is pointing to.int
Return the column number where the current event ends, returns -1 if none is available.int
getDepth()
Reads the content of a text-only element, an exception is thrown if this is not a text-only element.Return input encoding if known or null if unknown.int
Returns an integer code that indicates the type of the event the cursor is pointing to.boolean
getFeature
(String name) Unknown properties arealways returned as false int
Return the line number where the current event ends, returns -1 if none is available.Returns the (local) name of the current event.int
Return the current location of the processor.getName()
Returns a QName for the current START_ELEMENT or END_ELEMENT eventReturns a read only namespace context for the current position.int
Returns the count of namespaces declared on this START_ELEMENT or END_ELEMENT.int
getNamespaceCount
(int depth) getNamespacePrefix
(int pos) Returns the prefix for the namespace declared at the index.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).getNamespaceURI
(int pos) Returns the uri for the namespace declared at the index.getNamespaceURI
(String prefix) Return the uri for the given prefix.Get the data section of a processing instructionGet the target of a processing instructionReturn string describing current position of parsers as text 'STATE [seen %s...] @line:column'.Returns the prefix of the current event or null if the event does not have a prefixgetProperty
(String name) Get the value of a feature/property from the underlying implementationReturns the public ID of the XMLReturns the system ID of the XMLgetText()
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[]
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
Returns the length of the sequence of characters for this Text event within the text character array.int
Returns the offset into the text character array where the first character (of this text event) is stored.getValue()
Get the xml version declared on the xml declaration Returns null if none was declaredboolean
boolean
hasName()
returns true if the current event has a name (is a START_ELEMENT or END_ELEMENT) returns false otherwiseboolean
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, SPACEinternalGetNamespaces
(int depth, int namespaceCount) boolean
isAttributeSpecified
(int index) Returns a boolean which indicates if this attribute was created by defaultboolean
Returns true if the cursor points to a character data eventboolean
boolean
Returns true if the cursor points to an end tag (otherwise false)boolean
isEOF()
protected boolean
isNameChar
(char ch) protected boolean
isNameStartChar
(char ch) protected boolean
isS
(char ch) boolean
Get the standalone declaration from the xml declaration, if one found (XMLStreamReader.standaloneSet()
returns true if one was specified).boolean
Returns true if the cursor points to a start tag (otherwise false)boolean
Returns true if the cursor points to a character data event that consists of all whitespaceprotected void
joinPC()
protected char[]
lookupEntityReplacement
(int entitNameLen) protected char
more()
boolean
boolean
moveToEndElement
(String localName) boolean
moveToEndElement
(String localName, String namespaceUri) boolean
boolean
moveToStartElement
(String localName) boolean
moveToStartElement
(String localName, String namespaceUri) protected String
newString
(char[] cbuf, int off, int len) protected String
newStringIntern
(char[] cbuf, int off, int len) 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
protected int
nextImpl()
int
nextTag()
Skips any white space (isWhiteSpace() returns true), COMMENT, or PROCESSING_INSTRUCTION, until a START_ELEMENT or END_ELEMENT is reached.nextText()
int
protected char
protected void
protected void
protected void
int
protected char[]
parseEntityRef
(boolean replace) protected int
protected boolean
parsePI()
protected int
int
protected void
parseXmlDecl
(char ch) protected void
parseXmlDeclWithVersion
(int versionStart, int versionEnd) protected String
printable
(char ch) protected String
protected void
void
recycle()
void
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.protected char
requireInput
(char ch, char[] input) protected char
protected void
void
void
setFeature
(String name, boolean state) Method setFeaturevoid
setInput
(InputStream in) void
setInput
(InputStream inputStream, String inputEncoding) void
void
setProperty
(String name, Object value) void
skip()
protected char
skipS
(char ch) boolean
Checks if standalone was set in the document
-
Field Details
-
CHAR_UTF8_BOM
protected static final char CHAR_UTF8_BOM- See Also:
-
MAX_UNICODE_CHAR
protected static final int MAX_UNICODE_CHAR- See Also:
-
FEATURE_XML_ROUNDTRIP
- See Also:
-
FEATURE_NAMES_INTERNED
- See Also:
-
FEATURE_PROCESS_DOCDECL
- See Also:
-
FEATURE_STAX_NOTATIONS
- See Also:
-
FEATURE_STAX_ENTITIES
- See Also:
-
TYPES
These constants are used for diagnostics messages, and need to match with ones fromXMLStreamConstants
. -
NO_NAMESPACE
This constant defines URI used for "no namespace" (when the default namespace not defined, for elements; when attribute has no prefix, or for all URIs if namespace support is disabled). -
allStringsInterned
protected boolean allStringsInternedImplementation notice: the is instance variable that controls if newString() is interning.NOTE: newStringIntern always returns interned strings and newString MAY return interned String depending on this variable.
NOTE: by default in this minimal implementation it is false!
-
FEATURE_PROCESS_NAMESPACES
- See Also:
-
processNamespaces
protected boolean processNamespaces -
roundtripSupported
protected boolean roundtripSupported -
lineNumber
protected int lineNumber -
columnNumber
protected int columnNumber -
seenRoot
protected boolean seenRoot -
reachedEnd
protected boolean reachedEnd -
eventType
protected int eventType -
emptyElementTag
protected boolean emptyElementTag -
depth
protected int depth -
elRawName
protected char[][] elRawName -
elRawNameEnd
protected int[] elRawNameEnd -
elName
-
elPrefix
-
elUri
-
elNamespaceCount
protected int[] elNamespaceCount -
xmlVersion
XML version found from the xml declaration, if any. -
standalone
protected boolean standaloneFlag that indicates whether 'standalone="yes"' was found from the xml declaration. -
standaloneSet
protected boolean standaloneSet -
charEncodingScheme
-
piTarget
-
piData
-
mDtdIntSubset
protected com.wutka.dtd.DTD mDtdIntSubsetIf the internal DTD subset was parsed, this object will be non-null, and can be used for accessing entities, elements and notations declared in the internal subset. -
defaultAttributes
-
LOOKUP_MAX
protected static final int LOOKUP_MAX- See Also:
-
LOOKUP_MAX_CHAR
protected static final char LOOKUP_MAX_CHAR- See Also:
-
lookupNameStartChar
protected static boolean[] lookupNameStartChar -
lookupNameChar
protected static boolean[] lookupNameChar -
attributeCount
protected int attributeCount -
attributeName
-
attributeNameHash
protected int[] attributeNameHash -
attributePrefix
-
attributeUri
-
attributeValue
-
namespaceEnd
protected int namespaceEnd -
namespacePrefix
-
namespacePrefixHash
protected int[] namespacePrefixHash -
namespaceUri
-
localNamespaceEnd
protected int localNamespaceEnd -
localNamespacePrefix
-
localNamespacePrefixHash
protected int[] localNamespacePrefixHash -
localNamespaceUri
-
entityEnd
protected int entityEnd -
entityName
-
entityNameBuf
protected char[][] entityNameBuf -
entityNameHash
protected int[] entityNameHash -
entityReplacementBuf
protected char[][] entityReplacementBuf -
entityReplacement
-
READ_CHUNK_SIZE
protected static final int READ_CHUNK_SIZE- See Also:
-
reader
-
inputEncoding
-
bufLoadFactor
protected int bufLoadFactor -
buf
protected char[] bufLogics for this should be clarified... but it looks like we use a 8k buffer if there's 1M of free memory or more, otherwise just 256 bytes? -
bufSoftLimit
protected int bufSoftLimit -
bufAbsoluteStart
protected int bufAbsoluteStart -
bufStart
protected int bufStart -
bufEnd
protected int bufEnd -
pos
protected int pos -
posStart
protected int posStart -
posEnd
protected int posEnd -
pc
protected char[] pc -
pcStart
protected int pcStart -
pcEnd
protected int pcEnd -
usePC
protected boolean usePC -
seenStartTag
protected boolean seenStartTag -
seenEndTag
protected boolean seenEndTag -
pastEndTag
protected boolean pastEndTag -
seenAmpersand
protected boolean seenAmpersand -
seenMarkup
protected boolean seenMarkup -
seenDocdecl
protected boolean seenDocdecl -
tokenize
protected boolean tokenize -
text
Lazily-constructed String that contains what getText() returns; cleared by tokenizer before parsing new events -
entityRefName
-
entityValue
protected char[] entityValueReplacement value for the current entity, when automatic entity expansion is disabled. Will always refer to some other array; either globally shared ones (for general entities), or the temp buffer for char entities. As such, does not need to be cleared by tokenizer: will get properly overwritten as needed -
charRefOneCharBuf
protected char[] charRefOneCharBufThis buffer is used for expanding single character (non-surrogate) character entity expansions. -
charRefTwoCharBuf
protected char[] charRefTwoCharBufThis buffer is used in cases where an entity expands to a surrogate pair. Since this is a rare occurence, it's lazily created if needed. -
VERSION
protected static final char[] VERSION -
ENCODING
protected static final char[] ENCODING -
STANDALONE
protected static final char[] STANDALONE -
YES
protected static final char[] YES -
NO
protected static final char[] NO
-
-
Constructor Details
-
MXParser
public MXParser()
-
-
Method Details
-
resetStringCache
protected void resetStringCache() -
newString
-
newStringIntern
-
ensureElementsCapacity
protected void ensureElementsCapacity()Make sure that we have enough space to keep element stack if passed size. It will always create one additional slot then current depth -
isNameStartChar
protected boolean isNameStartChar(char ch) -
isNameChar
protected boolean isNameChar(char ch) -
isS
protected boolean isS(char ch) -
checkCharValidity
- Throws:
XMLStreamException
-
ensureAttributesCapacity
protected void ensureAttributesCapacity(int size) Make sure that in attributes temporary array is enough space. -
ensureNamespacesCapacity
protected void ensureNamespacesCapacity(int size) -
ensureLocalNamespacesCapacity
protected void ensureLocalNamespacesCapacity(int size) -
getLocalNamespaceCount
public int getLocalNamespaceCount() -
fastHash
protected static final int fastHash(char[] ch, int off, int len) simplistic implementation of hash function that has constant time to compute - so it also means diminishing hash quality for long strings but for XML parsing it should be good enough ... -
ensureEntityCapacity
protected void ensureEntityCapacity() -
setFeature
Method setFeature- Parameters:
name
- a Stringstate
- a boolean- Throws:
XMLStreamException
-
getFeature
Unknown properties arealways returned as false -
setProperty
- Throws:
XMLStreamException
-
checkForXMLDecl
- Throws:
XMLStreamException
-
setInput
- Throws:
XMLStreamException
-
setInput
- Throws:
XMLStreamException
-
setInput
- Throws:
XMLStreamException
-
getInputEncoding
-
defineEntityReplacementText
public void defineEntityReplacementText(String entityName, String replacementText) throws XMLStreamException - Throws:
XMLStreamException
-
getNamespaceCount
public int getNamespaceCount()Description copied from interface:javax.xml.stream.XMLStreamReader
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.- Specified by:
getNamespaceCount
in interfaceXMLStreamReader
- Returns:
- returns the number of namespace declarations on this specific element
-
getNamespaceCount
public int getNamespaceCount(int depth) -
getNamespacePrefix
Description copied from interface:javax.xml.stream.XMLStreamReader
Returns the prefix for the namespace declared at the index. Returns null if this is the default namespace declaration- Specified by:
getNamespacePrefix
in interfaceXMLStreamReader
- Parameters:
pos
- the position of the namespace declaration- Returns:
- returns the namespace prefix
-
getNamespaceURI
Description copied from interface:javax.xml.stream.XMLStreamReader
Returns the uri for the namespace declared at the index.- Specified by:
getNamespaceURI
in interfaceXMLStreamReader
- Parameters:
pos
- the position of the namespace declaration- Returns:
- returns the namespace uri
-
getNamespaceURI
Description copied from interface:javax.xml.stream.XMLStreamReader
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/
- Specified by:
getNamespaceURI
in interfaceXMLStreamReader
- Parameters:
prefix
- The prefix to lookup, may not be null- Returns:
- the uri bound to the given prefix or null if it is not bound
-
getDepth
public int getDepth() -
getPositionDescription
Return string describing current position of parsers as text 'STATE [seen %s...] @line:column'. -
getLineNumber
public int getLineNumber()Description copied from interface:javax.xml.stream.Location
Return the line number where the current event ends, returns -1 if none is available.- Specified by:
getLineNumber
in interfaceLocation
- Returns:
- the current line number
-
getColumnNumber
public int getColumnNumber()Description copied from interface:javax.xml.stream.Location
Return the column number where the current event ends, returns -1 if none is available.- Specified by:
getColumnNumber
in interfaceLocation
- Returns:
- the current column number
-
getLocationURI
-
isWhiteSpace
public boolean isWhiteSpace()Description copied from interface:javax.xml.stream.XMLStreamReader
Returns true if the cursor points to a character data event that consists of all whitespace- Specified by:
isWhiteSpace
in interfaceXMLStreamReader
- Returns:
- true if the cursor points to all whitespace, false otherwise
-
getNamespaceURI
Description copied from interface:javax.xml.stream.XMLStreamReader
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).- Specified by:
getNamespaceURI
in interfaceXMLStreamReader
- Returns:
- the URI bound to this elements prefix, the default namespace, or null
-
getLocalName
Description copied from interface:javax.xml.stream.XMLStreamReader
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- Specified by:
getLocalName
in interfaceXMLStreamReader
- Returns:
- the localName
-
getPrefix
Description copied from interface:javax.xml.stream.XMLStreamReader
Returns the prefix of the current event or null if the event does not have a prefix- Specified by:
getPrefix
in interfaceXMLStreamReader
- Returns:
- the prefix or null
-
isEmptyElementTag
- Throws:
XMLStreamException
-
getAttributeCount
public int getAttributeCount()Description copied from interface:javax.xml.stream.XMLStreamReader
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.- Specified by:
getAttributeCount
in interfaceXMLStreamReader
- Returns:
- returns the number of attributes
-
getAttributeNamespace
Description copied from interface:javax.xml.stream.XMLStreamReader
Returns the namespace of the attribute at the provided index- Specified by:
getAttributeNamespace
in interfaceXMLStreamReader
- Parameters:
index
- the position of the attribute- Returns:
- the namespace URI (can be null)
-
getAttributeLocalName
Description copied from interface:javax.xml.stream.XMLStreamReader
Returns the localName of the attribute at the provided index- Specified by:
getAttributeLocalName
in interfaceXMLStreamReader
- Parameters:
index
- the position of the attribute- Returns:
- the localName of the attribute
-
getAttributePrefix
Description copied from interface:javax.xml.stream.XMLStreamReader
Returns the prefix of this attribute at the provided index- Specified by:
getAttributePrefix
in interfaceXMLStreamReader
- Parameters:
index
- the position of the attribute- Returns:
- the prefix of the attribute
-
getAttributeType
Description copied from interface:javax.xml.stream.XMLStreamReader
Returns the XML type of the attribute at the provided index- Specified by:
getAttributeType
in interfaceXMLStreamReader
- Parameters:
index
- the position of the attribute- Returns:
- the XML type of the attribute
-
isAttributeSpecified
public boolean isAttributeSpecified(int index) Description copied from interface:javax.xml.stream.XMLStreamReader
Returns a boolean which indicates if this attribute was created by default- Specified by:
isAttributeSpecified
in interfaceXMLStreamReader
- Parameters:
index
- the position of the attribute- Returns:
- true if this is a default attribute
-
getAttributeValue
Description copied from interface:javax.xml.stream.XMLStreamReader
Returns the value of the attribute at the index- Specified by:
getAttributeValue
in interfaceXMLStreamReader
- Parameters:
index
- the position of the attribute- Returns:
- the attribute value
-
getAttributeValue
Description copied from interface:javax.xml.stream.XMLStreamReader
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- Specified by:
getAttributeValue
in interfaceXMLStreamReader
- Parameters:
namespace
- the namespace of the attributename
- the local name of the attribute, cannot be null- Returns:
- returns the value of the attribute , returns null if not found
-
getEventType
public int getEventType()Description copied from interface:javax.xml.stream.XMLStreamReader
Returns an integer code that indicates the type of the event the cursor is pointing to.- Specified by:
getEventType
in interfaceXMLStreamReader
-
require
Description copied from interface:javax.xml.stream.XMLStreamReader
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.- Specified by:
require
in interfaceXMLStreamReader
- Parameters:
type
- the event typenamespace
- the uri of the event, may be nullname
- the localName of the event, may be null- Throws:
XMLStreamException
- if the required values are not matched.
-
nextText
- Throws:
XMLStreamException
-
nextTag
Description copied from interface:javax.xml.stream.XMLStreamReader
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;
- Specified by:
nextTag
in interfaceXMLStreamReader
- Returns:
- the event type of the element read (START_ELEMENT or END_ELEMENT)
- Throws:
XMLStreamException
-
getElementText
Description copied from interface:javax.xml.stream.XMLStreamReader
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();
- Specified by:
getElementText
in interfaceXMLStreamReader
- Throws:
XMLStreamException
- if the current event is not a START_ELEMENT or if a non text element is encountered
-
next
Description copied from interface:javax.xml.stream.XMLStreamReader
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.
- Specified by:
next
in interfaceXMLStreamReader
- Returns:
- the integer code corresponding to the current parse event
- Throws:
XMLStreamException
- See Also:
-
nextToken
- Throws:
XMLStreamException
-
nextElement
- Throws:
XMLStreamException
-
hasNext
Description copied from interface:javax.xml.stream.XMLStreamReader
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- Specified by:
hasNext
in interfaceXMLStreamReader
- Returns:
- true if there are more events, false otherwise
- Throws:
XMLStreamException
- if there is a fatal error detecting the next state
-
skip
- Throws:
XMLStreamException
-
close
Description copied from interface:javax.xml.stream.XMLStreamReader
Frees any resources associated with this Reader. This method does not close the underlying input source.- Specified by:
close
in interfaceXMLStreamReader
- Throws:
XMLStreamException
- if there are errors freeing associated resources
-
isStartElement
public boolean isStartElement()Description copied from interface:javax.xml.stream.XMLStreamReader
Returns true if the cursor points to a start tag (otherwise false)- Specified by:
isStartElement
in interfaceXMLStreamReader
- Returns:
- true if the cursor points to a start tag, false otherwise
-
isEndElement
public boolean isEndElement()Description copied from interface:javax.xml.stream.XMLStreamReader
Returns true if the cursor points to an end tag (otherwise false)- Specified by:
isEndElement
in interfaceXMLStreamReader
- Returns:
- true if the cursor points to an end tag, false otherwise
-
isCharacters
public boolean isCharacters()Description copied from interface:javax.xml.stream.XMLStreamReader
Returns true if the cursor points to a character data event- Specified by:
isCharacters
in interfaceXMLStreamReader
- Returns:
- true if the cursor points to character data, false otherwise
-
isEOF
public boolean isEOF() -
moveToStartElement
- Throws:
XMLStreamException
-
moveToStartElement
- Throws:
XMLStreamException
-
moveToStartElement
- Throws:
XMLStreamException
-
moveToEndElement
- Throws:
XMLStreamException
-
moveToEndElement
- Throws:
XMLStreamException
-
moveToEndElement
- Throws:
XMLStreamException
-
hasAttributes
public boolean hasAttributes() -
hasNamespaces
public boolean hasNamespaces() -
getAttributes
-
internalGetNamespaces
-
getNamespaces
-
getOutOfScopeNamespaces
-
subReader
- Throws:
XMLStreamException
-
recycle
- Throws:
XMLStreamException
-
getTextStream
-
getText
Description copied from interface:javax.xml.stream.XMLStreamReader
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.- Specified by:
getText
in interfaceXMLStreamReader
- Returns:
- the current text or null
-
getTextCharacters
public int getTextCharacters(int sourceStart, char[] target, int targetStart, int length) throws XMLStreamException Description copied from interface:javax.xml.stream.XMLStreamReader
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 invalid input: '<' 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".- Specified by:
getTextCharacters
in interfaceXMLStreamReader
- Parameters:
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 copy- Returns:
- the number of characters actually copied
- Throws:
XMLStreamException
- if the underlying XML source is not well-formed
-
getTextCharacters
public char[] getTextCharacters()Description copied from interface:javax.xml.stream.XMLStreamReader
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.- Specified by:
getTextCharacters
in interfaceXMLStreamReader
- Returns:
- the current text or an empty array
-
getTextStart
public int getTextStart()Description copied from interface:javax.xml.stream.XMLStreamReader
Returns the offset into the text character array where the first character (of this text event) is stored.- Specified by:
getTextStart
in interfaceXMLStreamReader
-
getTextLength
public int getTextLength()Description copied from interface:javax.xml.stream.XMLStreamReader
Returns the length of the sequence of characters for this Text event within the text character array.- Specified by:
getTextLength
in interfaceXMLStreamReader
-
hasText
public boolean hasText()Description copied from interface:javax.xml.stream.XMLStreamReader
Return true if the current event has text, false otherwise The following events have text: CHARACTERS,DTD ,ENTITY_REFERENCE, COMMENT, SPACE- Specified by:
hasText
in interfaceXMLStreamReader
-
getValue
-
getEncoding
Description copied from interface:javax.xml.stream.XMLStreamReader
Return input encoding if known or null if unknown.- Specified by:
getEncoding
in interfaceXMLStreamReader
- Returns:
- the encoding of this instance or null
-
getCharacterOffset
public int getCharacterOffset()Description copied from interface:javax.xml.stream.Location
Return the byte or character offset into the input source this location is pointing to. If the input source is a file or a byte stream then this is the byte offset into that stream, but if the input source is a character media then the offset is the character offset. Returns -1 if there is no offset available.- Specified by:
getCharacterOffset
in interfaceLocation
- Returns:
- the current offset
-
getAttributeName
Description copied from interface:javax.xml.stream.XMLStreamReader
Returns the qname of the attribute at the provided index- Specified by:
getAttributeName
in interfaceXMLStreamReader
- Parameters:
index
- the position of the attribute- Returns:
- the QName of the attribute
-
getName
Description copied from interface:javax.xml.stream.XMLStreamReader
Returns a QName for the current START_ELEMENT or END_ELEMENT event- Specified by:
getName
in interfaceXMLStreamReader
- Returns:
- the QName for the current START_ELEMENT or END_ELEMENT event
-
hasName
public boolean hasName()Description copied from interface:javax.xml.stream.XMLStreamReader
returns true if the current event has a name (is a START_ELEMENT or END_ELEMENT) returns false otherwise- Specified by:
hasName
in interfaceXMLStreamReader
-
getVersion
Description copied from interface:javax.xml.stream.XMLStreamReader
Get the xml version declared on the xml declaration Returns null if none was declared- Specified by:
getVersion
in interfaceXMLStreamReader
- Returns:
- the XML version or null
-
isStandalone
public boolean isStandalone()Description copied from interface:javax.xml.stream.XMLStreamReader
Get the standalone declaration from the xml declaration, if one found (XMLStreamReader.standaloneSet()
returns true if one was specified).- Specified by:
isStandalone
in interfaceXMLStreamReader
- Returns:
- true if this is standalone, or false otherwise
-
standaloneSet
public boolean standaloneSet()Description copied from interface:javax.xml.stream.XMLStreamReader
Checks if standalone was set in the document- Specified by:
standaloneSet
in interfaceXMLStreamReader
- Returns:
- true if standalone was set in the document, or false otherwise
-
getCharacterEncodingScheme
Description copied from interface:javax.xml.stream.XMLStreamReader
Returns the character encoding declared on the xml declaration Returns null if none was declared- Specified by:
getCharacterEncodingScheme
in interfaceXMLStreamReader
- Returns:
- the encoding declared in the document or null
-
nextImpl
- Throws:
XMLStreamException
-
parseProlog
- Throws:
XMLStreamException
-
parseEpilog
- Throws:
XMLStreamException
-
parseEndTag
- Throws:
XMLStreamException
-
parseStartTag
- Throws:
XMLStreamException
-
addDefaultAttributes
- Throws:
XMLStreamException
-
parseAttribute
- Throws:
XMLStreamException
-
parseEntityRef
- Returns:
- Character array that contains value the reference expands to.
- Throws:
XMLStreamException
-
lookupEntityReplacement
- Returns:
- Character array that contains (unparsed) entity expansion value; or null if no such entity has been declared
- Throws:
XMLStreamException
-
parseComment
- Throws:
XMLStreamException
-
getPITarget
Description copied from interface:javax.xml.stream.XMLStreamReader
Get the target of a processing instruction- Specified by:
getPITarget
in interfaceXMLStreamReader
- Returns:
- the target
-
getPIData
Description copied from interface:javax.xml.stream.XMLStreamReader
Get the data section of a processing instruction- Specified by:
getPIData
in interfaceXMLStreamReader
- Returns:
- the data (if processing instruction has any), or null if the processing instruction only has target.
-
getNamespaceContext
Description copied from interface:javax.xml.stream.XMLStreamReader
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.- Specified by:
getNamespaceContext
in interfaceXMLStreamReader
- Returns:
- return a namespace context
-
parsePI
- Returns:
- True if this was the xml declaration; false if a regular processing instruction
- Throws:
XMLStreamException
-
requireInput
- Throws:
XMLStreamException
-
requireNextS
- Throws:
XMLStreamException
-
skipS
- Throws:
XMLStreamException
-
parseXmlDecl
- Throws:
XMLStreamException
-
parseXmlDeclWithVersion
- Throws:
XMLStreamException
-
parseDocdecl
- Throws:
XMLStreamException
-
processDTD
- Throws:
XMLStreamException
-
parseCDATA
- Throws:
XMLStreamException
-
fillBuf
- Throws:
XMLStreamException
EOFException
-
more
- Throws:
XMLStreamException
EOFException
-
printable
-
printable
-
ensurePC
protected void ensurePC(int end) -
joinPC
protected void joinPC() -
getLocation
Description copied from interface:javax.xml.stream.XMLStreamReader
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.- Specified by:
getLocation
in interfaceXMLStreamReader
-
getPublicId
Description copied from interface:javax.xml.stream.Location
Returns the public ID of the XML- Specified by:
getPublicId
in interfaceLocation
- Returns:
- the public ID, or null if not available
-
getSystemId
Description copied from interface:javax.xml.stream.Location
Returns the system ID of the XML- Specified by:
getSystemId
in interfaceLocation
- Returns:
- the system ID, or null if not available
-
setConfigurationContext
-
getConfigurationContext
-
getProperty
Description copied from interface:javax.xml.stream.XMLStreamReader
Get the value of a feature/property from the underlying implementation- Specified by:
getProperty
in interfaceXMLStreamReader
- Parameters:
name
- The name of the property, may not be null- Returns:
- The value of the property
-