Scanner

java.lang.Object
- org.json.Scanner

Direct Known Subclasses:

JSONTokener
```
public class Scanner
extends java.lang.Object
```
A Scanner takes a source stream and extracts characters and character sequences from it. It is extended by the various tokener classes to parse JSON source streams.

Constructor Summary

Constructors
Constructor and Description
`Scanner(java.io.InputStream inputStream, java.nio.charset.Charset charset)` Construct a Scanner from an InputStream and supplied Charset.
`Scanner(java.io.Reader reader)` Construct a Scanner from a Reader.
`Scanner(java.lang.String s)` Construct a Scanner from a string.

Method Summary

All Methods Static Methods Instance Methods Concrete 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`	`end()` Determine if the scanner is at the end of the stream.
`boolean`	`more()` Determine if the source stream still contains characters that next() can consume.
`char`	`next()` Get the next character in the source stream.
`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.
`java.lang.String`	`nextTo(char delimiter)` 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.
`ParsePosition`	`parsePosition()` Get an object representing the current parse position.
`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.
`JSONException`	`syntaxError(java.lang.String message, java.lang.Throwable cause)` Make a JSONException to signal a syntax error.
`JSONException`	`syntaxError(java.lang.Throwable cause)` Make a JSONException to signal a syntax error.
`java.lang.String`	`toString()` Make a printable string of this Scanner.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - Scanner
```
public Scanner(java.io.Reader reader)
```
    Construct a Scanner from a Reader.
    
    Parameters:
    
    reader - A reader.
  - Scanner
```
public Scanner(java.io.InputStream inputStream,
               java.nio.charset.Charset charset)
```
    Construct a Scanner from an InputStream and supplied Charset.
    
    Parameters:
    
    inputStream - the input stream
    
    charset - the character set with which to interpret the input stream
  - Scanner
```
public Scanner(java.lang.String s)
```
    Construct a Scanner 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
  - 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.
  - end
```
public boolean end()
```
    Determine if the scanner is at the end of the stream.
    
    Returns:
    
    true if this scanner has reached the end of the stream, otherwise false
  - more
```
public boolean more()
             throws JSONException
```
    Determine if the source stream still contains characters that next() can consume.
    
    Returns:
    
    true if not yet at the end of the source.
    
    Throws:
    
    JSONException
  - next
```
public char next()
          throws JSONException
```
    Get the next character in the source stream.
    
    Returns:
    
    The next character, or 0 if past the end of the source stream.
    
    Throws:
    
    JSONException
  - 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 stream.
  - 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
  - nextTo
```
public java.lang.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.
    
    Throws:
    
    JSONException
  - 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
  - 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
  - syntaxError
```
public JSONException syntaxError(java.lang.Throwable cause)
```
    Make a JSONException to signal a syntax error.
    
    Parameters:
    
    cause - The underlying cause.
    
    Returns:
    
    A JSONException object, suitable for throwing
  - syntaxError
```
public JSONException syntaxError(java.lang.String message,
                                 java.lang.Throwable cause)
```
    Make a JSONException to signal a syntax error.
    
    Parameters:
    
    message - The error message.
    
    cause - The underlying cause.
    
    Returns:
    
    A JSONException object, suitable for throwing
  - parsePosition
```
public ParsePosition parsePosition()
```
    Get an object representing the current parse position. The object represents a point-in-time during the parse.
    
    Returns:
    
    a ParsePosition representing the current location of the scanner
  - toString
```
public java.lang.String toString()
```
    Make a printable string of this Scanner.
    
    Overrides:
    
    toString in class java.lang.Object
    
    Returns:
    
    " at {index} [character {character} line {line}]"

Class Scanner

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Scanner

Scanner

Scanner

Method Detail

back

dehexchar

end

more

next

next

next

skipTo

nextTo

nextTo

syntaxError

syntaxError

syntaxError

parsePosition

toString