Package org.apache.sling.commons.json

Class JSONTokener

java.lang.Object
org.apache.sling.commons.json.JSONTokener
Direct Known Subclasses:
HTTPTokener, XMLTokener
@Deprecated public class JSONTokener extends Object
Deprecated.
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
    Description
    JSONTokener(InputStream inputStream)
    Deprecated.
    Construct a JSONTokener from an InputStream.
    JSONTokener(Reader reader)
    Deprecated.
    Construct a JSONTokener from a Reader.
    JSONTokener(String s)
    Deprecated.
    Construct a JSONTokener from a string.

  • Method Summary

    Modifier and Type
    Method
    Description
    void
    back()
    Deprecated.
    Back up one character.
    void
    close()
    Deprecated.
    Closes the underlying reader, releasing any resources associated with it.
    static int
    dehexchar(char c)
    Deprecated.
    Get the hex value of a character (base16).
    boolean
    end()
    Deprecated.
    Checks if the end of the input has been reached.
    boolean
    more()
    Deprecated.
    Determine if the source string still contains characters that next() can consume.
    char
    next()
    Deprecated.
    Get the next character in the source string.
    char
    next(char c)
    Deprecated.
    Consume the next character, and check that it matches a specified character.
    String
    next(int n)
    Deprecated.
    Get the next n characters.
    char
    nextClean()
    Deprecated.
    Get the next char in the string, skipping whitespace.
    String
    nextString(char quote)
    Deprecated.
    Return the characters up to the next close quote character.
    String
    nextTo(char delimiter)
    Deprecated.
    Get the text up but not including the specified character or the end of line, whichever comes first.
    String
    nextTo(String delimiters)
    Deprecated.
    Get the text up but not including one of the specified delimiter characters or the end of line, whichever comes first.
    Object
    nextValue()
    Deprecated.
    Get the next value.
    void
    skipPast(String to)
    Deprecated.
    Skip characters until past the requested string.
    char
    skipTo(char to)
    Deprecated.
    Skip characters until the next character is the requested character.
    JSONException
    syntaxError(String message)
    Deprecated.
    Make a JSONException to signal a syntax error.
    JSONException
    syntaxError(String message, Throwable causedBy)
    Deprecated.
    Make a JSONException to signal a syntax error.
    String
    toString()
    Deprecated.
    Make a printable string of this JSONTokener.

    Methods inherited from class java.lang.Object

    equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

  • Constructor Details

    • JSONTokener

      public JSONTokener(Reader reader)
      Deprecated.
      Construct a JSONTokener from a Reader. The caller must close the Reader.
      Parameters:
      reader - A reader.

    • JSONTokener

      public JSONTokener(InputStream inputStream)
      Deprecated.
      Construct a JSONTokener from an InputStream. The caller must close the input stream.
      Parameters:
      inputStream - The source.

    • JSONTokener

      public JSONTokener(String s)
      Deprecated.
      Construct a JSONTokener from a string.
      Parameters:
      s - A source string.

  • Method Details

    • back

      public void back() throws JSONException
      Deprecated.
      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 - Thrown if trying to step back more than 1 step or if already at the start of the string

    • dehexchar

      public static int dehexchar(char c)
      Deprecated.
      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

      public boolean end()
      Deprecated.
      Checks if the end of the input has been reached.
      Returns:
      true if at the end of the file and we didn't step back

    • more

      public boolean more() throws JSONException
      Deprecated.
      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 - thrown if there is an error stepping forward or backward while checking for more data.

    • next

      public char next() throws JSONException
      Deprecated.
      Get the next character in the source string.
      Returns:
      The next character, or 0 if past the end of the source string.
      Throws:
      JSONException - Thrown if there is an error reading the source string.

    • next

      public char next(char c) throws JSONException
      Deprecated.
      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 String next(int n) throws JSONException
      Deprecated.
      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
      Deprecated.
      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.

    • nextString

      public String nextString(char quote) throws JSONException
      Deprecated.
      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.

    • nextTo

      public String nextTo(char delimiter) throws JSONException
      Deprecated.
      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.
      Throws:
      JSONException - Thrown if there is an error while searching for the delimiter

    • nextTo

      public String nextTo(String delimiters) throws JSONException
      Deprecated.
      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 - Thrown if there is an error while searching for the delimiter

    • nextValue

      public Object nextValue() throws JSONException
      Deprecated.
      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.

    • skipPast

      public void skipPast(String to)
      Deprecated.
      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.

    • skipTo

      public char skipTo(char to) throws JSONException
      Deprecated.
      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 - Thrown if there is an error while searching for the to character

    • syntaxError

      public JSONException syntaxError(String message)
      Deprecated.
      Make a JSONException to signal a syntax error.
      Parameters:
      message - The error message.
      Returns:
      A JSONException object, suitable for throwing

    • syntaxError

      public JSONException syntaxError(String message, Throwable causedBy)
      Deprecated.
      Make a JSONException to signal a syntax error.
      Parameters:
      message - The error message.
      causedBy - The throwable that caused the error.
      Returns:
      A JSONException object, suitable for throwing

    • toString

      public String toString()
      Deprecated.
      Make a printable string of this JSONTokener.
      Overrides:
      toString in class Object
      Returns:
      " at {index} [character {character} line {line}]"

    • close

      public void close() throws IOException
      Deprecated.
      Closes the underlying reader, releasing any resources associated with it.
      Throws:
      IOException - If an I/O error occurs while closing the reader.