public class KXmlParser extends Object implements XmlPullParser, Closeable
Modifier and Type | Field and Description |
---|---|
StringPool |
stringPool |
CDSECT, COMMENT, DOCDECL, END_DOCUMENT, END_TAG, ENTITY_REF, FEATURE_PROCESS_DOCDECL, FEATURE_PROCESS_NAMESPACES, FEATURE_REPORT_NAMESPACE_ATTRIBUTES, FEATURE_VALIDATION, IGNORABLE_WHITESPACE, NO_NAMESPACE, PROCESSING_INSTRUCTION, START_DOCUMENT, START_TAG, TEXT, TYPES
Constructor and Description |
---|
KXmlParser() |
Modifier and Type | Method and Description |
---|---|
void |
close()
Closes this stream and releases any system resources associated
with it.
|
void |
defineEntityReplacementText(String entity,
String value)
Set new value for entity replacement text as defined in
XML 1.0 Section 4.5
Construction of Internal Entity Replacement Text.
|
int |
getAttributeCount()
Returns the number of attributes of the current start tag, or
-1 if the current event type is not START_TAG
|
String |
getAttributeName(int index)
Returns the local name of the specified attribute
if namespaces are enabled or just attribute name if namespaces are disabled.
|
String |
getAttributeNamespace(int index)
Returns the namespace URI of the attribute
with the given index (starts from 0).
|
String |
getAttributePrefix(int index)
Returns the prefix of the specified attribute
Returns null if the element has no prefix.
|
String |
getAttributeType(int index)
Returns the type of the specified attribute
If parser is non-validating it MUST return CDATA.
|
String |
getAttributeValue(int index)
Returns the given attributes value.
|
String |
getAttributeValue(String namespace,
String name)
Returns the attributes value identified by namespace URI and namespace localName.
|
int |
getColumnNumber()
Returns the current column number, starting from 0.
|
int |
getDepth()
Returns the current depth of the element.
|
int |
getEventType()
Returns the type of the current event (START_TAG, END_TAG, TEXT, etc.)
|
boolean |
getFeature(String feature)
Returns the current value of the given feature.
|
String |
getInputEncoding()
Returns the input encoding if known, null otherwise.
|
int |
getLineNumber()
Returns the current line number, starting from 1.
|
String |
getName()
For START_TAG or END_TAG events, the (local) name of the current
element is returned when namespaces are enabled.
|
String |
getNamespace()
Returns the namespace URI of the current element.
|
String |
getNamespace(String prefix)
Returns the URI corresponding to the given prefix,
depending on current state of the parser.
|
int |
getNamespaceCount(int depth)
Returns the numbers of elements in the namespace stack for the given
depth.
|
String |
getNamespacePrefix(int pos)
Returns the namespace prefix for the given position
in the namespace stack.
|
String |
getNamespaceUri(int pos)
Returns the namespace URI for the given position in the
namespace stack
If the position is out of range, an exception is thrown.
|
String |
getPositionDescription()
Returns a short text describing the current parser state, including
the position, a
description of the current event and the data source if known.
|
String |
getPrefix()
Returns the prefix of the current element.
|
Object |
getProperty(String property)
Look up the value of a property.
|
String |
getPublicId()
Returns the document's public ID if it was declared.
|
String |
getRootElementName()
Returns the root element's name if it was declared in the DTD.
|
String |
getSystemId()
Returns the document's system ID if it was declared.
|
String |
getText()
Returns the text content of the current event as String.
|
char[] |
getTextCharacters(int[] poslen)
Returns the buffer that contains the text of the current event,
as well as the start offset and length relevant for the current
event.
|
boolean |
isAttributeDefault(int index)
Returns if the specified attribute was not in input was declared in XML.
|
boolean |
isEmptyElementTag()
Returns true if the current event is START_TAG and the tag
is degenerated
(e.g.
|
boolean |
isWhitespace()
Checks whether the current TEXT event contains only whitespace
characters.
|
void |
keepNamespaceAttributes()
Retains namespace attributes like
xmlns="http://foo" or xmlns:foo="http:foo"
in pulled elements. |
int |
next()
Get next parsing event - element content will be coalesced and only one
TEXT event must be returned for whole element content
(comments and processing instructions will be ignored and entity references
must be expanded or exception must be thrown if entity reference can not be expanded).
|
int |
nextTag()
Call next() and return event if it is START_TAG or END_TAG
otherwise throw an exception.
|
String |
nextText()
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.
|
int |
nextToken()
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.
|
void |
require(int type,
String namespace,
String name)
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.
|
void |
setFeature(String feature,
boolean value)
Use this call to change the general behaviour of the parser,
such as namespace processing or doctype declaration handling.
|
void |
setInput(InputStream is,
String charset)
Sets the input stream the parser is going to process.
|
void |
setInput(Reader reader)
Set the input source for parser to the given reader and
resets the parser.
|
void |
setProperty(String property,
Object value)
Set the value of a property.
|
public void keepNamespaceAttributes()
xmlns="http://foo"
or xmlns:foo="http:foo"
in pulled elements. Most applications will only be interested in the effective namespaces of
their elements, so these attributes aren't useful. But for structure preserving wrappers like
DOM, it is necessary to keep the namespace data around.public int next() throws XmlPullParserException, IOException
XmlPullParser
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
XmlPullParserException
IOException
XmlPullParser.isEmptyElementTag()
,
XmlPullParser.START_TAG
,
XmlPullParser.TEXT
,
XmlPullParser.END_TAG
,
XmlPullParser.END_DOCUMENT
public int nextToken() throws XmlPullParserException, IOException
XmlPullParser
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:
" titlepage SYSTEM "http://www.foo.bar/dtds/typo.dtd" [<!ENTITY % active.links "INCLUDE">]"
for input document that contained:
<!DOCTYPE titlepage SYSTEM "http://www.foo.bar/dtds/typo.dtd" [<!ENTITY % active.links "INCLUDE">]>otherwise if FEATURE_XML_ROUNDTRIP is false and PROCESS_DOCDECL is true then what is returned is undefined (it may be even null)
NOTE: there is no guarantee 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
XmlPullParserException
IOException
XmlPullParser.next()
,
XmlPullParser.START_TAG
,
XmlPullParser.TEXT
,
XmlPullParser.END_TAG
,
XmlPullParser.END_DOCUMENT
,
XmlPullParser.COMMENT
,
XmlPullParser.DOCDECL
,
XmlPullParser.PROCESSING_INSTRUCTION
,
XmlPullParser.ENTITY_REF
,
XmlPullParser.IGNORABLE_WHITESPACE
public void setInput(Reader reader) throws XmlPullParserException
XmlPullParser
setInput
in interface XmlPullParser
XmlPullParserException
public void setInput(InputStream is, String charset) throws XmlPullParserException
XmlPullParser
NOTE: If an input encoding string is passed, it MUST be used. Otherwise, if inputEncoding is null, the parser SHOULD try to determine input encoding following XML 1.0 specification (see below). If encoding detection is supported then following feature http://xmlpull.org/v1/doc/features.html#detect-encoding MUST be true amd otherwise it must be false
setInput
in interface XmlPullParser
is
- contains a raw byte input stream of possibly
unknown encoding (when inputEncoding is null).charset
- if not null it MUST be used as encoding for inputStreamXmlPullParserException
public void close() throws IOException
Closeable
close
in interface Closeable
close
in interface AutoCloseable
IOException
- if an I/O error occurspublic boolean getFeature(String feature)
XmlPullParser
Please note: unknown features are always returned as false.
getFeature
in interface XmlPullParser
feature
- The name of feature to be retrieved.public String getInputEncoding()
XmlPullParser
getInputEncoding
in interface XmlPullParser
public void defineEntityReplacementText(String entity, String value) throws XmlPullParserException
XmlPullParser
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 <, ampersand 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
XmlPullParserException
XmlPullParser.setInput(java.io.Reader)
,
XmlPullParser.FEATURE_PROCESS_DOCDECL
,
XmlPullParser.FEATURE_VALIDATION
public Object getProperty(String property)
XmlPullParser
NOTE: unknown properties are always returned as null.
getProperty
in interface XmlPullParser
property
- The name of property to be retrieved.public String getRootElementName()
public String getSystemId()
http://www.w3.org/TR/html4/strict.dtd
.public String getPublicId()
-//W3C//DTD HTML 4.01//EN
.public int getNamespaceCount(int depth)
XmlPullParser
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 list 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 < nsEnd; i++) { String prefix = pp.getNamespacePrefix(i); String ns = pp.getNamespaceUri(i); // ... }
getNamespaceCount
in interface XmlPullParser
XmlPullParser.getNamespacePrefix(int)
,
XmlPullParser.getNamespaceUri(int)
,
XmlPullParser.getNamespace()
,
XmlPullParser.getNamespace(String)
public String getNamespacePrefix(int pos)
XmlPullParser
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
public String getNamespaceUri(int pos)
XmlPullParser
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
public String getNamespace(String prefix)
XmlPullParser
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 efficient 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
XmlPullParser.getNamespaceCount(int)
,
XmlPullParser.getNamespacePrefix(int)
,
XmlPullParser.getNamespaceUri(int)
public int getDepth()
XmlPullParser
<!-- outside --> 0 <root> 1 sometext 1 <foobar> 2 </foobar> 2 </root> 1 <!-- outside --> 0
getDepth
in interface XmlPullParser
public String getPositionDescription()
XmlPullParser
getPositionDescription
in interface XmlPullParser
public int getLineNumber()
XmlPullParser
getLineNumber
in interface XmlPullParser
public int getColumnNumber()
XmlPullParser
getColumnNumber
in interface XmlPullParser
public boolean isWhitespace() throws XmlPullParserException
XmlPullParser
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
XmlPullParserException
public String getText()
XmlPullParser
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
XmlPullParser.getEventType()
,
XmlPullParser.next()
,
XmlPullParser.nextToken()
public char[] getTextCharacters(int[] poslen)
XmlPullParser
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
poslen
- Must hold an 2-element int array
into which the start offset and length values will be written.XmlPullParser.getText()
,
XmlPullParser.next()
,
XmlPullParser.nextToken()
public String getNamespace()
XmlPullParser
getNamespace
in interface XmlPullParser
public String getName()
XmlPullParser
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
public String getPrefix()
XmlPullParser
getPrefix
in interface XmlPullParser
public boolean isEmptyElementTag() throws XmlPullParserException
XmlPullParser
NOTE: if the parser is not on START_TAG, an exception will be thrown.
isEmptyElementTag
in interface XmlPullParser
XmlPullParserException
public int getAttributeCount()
XmlPullParser
getAttributeCount
in interface XmlPullParser
XmlPullParser.getAttributeNamespace(int)
,
XmlPullParser.getAttributeName(int)
,
XmlPullParser.getAttributePrefix(int)
,
XmlPullParser.getAttributeValue(int)
public String getAttributeType(int index)
XmlPullParser
getAttributeType
in interface XmlPullParser
index
- zero-based index of attributepublic boolean isAttributeDefault(int index)
XmlPullParser
isAttributeDefault
in interface XmlPullParser
index
- zero-based index of attributepublic String getAttributeNamespace(int index)
XmlPullParser
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
index
- zero-based index of attributepublic String getAttributeName(int index)
XmlPullParser
getAttributeName
in interface XmlPullParser
index
- zero-based index of attributepublic String getAttributePrefix(int index)
XmlPullParser
getAttributePrefix
in interface XmlPullParser
index
- zero-based index of attributepublic String getAttributeValue(int index)
XmlPullParser
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
index
- zero-based index of attributeXmlPullParser.defineEntityReplacementText(java.lang.String, java.lang.String)
public String getAttributeValue(String namespace, String name)
XmlPullParser
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 nameXmlPullParser.defineEntityReplacementText(java.lang.String, java.lang.String)
public int getEventType() throws XmlPullParserException
XmlPullParser
getEventType
in interface XmlPullParser
XmlPullParserException
XmlPullParser.next()
,
XmlPullParser.nextToken()
public int nextTag() throws XmlPullParserException, IOException
XmlPullParser
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
XmlPullParserException
IOException
public void require(int type, String namespace, String name) throws XmlPullParserException, IOException
XmlPullParser
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
XmlPullParserException
IOException
public String nextText() throws XmlPullParserException, IOException
XmlPullParser
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:
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); }
Warning: Prior to API level 14, the pull parser returned by android.util.Xml
did not always advance to the END_TAG event when this method was called.
Work around by using manually advancing after calls to nextText():
String text = xpp.nextText(); if (xpp.getEventType() != XmlPullParser.END_TAG) { xpp.next(); }
nextText
in interface XmlPullParser
XmlPullParserException
IOException
public void setFeature(String feature, boolean value) throws XmlPullParserException
XmlPullParser
Example: call setFeature(FEATURE_PROCESS_NAMESPACES, true) in order to switch on namespace processing. The initial settings correspond to the properties requested from the XML Pull Parser factory. If none were requested, all features are deactivated by default.
setFeature
in interface XmlPullParser
XmlPullParserException
- If the feature is not supported or can not be setpublic void setProperty(String property, Object value) throws XmlPullParserException
XmlPullParser
setProperty
in interface XmlPullParser
XmlPullParserException
- If the property is not supported or can not be set