FEATURE_NAMES_INTERNED
protected static final String FEATURE_NAMES_INTERNED
FEATURE_XML_ROUNDTRIP
protected static final String FEATURE_XML_ROUNDTRIP
LOOKUP_MAX
protected static final int LOOKUP_MAX
LOOKUP_MAX_CHAR
protected static final char LOOKUP_MAX_CHAR
NCODING
protected static final char[] NCODING
NO
protected static final char[] NO
PROPERTY_LOCATION
protected static final String PROPERTY_LOCATION
PROPERTY_XMLDECL_CONTENT
protected static final String PROPERTY_XMLDECL_CONTENT
PROPERTY_XMLDECL_STANDALONE
protected static final String PROPERTY_XMLDECL_STANDALONE
PROPERTY_XMLDECL_VERSION
protected static final String PROPERTY_XMLDECL_VERSION
READ_CHUNK_SIZE
protected static final int READ_CHUNK_SIZE
TANDALONE
protected static final char[] TANDALONE
TRACE_SIZING
private static final boolean TRACE_SIZING
VERSION
protected static final char[] VERSION
XMLNS_URI
protected static final String XMLNS_URI
XML_URI
protected static final String XML_URI
YES
protected static final char[] YES
allStringsInterned
protected boolean allStringsInterned
Implementation 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!
attributeCount
protected int attributeCount
attributeName
protected String[] attributeName
attributeNameHash
protected int[] attributeNameHash
attributePrefix
protected String[] attributePrefix
attributeUri
protected String[] attributeUri
attributeValue
protected String[] attributeValue
bufAbsoluteStart
protected int bufAbsoluteStart
bufEnd
protected int bufEnd
bufLoadFactor
protected int bufLoadFactor
bufSoftLimit
protected int bufSoftLimit
bufStart
protected int bufStart
charRefOneCharBuf
protected char[] charRefOneCharBuf
columnNumber
protected int columnNumber
elName
protected String[] elName
elNamespaceCount
protected int[] elNamespaceCount
elPrefix
protected String[] elPrefix
elRawName
protected char[][] elRawName
elRawNameEnd
protected int[] elRawNameEnd
elRawNameLine
protected int[] elRawNameLine
elUri
protected String[] elUri
emptyElementTag
protected boolean emptyElementTag
entityEnd
protected int entityEnd
entityName
protected String[] entityName
entityNameBuf
protected char[][] entityNameBuf
entityNameHash
protected int[] entityNameHash
entityRefName
protected String entityRefName
entityReplacement
protected String[] entityReplacement
entityReplacementBuf
protected char[][] entityReplacementBuf
eventType
protected int eventType
inputEncoding
protected String inputEncoding
lineNumber
protected int lineNumber
location
protected String location
lookupNameChar
protected static boolean[] lookupNameChar
lookupNameStartChar
protected static boolean[] lookupNameStartChar
namespaceEnd
protected int namespaceEnd
namespacePrefix
protected String[] namespacePrefix
namespacePrefixHash
protected int[] namespacePrefixHash
namespaceUri
protected String[] namespaceUri
pastEndTag
protected boolean pastEndTag
pcStart
protected int pcStart
posEnd
protected int posEnd
posStart
protected int posStart
preventBufferCompaction
protected boolean preventBufferCompaction
processNamespaces
protected boolean processNamespaces
reachedEnd
protected boolean reachedEnd
reader
protected Reader reader
roundtripSupported
protected boolean roundtripSupported
seenAmpersand
protected boolean seenAmpersand
seenDocdecl
protected boolean seenDocdecl
seenEndTag
protected boolean seenEndTag
seenMarkup
protected boolean seenMarkup
seenRoot
protected boolean seenRoot
seenStartTag
protected boolean seenStartTag
text
protected String text
tokenize
protected boolean tokenize
usePC
protected boolean usePC
xmlDeclContent
protected String xmlDeclContent
xmlDeclStandalone
protected Boolean xmlDeclStandalone
xmlDeclVersion
protected String xmlDeclVersion
defineEntityReplacementText
public void defineEntityReplacementText(String entityName,
String replacementText)
throws XmlPullParserException
Set new value for entity replacement text as defined in
XML 1.0 Section 4.5
Construction of Internal Entity Replacement Text.
If FEATURE_PROCESS_DOCDECL or FEATURE_VALIDATION are set, calling this
function will result in an exception -- when processing of DOCDECL is
enabled, there is no need to the entity replacement text manually.
The motivation for this function is to allow very small
implementations of XMLPULL that will work in J2ME environments.
Though these implementations may not be able to process the document type
declaration, they still can work with known DTDs by using this function.
Please notes: The given value is used literally as replacement text
and it corresponds to declaring entity in DTD that has all special characters
escaped: left angle bracket is replaced with <, ampersnad with &
and so on.
Note: The given value is the literal replacement text and must not
contain any other entity reference (if it contains any entity reference
there will be no further replacement).
Note: The list of pre-defined entity names will
always contain standard XML entities such as
amp (&), lt (<), gt (>), quot ("), and apos (').
Those cannot be redefined by this method!
- defineEntityReplacementText in interface XmlPullParser
ensureAttributesCapacity
protected void ensureAttributesCapacity(int size)
Make sure that in attributes temporary array is enough space.
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
ensureEntityCapacity
protected void ensureEntityCapacity()
ensureNamespacesCapacity
protected void ensureNamespacesCapacity(int size)
ensurePC
protected void ensurePC(int end)
fastHash
protected static final int fastHash(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 ...
findFragment
private static int findFragment(int bufMinPos,
char[] b,
int start,
int end)
getAttributeCount
public int getAttributeCount()
Returns the number of attributes of the current start tag, or
-1 if the current event type is not START_TAG
- getAttributeCount in interface XmlPullParser
getAttributeName
public String getAttributeName(int index)
Returns the local name of the specified attribute
if namespaces are enabled or just attribute name if namespaces are disabled.
Throws an IndexOutOfBoundsException if the index is out of range
or current event type is not START_TAG.
- getAttributeName in interface XmlPullParser
- attribute name (null is never returned)
getAttributeNamespace
public String getAttributeNamespace(int index)
Returns the namespace URI of the attribute
with the given index (starts from 0).
Returns an empty string ("") if namespaces are not enabled
or the attribute has no namespace.
Throws an IndexOutOfBoundsException if the index is out of range
or the current event type is not START_TAG.
NOTE: if FEATURE_REPORT_NAMESPACE_ATTRIBUTES is set
then namespace attributes (xmlns:ns='...') must be reported
with namespace
http://www.w3.org/2000/xmlns/
(visit this URL for description!).
The default namespace attribute (xmlns="...") will be reported with empty namespace.
NOTE:The xml prefix is bound as defined in
Namespaces in XML
specification to "http://www.w3.org/XML/1998/namespace".
- getAttributeNamespace in interface XmlPullParser
- attribute namespace,
empty string ("") is returned if namesapces processing is not enabled or
namespaces processing is enabled but attribute has no namespace (it has no prefix).
getAttributePrefix
public String getAttributePrefix(int index)
Returns the prefix of the specified attribute
Returns null if the element has no prefix.
If namespaces are disabled it will always return null.
Throws an IndexOutOfBoundsException if the index is out of range
or current event type is not START_TAG.
- getAttributePrefix in interface XmlPullParser
- attribute prefix or null if namespaces processing is not enabled.
getAttributeType
public String getAttributeType(int index)
Returns the type of the specified attribute
If parser is non-validating it MUST return CDATA.
- getAttributeType in interface XmlPullParser
- attribute type (null is never returned)
getAttributeValue
public String getAttributeValue(String namespace,
String name)
Returns the attributes value identified by namespace URI and namespace localName.
If namespaces are disabled namespace must be null.
If current event type is not START_TAG then IndexOutOfBoundsException will be thrown.
NOTE: attribute value must be normalized
(including entity replacement text if PROCESS_DOCDECL is false) as described in
XML 1.0 section
3.3.3 Attribute-Value Normalization
- getAttributeValue in interface XmlPullParser
namespace
- Namespace of the attribute if namespaces are enabled otherwise must be nullname
- If namespaces enabled local name of attribute otherwise just attribute name
- value of attribute or null if attribute with given name does not exist
getAttributeValue
public String getAttributeValue(int index)
Returns the given attributes value.
Throws an IndexOutOfBoundsException if the index is out of range
or current event type is not START_TAG.
NOTE: attribute value must be normalized
(including entity replacement text if PROCESS_DOCDECL is false) as described in
XML 1.0 section
3.3.3 Attribute-Value Normalization
- getAttributeValue in interface XmlPullParser
- value of attribute (null is never returned)
getColumnNumber
public int getColumnNumber()
Returns the current column number, starting from 0.
When the parser does not know the current column number
or can not determine it, -1 is returned (e.g. for WBXML).
- getColumnNumber in interface XmlPullParser
- current column number or -1 if unknown.
getDepth
public int getDepth()
Returns the current depth of the element.
Outside the root element, the depth is 0. The
depth is incremented by 1 when a start tag is reached.
The depth is decremented AFTER the end tag
event was observed.
<!-- outside --> 0
<root> 1
sometext 1
<foobar> 2
</foobar> 2
</root> 1
<!-- outside --> 0
- getDepth in interface XmlPullParser
getFeature
public boolean getFeature(String name)
Unknown properties are always returned as false
- getFeature in interface XmlPullParser
getInputEncoding
public String getInputEncoding()
Returns the input encoding if known, null otherwise.
If setInput(InputStream, inputEncoding) was called with an inputEncoding
value other than null, this value must be returned
from this method. Otherwise, if inputEncoding is null and
the parser suppports the encoding detection feature
(http://xmlpull.org/v1/doc/features.html#detect-encoding),
it must return the detected encoding.
If setInput(Reader) was called, null is returned.
After first call to next if XML declaration was present this method
will return encoding declared.
- getInputEncoding in interface XmlPullParser
getLineNumber
public int getLineNumber()
Returns the current line number, starting from 1.
When the parser does not know the current line number
or can not determine it, -1 is returned (e.g. for WBXML).
- getLineNumber in interface XmlPullParser
- current line number or -1 if unknown.
getName
public String getName()
For START_TAG or END_TAG events, the (local) name of the current
element is returned when namespaces are enabled. When namespace
processing is disabled, the raw name is returned.
For ENTITY_REF events, the entity name is returned.
If the current event is not START_TAG, END_TAG, or ENTITY_REF,
null is returned.
Please note: To reconstruct the raw element name
when namespaces are enabled and the prefix is not null,
you will need to add the prefix and a colon to localName..
- getName in interface XmlPullParser
getNamespace
public String getNamespace()
Returns the namespace URI of the current element.
The default namespace is represented
as empty string.
If namespaces are not enabled, an empty String ("") is always returned.
The current event must be START_TAG or END_TAG; otherwise,
null is returned.
- getNamespace in interface XmlPullParser
getNamespace
public String getNamespace(String prefix)
Returns the URI corresponding to the given prefix,
depending on current state of the parser.
If the prefix was not declared in the current scope,
null is returned. The default namespace is included
in the namespace table and is available via
getNamespace (null).
This method is a convenience method for
for (int i = getNamespaceCount(getDepth ())-1; i >= 0; i--) {
if (getNamespacePrefix(i).equals( prefix )) {
return getNamespaceUri(i);
}
}
return null;
Please note: parser implementations
may provide more efifcient lookup, e.g. using a Hashtable.
The 'xml' prefix is bound to "http://www.w3.org/XML/1998/namespace", as
defined in the
Namespaces in XML
specification. Analogous, the 'xmlns' prefix is resolved to
http://www.w3.org/2000/xmlns/
- getNamespace in interface XmlPullParser
getNamespaceCount
public int getNamespaceCount(int depth)
throws XmlPullParserException
Returns the numbers of elements in the namespace stack for the given
depth.
If namespaces are not enabled, 0 is returned.
NOTE: when parser is on END_TAG then it is allowed to call
this function with getDepth()+1 argument to retrieve position of namespace
prefixes and URIs that were declared on corresponding START_TAG.
NOTE: to retrieve lsit of namespaces declared in current element:
XmlPullParser pp = ...
int nsStart = pp.getNamespaceCount(pp.getDepth()-1);
int nsEnd = pp.getNamespaceCount(pp.getDepth());
for (int i = nsStart; i <32nsEnd; i++) {
String prefix = pp.getNamespacePrefix(i);
String ns = pp.getNamespaceUri(i);
// ...
}
- getNamespaceCount in interface XmlPullParser
getNamespacePrefix
public String getNamespacePrefix(int pos)
throws XmlPullParserException
Returns the namespace prefixe for the given position
in the namespace stack.
Default namespace declaration (xmlns='...') will have null as prefix.
If the given index is out of range, an exception is thrown.
Please note: when the parser is on an END_TAG,
namespace prefixes that were declared
in the corresponding START_TAG are still accessible
although they are no longer in scope.
- getNamespacePrefix in interface XmlPullParser
getNamespaceUri
public String getNamespaceUri(int pos)
throws XmlPullParserException
Returns the namespace URI for the given position in the
namespace stack
If the position is out of range, an exception is thrown.
NOTE: when parser is on END_TAG then namespace prefixes that were declared
in corresponding START_TAG are still accessible even though they are not in scope
- getNamespaceUri in interface XmlPullParser
getPositionDescription
public String getPositionDescription()
Return string describing current position of parsers as
text 'STATE [seen %s...] @line:column'.
- getPositionDescription in interface XmlPullParser
getPrefix
public String getPrefix()
Returns the prefix of the current element.
If the element is in the default namespace (has no prefix),
null is returned.
If namespaces are not enabled, or the current event
is not START_TAG or END_TAG, null is returned.
- getPrefix in interface XmlPullParser
getProperty
public Object getProperty(String name)
Look up the value of a property.
The property name is any fully-qualified URI.
NOTE: unknown properties are
always
returned as null.
- getProperty in interface XmlPullParser
name
- The name of property to be retrieved.
- The value of named property.
getText
public String getText()
Returns the text content of the current event as String.
The value returned depends on current event type,
for example for TEXT event it is element content
(this is typical case when next() is used).
See description of nextToken() for detailed description of
possible returned values for different types of events.
NOTE: in case of ENTITY_REF, this method returns
the entity replacement text (or null if not available). This is
the only case where
getText() and getTextCharacters() return different values.
- getText in interface XmlPullParser
getTextCharacters
public char[] getTextCharacters(int[] holderForStartAndLength)
Returns the buffer that contains the text of the current event,
as well as the start offset and length relevant for the current
event. See getText(), next() and nextToken() for description of possible returned values.
Please note: this buffer must not
be modified and its content MAY change after a call to
next() or nextToken(). This method will always return the
same value as getText(), except for ENTITY_REF. In the case
of ENTITY ref, getText() returns the replacement text and
this method returns the actual input buffer containing the
entity name.
If getText() returns null, this method returns null as well and
the values returned in the holder array MUST be -1 (both start
and length).
- getTextCharacters in interface XmlPullParser
holderForStartAndLength
- Must hold an 2-element int array
into which the start offset and length values will be written.
- char buffer that contains the text of the current event
(null if the current event has no text associated).
isAttributeDefault
public boolean isAttributeDefault(int index)
Returns if the specified attribute was not in input was declared in XML.
If parser is non-validating it MUST always return false.
This information is part of XML infoset:
- isAttributeDefault in interface XmlPullParser
- false if attribute was in input
isEmptyElementTag
public boolean isEmptyElementTag()
throws XmlPullParserException
Returns true if the current event is START_TAG and the tag
is degenerated
(e.g. <foobar/>).
NOTE: if the parser is not on START_TAG, an exception
will be thrown.
- isEmptyElementTag in interface XmlPullParser
isNameChar
protected boolean isNameChar(char ch)
isNameStartChar
protected boolean isNameStartChar(char ch)
isS
protected boolean isS(char ch)
isWhitespace
public boolean isWhitespace()
throws XmlPullParserException
Checks whether the current TEXT event contains only whitespace
characters.
For IGNORABLE_WHITESPACE, this is always true.
For TEXT and CDSECT, false is returned when the current event text
contains at least one non-white space character. For any other
event type an exception is thrown.
Please note: non-validating parsers are not
able to distinguish whitespace and ignorable whitespace,
except from whitespace outside the root element. Ignorable
whitespace is reported as separate event, which is exposed
via nextToken only.
- isWhitespace in interface XmlPullParser
joinPC
protected void joinPC()
lookuEntityReplacement
protected char[] lookuEntityReplacement(int entitNameLen)
throws XmlPullParserException,
IOException
newString
protected String newString(char[] cbuf,
int off,
int len)
newStringIntern
protected String newStringIntern(char[] cbuf,
int off,
int len)
next
public int next()
throws XmlPullParserException,
IOException
Get next parsing event - element content wil be coalesced and only one
TEXT event must be returned for whole element content
(comments and processing instructions will be ignored and emtity references
must be expanded or exception mus be thrown if entity reerence can not be exapnded).
If element content is empty (content is "") then no TEXT event will be reported.
NOTE: empty element (such as <tag/>) will be reported
with two separate events: START_TAG, END_TAG - it must be so to preserve
parsing equivalency of empty element to <tag></tag>.
(see isEmptyElementTag ())
- next in interface XmlPullParser
nextTag
public int nextTag()
throws XmlPullParserException,
IOException
Call next() and return event if it is START_TAG or END_TAG
otherwise throw an exception.
It will skip whitespace TEXT before actual tag if any.
essentially it does this
int eventType = next();
if(eventType == TEXT && isWhitespace()) { // skip whitespace
eventType = next();
}
if (eventType != START_TAG && eventType != END_TAG) {
throw new XmlPullParserException("expected start or end tag", this, null);
}
return eventType;
- nextTag in interface XmlPullParser
nextText
public String nextText()
throws XmlPullParserException,
IOException
If current event is START_TAG then if next element is TEXT then element content is returned
or if next event is END_TAG then empty string is returned, otherwise exception is thrown.
After calling this function successfully parser will be positioned on END_TAG.
The motivation for this function is to allow to parse consistently both
empty elements and elements that has non empty content, for example for input:
- <tag>foo</tag>
- <tag></tag> (which is equivalent to <tag/>
both input can be parsed with the same code:
p.nextTag()
p.requireEvent(p.START_TAG, "", "tag");
String content = p.nextText();
p.requireEvent(p.END_TAG, "", "tag");
This function together with nextTag make it very easy to parse XML that has
no mixed content.
Essentially it does this
if(getEventType() != START_TAG) {
throw new XmlPullParserException(
"parser must be on START_TAG to read next text", this, null);
}
int eventType = next();
if(eventType == TEXT) {
String result = getText();
eventType = next();
if(eventType != END_TAG) {
throw new XmlPullParserException(
"event TEXT it must be immediately followed by END_TAG", this, null);
}
return result;
} else if(eventType == END_TAG) {
return "";
} else {
throw new XmlPullParserException(
"parser must be on START_TAG or TEXT to read text", this, null);
}
- nextText in interface XmlPullParser
nextToken
public int nextToken()
throws XmlPullParserException,
IOException
This method works similarly to next() but will expose
additional event types (COMMENT, CDSECT, DOCDECL, ENTITY_REF, PROCESSING_INSTRUCTION, or
IGNORABLE_WHITESPACE) if they are available in input.
If special feature
FEATURE_XML_ROUNDTRIP
(identified by URI: http://xmlpull.org/v1/doc/features.html#xml-roundtrip)
is enabled it is possible to do XML document round trip ie. reproduce
exectly on output the XML input using getText():
returned content is always unnormalized (exactly as in input).
Otherwise returned content is end-of-line normalized as described
XML 1.0 End-of-Line Handling
and. Also when this feature is enabled exact content of START_TAG, END_TAG,
DOCDECL and PROCESSING_INSTRUCTION is available.
Here is the list of tokens that can be returned from nextToken()
and what getText() and getTextCharacters() returns:
- inside
NOTE:are different
NOTE:
NOTE:not
" titlepage SYSTEM "http://www.foo.bar/dtds/typo.dtd"
[<!ENTITY % active.links "INCLUDE">]"
<!DOCTYPE titlepage SYSTEM "http://www.foo.bar/dtds/typo.dtd"
[<!ENTITY % active.links "INCLUDE">]>
NOTE: there is no gurantee that there will only one TEXT or
IGNORABLE_WHITESPACE event from nextToken() as parser may chose to deliver element content in
multiple tokens (dividing element content into chunks)
NOTE: whether returned text of token is end-of-line normalized
is depending on FEATURE_XML_ROUNDTRIP.
NOTE: XMLDecl (<?xml ...?>) is not reported but its content
is available through optional properties (see class description above).
- nextToken in interface XmlPullParser
parseXmlDeclWithVersion
protected void parseXmlDeclWithVersion(int versionStart,
int versionEnd)
throws XmlPullParserException,
IOException
printable
protected String printable(String s)
printable
protected String printable(char ch)
require
public void require(int type,
String namespace,
String name)
throws XmlPullParserException,
IOException
Test if the current event is of the given type and if the
namespace and name do match. null will match any namespace
and any name. If the test is not passed, an exception is
thrown. The exception text indicates the parser position,
the expected event and the current event that is not meeting the
requirement.
Essentially it does this
if (type != getEventType()
|| (namespace != null && !namespace.equals( getNamespace () ) )
|| (name != null && !name.equals( getName() ) ) )
throw new XmlPullParserException( "expected "+ TYPES[ type ]+getPositionDescription());
- require in interface XmlPullParser
reset
protected void reset()
resetStringCache
protected void resetStringCache()
setInput
public void setInput(Reader in)
throws XmlPullParserException
Set the input source for parser to the given reader and
resets the parser. The event type is set to the initial value
START_DOCUMENT.
Setting the reader to null will just stop parsing and
reset parser state,
allowing the parser to free internal resources
such as parsing buffers.
- setInput in interface XmlPullParser
setInput
public void setInput(java.io.InputStream inputStream,
String inputEncoding)
throws XmlPullParserException
setName
private static final void setName(char ch)
setNameStart
private static final void setNameStart(char ch)
skipSubTree
public void skipSubTree()
throws XmlPullParserException,
IOException
Skip sub tree that is currently porser positioned on.
NOTE: parser must be on START_TAG and when funtion returns
parser will be positioned on corresponding END_TAG