org.json

Class XMLTokener

public class XMLTokener extends JSONTokener

The XMLTokener extends the JSONTokener to provide additional methods for the parsing of XML texts.
Field Summary
static HashMapentity
The table of entity values.
Constructor Summary
XMLTokener(String s)
Construct an XMLTokener from a string.
Method Summary
StringnextCDATA()
Get the text in the CDATA block.
ObjectnextContent()
Get the next XML outer token, trimming whitespace.
ObjectnextEntity(char a)
Return the next entity.
ObjectnextMeta()
Returns the next XML meta token.
ObjectnextToken()
Get the next XML Token.

Field Detail

entity

public static final HashMap entity
The table of entity values. It initially contains Character values for amp, apos, gt, lt, quot.

Constructor Detail

XMLTokener

public XMLTokener(String s)
Construct an XMLTokener from a string.

Parameters: s A source string.

Method Detail

nextCDATA

public String nextCDATA()
Get the text in the CDATA block.

Returns: The string up to the ]]>.

Throws: JSONException If the ]]> is not found.

nextContent

public Object nextContent()
Get the next XML outer token, trimming whitespace. There are two kinds of tokens: the '<' character which begins a markup tag, and the content text between markup tags.

Returns: A string, or a '<' Character, or null if there is no more source text.

Throws: JSONException

nextEntity

public Object nextEntity(char a)
Return the next entity. These entities are translated to Characters: & ' > < ".

Parameters: a An ampersand character.

Returns: A Character or an entity String if the entity is not recognized.

Throws: JSONException If missing ';' in XML entity.

nextMeta

public Object nextMeta()
Returns the next XML meta token. This is used for skipping over and structures.

Returns: Syntax characters (< > / = ! ?) are returned as Character, and strings and names are returned as Boolean. We don't care what the values actually are.

Throws: JSONException If a string is not properly closed or if the XML is badly structured.

nextToken

public Object nextToken()
Get the next XML Token. These tokens are found inside of angle brackets. It may be one of these characters: / > = ! ? or it may be a string wrapped in single quotes or double quotes, or it may be a name.

Returns: a String or a Character.

Throws: JSONException If the XML is not well formed.