Package org.json
Class XMLTokener
java.lang.Object
org.json.JSONTokener
org.json.XMLTokener
The XMLTokener extends the JSONTokener to provide additional methods
for the parsing of XML texts.
- Version:
- 2015-12-09
-
Field Summary
Fields -
Constructor Summary
ConstructorsConstructorDescriptionXMLTokener
(Reader r) Construct an XMLTokener from a Reader.XMLTokener
(Reader r, XMLParserConfiguration configuration) Construct an XMLTokener from a Reader and an XMLParserConfiguration.XMLTokener
(String s) Construct an XMLTokener from a string. -
Method Summary
Modifier and TypeMethodDescriptionGet the text in the CDATA block.Get the next XML outer token, trimming whitespace.nextEntity
(char ampersand) Return the next entity. These entities are translated to Characters: & ' > < ".
nextMeta()
Returns the next XML meta token. This is used for skipping over <!...> and <?...?> structures.
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.
void
Skip characters until past the requested string.(package private) static String
Unescape an XML entity encoding;Methods inherited from class org.json.JSONTokener
back, close, dehexchar, end, getPrevious, more, next, next, next, nextClean, nextSimpleValue, nextString, nextTo, nextTo, nextValue, skipTo, syntaxError, syntaxError, toString
-
Field Details
-
entity
The table of entity values. It initially contains Character values for amp, apos, gt, lt, quot. -
configuration
-
-
Constructor Details
-
XMLTokener
Construct an XMLTokener from a Reader.- Parameters:
r
- A source reader.
-
XMLTokener
Construct an XMLTokener from a string.- Parameters:
s
- A source string.
-
XMLTokener
Construct an XMLTokener from a Reader and an XMLParserConfiguration.- Parameters:
r
- A source reader.configuration
- the configuration that can be used to set certain flags
-
-
Method Details
-
nextCDATA
Get the text in the CDATA block.- Returns:
- The string up to the
]]>
. - Throws:
JSONException
- If the]]>
is not found.
-
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
- if a called function has an error
-
nextEntity
Return the next entity. These entities are translated to Characters: & ' > < ".
- Parameters:
ampersand
- An ampersand character.- Returns:
- A Character or an entity String if the entity is not recognized.
- Throws:
JSONException
- If missing ';' in XML entity.
-
unescapeEntity
Unescape an XML entity encoding;- Parameters:
e
- entity (only the actual entity value, not the preceding invalid input: '&' or ending ;- Returns:
-
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
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.
-
skipPast
Skip characters until past the requested string. If it is not found, we are left at the end of the source with a result of false.- Parameters:
to
- A string to skip past.
-