|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.json.JSONTokener
public class JSONTokener
Parses a JSON (RFC 4627)
encoded string into the corresponding object. Most clients of
this class will use only need the constructor
and nextValue()
method. Example usage:
String json = "{" + " \"query\": \"Pizza\", " + " \"locations\": [ 94043, 90210 ] " + "}"; JSONObject object = (JSONObject) new JSONTokener(json).nextValue(); String query = object.getString("query"); JSONArray locations = object.getJSONArray("locations");
For best interoperability and performance use JSON that complies with
RFC 4627, such as that generated by JSONStringer
. For legacy reasons
this parser is lenient, so a successful parse does not indicate that the
input string was valid JSON. All of the following syntax errors will be
ignored:
//
or #
and ending
with a newline character.
/*
and ending with
*
/
. Such comments may not be nested.
'single quoted'
.
0x
or 0X
.
0
.
;
.
=
or =>
.
;
.
Each tokener may be used to parse a single JSON string. Instances of this class are not thread safe. Although this class is nonfinal, it was not designed for inheritance and should not be subclassed. In particular, self-use by overrideable methods is not specified. See Effective Java Item 17, "Design and Document or inheritance or else prohibit it" for further information.
Constructor Summary | |
---|---|
JSONTokener(java.lang.String in)
|
Method Summary | |
---|---|
void |
back()
Unreads the most recent character of input. |
static int |
dehexchar(char hex)
Returns the integer [0..15] value for the given hex character, or -1 for non-hex input. |
boolean |
more()
Returns true until the input has been exhausted. |
char |
next()
Returns the next available character, or the null character '\0' if all input has been exhausted. |
char |
next(char c)
Returns the next available character if it equals c . |
java.lang.String |
next(int length)
Returns the next length characters of the input. |
char |
nextClean()
Returns the next character that is not whitespace and does not belong to a comment. |
java.lang.String |
nextString(char quote)
Returns the string up to but not including quote , unescaping any
character escape sequences encountered along the way. |
java.lang.String |
nextTo(char excluded)
Equivalent to nextTo(String.valueOf(excluded)) . |
java.lang.String |
nextTo(java.lang.String excluded)
Returns the trimmed string holding the characters up
to but not including the first of:
any character in excluded
a newline character '\n'
a carriage return '\r'
|
java.lang.Object |
nextValue()
Returns the next value from the input. |
void |
skipPast(java.lang.String thru)
Advances past all input up to and including the next occurrence of thru . |
char |
skipTo(char to)
Advances past all input up to but not including the next occurrence of to . |
JSONException |
syntaxError(java.lang.String message)
Returns an exception containing the given message plus the current position and the entire input string. |
java.lang.String |
toString()
Returns the current position and the entire input string. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Constructor Detail |
---|
public JSONTokener(java.lang.String in)
in
- JSON encoded string. Null is not permitted and will yield a
tokener that throws NullPointerExceptions
when methods are
called.Method Detail |
---|
public java.lang.Object nextValue() throws JSONException
JSONObject
, JSONArray
, String, Boolean,
Integer, Long, Double or JSONObject.NULL
.
JSONException
- if the input is malformed.public java.lang.String nextString(char quote) throws JSONException
quote
, unescaping any
character escape sequences encountered along the way. The opening quote
should have already been read. This consumes the closing quote, but does
not include it in the returned string.
quote
- either ' or ".
java.lang.NumberFormatException
- if any unicode escape sequences are
malformed.
JSONException
public JSONException syntaxError(java.lang.String message)
public java.lang.String toString()
toString
in class java.lang.Object
public boolean more()
public char next()
public char next(char c) throws JSONException
c
. Otherwise an
exception is thrown.
JSONException
public char nextClean() throws JSONException
JSONException
public java.lang.String next(int length) throws JSONException
length
characters of the input.
The returned string shares its backing character array with this
tokener's input string. If a reference to the returned string may be held
indefinitely, you should use new String(result)
to copy it first
to avoid memory leaks.
JSONException
- if the remaining input is not long enough to
satisfy this request.public java.lang.String nextTo(java.lang.String excluded)
trimmed
string holding the characters up
to but not including the first of:
excluded
The returned string shares its backing character array with this
tokener's input string. If a reference to the returned string may be held
indefinitely, you should use new String(result)
to copy it first
to avoid memory leaks.
public java.lang.String nextTo(char excluded)
nextTo(String.valueOf(excluded))
.
public void skipPast(java.lang.String thru)
thru
. If the remaining input doesn't contain thru
, the
input is exhausted.
public char skipTo(char to)
to
. If the remaining input doesn't contain to
, the input
is unchanged.
public void back()
public static int dehexchar(char hex)
hex
- a character in the ranges [0-9], [A-F] or [a-f]. Any other
character will yield a -1 result.
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |