JSONTokener (OpenCms Core API, version 10.0.0)

java.lang.Object
- org.opencms.json.JSONTokener

Direct Known Subclasses:

XMLTokener
```
public class JSONTokener
extends java.lang.Object
```
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.

Constructor Summary

Constructors
Constructor and Description

JSONTokener(java.io.Reader reader)
Construct a JSONTokener from a string.

JSONTokener(java.lang.String s)
Construct a JSONTokener from a string.

Constructors
Constructor and Description
`JSONTokener(java.io.Reader reader)` Construct a JSONTokener from a string.
`JSONTokener(java.lang.String s)` Construct a JSONTokener from a string.

Method Summary

Methods
Modifier and Type	Method and Description
`void`	`back()` Back up one character.
`static int`	`dehexchar(char c)` Get the hex value of a character (base16).
`boolean`	`more()` Determine if the source string still contains characters that next() can consume.
`char`	`next()` Get the next character in the source string.
`char`	`next(char c)` Consume the next character, and check that it matches a specified character.
`java.lang.String`	`next(int n)` Get the next n characters.
`char`	`nextClean()` Get the next char in the string, skipping whitespace and comments (slashslash, slashstar, and hash).
`java.lang.String`	`nextString(char quote)` Return the characters up to the next close quote character.
`java.lang.String`	`nextTo(char d)` Get the text up but not including the specified character or the end of line, whichever comes first.
`java.lang.String`	`nextTo(java.lang.String delimiters)` Get the text up but not including one of the specified delimiter characters or the end of line, whichever comes first.
`java.lang.Object`	`nextValue()` Get the next value.
`void`	`setOrdered(boolean ordered)` Sets a flag which makes JSONObjects created by this tokener ordered.
`char`	`skipTo(char to)` Skip characters until the next character is the requested character.
`JSONException`	`syntaxError(java.lang.String message)` Make a JSONException to signal a syntax error.
`java.lang.String`	`toString()` Make a printable string of this JSONTokener.

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 string.
    
    Parameters:
    reader - a reader.
  - JSONTokener
```
public JSONTokener(java.lang.String s)
```
    Construct a JSONTokener from a string.
    
    Parameters:
    s - a source string
- Method Detail
  - back
```
public 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.
    
    Throws:
    
    JSONException - if something goes wrong
  - dehexchar
```
public static int dehexchar(char c)
```
    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
  - more
```
public 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
    
    Throws:
    
    JSONException - if something goes wrong
  - next
```
public 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
    
    Throws:
    
    JSONException - if something goes wrong
  - next
```
public 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
    
    Throws:
    
    JSONException - if the character does not match
  - next
```
public java.lang.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
    
    Throws:
    
    JSONException - substring bounds error if there are not n characters remaining in the source string
  - nextClean
```
public char nextClean()
               throws JSONException
```
    Get the next char in the string, skipping whitespace and comments (slashslash, slashstar, and hash).
    
    Returns:
    a character, or 0 if there are no more characters
    
    Throws:
    
    JSONException - if something goes wrong
  - 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 - in case of an unterminated string
  - nextTo
```
public java.lang.String nextTo(char d)
                        throws JSONException
```
    Get the text up but not including the specified character or the end of line, whichever comes first.
    
    Parameters:
    d - a delimiter character
    
    Returns:
    a string
    
    Throws:
    
    JSONException - if something goes wrong
  - nextTo
```
public java.lang.String nextTo(java.lang.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
    
    Throws:
    
    JSONException - if something goes wrong
  - 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 something goes wrong
  - setOrdered
```
public void setOrdered(boolean ordered)
```
    Sets a flag which makes JSONObjects created by this tokener ordered.
    
    Parameters:
    ordered - true if JSONObjects created by this should be ordered
  - skipTo
```
public 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
    
    Throws:
    
    JSONException - if something goes wrong
  - syntaxError
```
public JSONException syntaxError(java.lang.String message)
```
    Make a JSONException to signal a syntax error.
    
    Parameters:
    message - the error message
    
    Returns:
    a JSONException object, suitable for throwing
  - toString
```
public java.lang.String toString()
```
    Make a printable string of this JSONTokener.
    
    Overrides:
    
    toString in class java.lang.Object
    
    Returns:
    " at character [this.index]"

Class JSONTokener

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

JSONTokener

JSONTokener

Method Detail

back

dehexchar

more

next

next

next

nextClean

nextString

nextTo

nextTo

nextValue

setOrdered

skipTo

syntaxError

toString