JSONTokener Class Reference

Public Member Functions
	JSONTokener (Reader reader)
	JSONTokener (InputStream inputStream) throws JSONException
	JSONTokener (String s)
void	back () throws JSONException
boolean	end ()
boolean	more () throws JSONException
char	next () throws JSONException
char	next (char c) throws JSONException
String	next (int n) throws JSONException
char	nextClean () throws JSONException
String	nextString (char quote) throws JSONException
String	nextTo (char delimiter) throws JSONException
String	nextTo (String delimiters) throws JSONException
Object	nextValue () throws JSONException
char	skipTo (char to) throws JSONException
JSONException	syntaxError (String message)
String	toString ()

Static Public Member Functions
static int	dehexchar (char c)

Detailed Description

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.

Author

JSON.org

Version

2012-02-16

Constructor & Destructor Documentation

JSONTokener() [1/3]

JSONTokener

(

Reader

reader

)

Construct a JSONTokener from a Reader.

Parameters

reader

A reader.

JSONTokener() [2/3]

JSONTokener

(

InputStream

inputStream

)

throws JSONException

Construct a JSONTokener from an InputStream.

JSONTokener() [3/3]

JSONTokener

(

String

s

)

Construct a JSONTokener from a string.

Parameters

s	A source string.

Member Function Documentation

back()

void back

(

)

throws JSONException

Back up one character. This provides a sort of lookahead capability, so that you can test for a digit or letter before attempting to parse the next number or identifier.

dehexchar()

static int dehexchar ( char  c )

static

Get the hex value of a character (base16).

Parameters

c	A character between '0' and '9' or between 'A' and 'F' or between 'a' and 'f'.

Returns

An int between 0 and 15, or -1 if c was not a hex digit.

end()

boolean end

(

)

more()

boolean more

(

)

throws JSONException

Determine if the source string still contains characters that next() can consume.

Returns

true if not yet at the end of the source.

next() [1/3]

char next

(

)

throws JSONException

Get the next character in the source string.

Returns

The next character, or 0 if past the end of the source string.

next() [2/3]

char next

(

char

c

)

throws JSONException

Consume the next character, and check that it matches a specified character.

Parameters

c	The character to match.

Returns

The character.

Exceptions

JSONException

if the character does not match.

next() [3/3]

String next

(

int

n

)

throws JSONException

Get the next n characters.

Parameters

n	The number of characters to take.

Returns

A string of n characters.

Exceptions

JSONException

Substring bounds error if there are not n characters remaining in the source string.

nextClean()

char nextClean

(

)

throws JSONException

Get the next char in the string, skipping whitespace.

Exceptions

JSONException

Returns

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

nextString()

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.

Exceptions

JSONException

Unterminated string.

nextTo() [1/2]

String nextTo

(

char

delimiter

)

throws JSONException

Get the text up but not including the specified character or the end of line, whichever comes first.

Parameters

delimiter

A delimiter character.

Returns

A string.

nextTo() [2/2]

String nextTo

(

String

delimiters

)

throws JSONException

Get the text up but not including one of the specified delimiter characters or the end of line, whichever comes first.

Parameters

delimiters

A set of delimiter characters.

Returns

A string, trimmed.

nextValue()

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.

Exceptions

JSONException

If syntax error.

Returns

An object.

skipTo()

char skipTo

(

char

to

)

throws JSONException

Skip characters until the next character is the requested character. If the requested character is not found, no characters are skipped.

Parameters

to	A character to skip to.

Returns

The requested character, or zero if the requested character is not found.

syntaxError()

JSONException syntaxError

(

String

message

)

Make a JSONException to signal a syntax error.

Parameters

message

The error message.

Returns

A JSONException object, suitable for throwing

toString()

String toString

(

)

Make a printable string of this JSONTokener.

Returns

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