org.json

Class JSONTokener

java.lang.Object

org.json.Scanner

org.json.JSONTokener

Direct Known Subclasses:

HTTPTokener, JSONStrictTokener, XMLTokener

public class JSONTokener
extends Scanner

A JSONTokener takes a source string and extracts characters and tokens from it. It is used by the JSONObject and JSONArray constructors to parse JSON source strings.

This class performed a lenient parse. For a strict parse, use JSONStrictTokener.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	JSONTokener.JSONToken Tokens that can be identified with at most one character lookahead.

Constructor Summary

Constructors

Constructor and Description
JSONTokener(java.io.InputStream inputStream) Construct a JSONTokener from an InputStream, using the default character set.
JSONTokener(java.io.InputStream inputStream, java.nio.charset.Charset charset) Construct a JSONTokener from an InputStream and supplied Charset.
JSONTokener(java.io.Reader reader) Construct a JSONTokener from a Reader.
JSONTokener(java.lang.String s) Construct a JSONTokener from a string.

Method Summary

Modifier and Type	Method and Description
char	nextClean() Get the next char in the string, skipping whitespace.
java.lang.String	nextKey() Get the next key.
java.lang.String	nextString(char quote) Return the characters up to the next close quote character.
JSONTokener.JSONToken	nextTokenType() Get the type of the next token in the stream, skipping whitespace.
java.lang.Object	nextValue() Get the next value.
protected java.lang.String	pooledKey(java.lang.String key) Add the given key to the key pool, if necessary, and return the canonical key.
java.lang.String	toString() Make a printable string of this Scanner.

Methods inherited from class org.json.Scanner

back, dehexchar, end, more, next, next, next, nextTo, nextTo, parsePosition, skipTo, syntaxError, syntaxError, syntaxError

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

JSONTokener

public JSONTokener(java.io.Reader reader)

Construct a JSONTokener from a Reader.

Parameters:

reader - A reader.

JSONTokener

public JSONTokener(java.io.InputStream inputStream)

Construct a JSONTokener from an InputStream, using the default character set.

Parameters:

inputStream - an input stream from which to tokenize the JSON text

JSONTokener

public JSONTokener(java.io.InputStream inputStream,
                   java.nio.charset.Charset charset)

Construct a JSONTokener from an InputStream and supplied Charset.

Parameters:

inputStream - an input stream from which to tokenize the JSON text

charset - the character set with which to interpret the input stream

JSONTokener

public JSONTokener(java.lang.String s)

Construct a JSONTokener from a string.

Parameters:

s - A source string.

Method Detail

nextClean

public char nextClean()
               throws JSONException

Get the next char in the string, skipping whitespace.

Returns:

A character, or 0 if there are no more characters.

Throws:

JSONException - Thrown if there is an error reading the source string.

nextTokenType

public JSONTokener.JSONToken nextTokenType()
                                    throws JSONException

Get the type of the next token in the stream, skipping whitespace.

Returns:

the Token type representing the next token type

Throws:

JSONException

See Also:

JSONTokener.JSONToken

nextString

public java.lang.String nextString(char quote)
                            throws JSONException

Return the characters up to the next close quote character. Backslash processing is done. The formal JSON format does not allow strings in single quotes, but an implementation is allowed to accept them.

Parameters:

quote - The quoting character, either " (double quote) or ' (single quote).

Returns:

A String.

Throws:

JSONException - Unterminated string.

nextKey

public java.lang.String nextKey()
                         throws JSONException

Get the next key. This would usually be a quoted String value. Unquoted forms are also allowed.

Returns:

An object.

Throws:

JSONException - If syntax error.

pooledKey

protected java.lang.String pooledKey(java.lang.String key)

Add the given key to the key pool, if necessary, and return the canonical key.

Parameters:

key - the key to be pooled

Returns:

the canonical key

nextValue

public java.lang.Object nextValue()
                           throws JSONException

Get the next value. The value can be a Boolean, Double, Integer, JSONArray, JSONObject, Long, or String, or the JSONObject.NULL object.

Returns:

An object.

Throws:

JSONException - If syntax error.

toString

public java.lang.String toString()

Make a printable string of this Scanner.

Overrides:

toString in class Scanner

Returns:

"JSONTokener at {index} [character {character} line {line}]"