com.sigio.json

Class JSONReader

java.lang.Object

java.io.Reader

java.io.FilterReader

java.io.PushbackReader

com.sigio.json.JSONReader

All Implemented Interfaces:

java.io.Closeable, java.lang.AutoCloseable, java.lang.Readable

public class JSONReader
extends java.io.PushbackReader

Reader subclass to read JSON data and create JSON objects.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.Character	EOF A special Character constant to return if the reader hits EOF.

Fields inherited from class java.io.FilterReader

in

Fields inherited from class java.io.Reader

lock

Constructor Summary

Constructors

Constructor and Description
JSONReader(java.io.Reader in) Create a new JSONReader with a default pushback buffer.
JSONReader(java.io.Reader in, int size) Create a new JSONReader with a specified Pushback buffer size.

Method Summary

Modifier and Type	Method and Description
int	peek() A special method to take advantage of the features of our parent PushbackWriter.
int	read() Reads a single character.
int	read(char[] buf, int off, int len) Reads characters into a portion of an array.
java.lang.Object	readValue() Specialized read method to read JSON objects from the input data.
void	unread(char[] buf) Pushes back an array of characters by copying it to the front of the pushback buffer.
void	unread(char[] buf, int off, int len) Pushes back a portion of an array of characters by copying it to the front of the pushback buffer.
void	unread(int c) Pushes back a single character by copying it to the front of the pushback buffer.

Methods inherited from class java.io.PushbackReader

close, mark, markSupported, ready, reset, skip

Methods inherited from class java.io.Reader

read, read

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

EOF

public static final java.lang.Character EOF

A special Character constant to return if the reader hits EOF.

Constructor Detail

JSONReader

public JSONReader(java.io.Reader in)

Create a new JSONReader with a default pushback buffer. The default can pushback 1 character at a time.

JSONReader

public JSONReader(java.io.Reader in,
                  int size)

Create a new JSONReader with a specified Pushback buffer size.

Method Detail

readValue

public java.lang.Object readValue()
                           throws java.io.IOException,
                                  JSONException

Specialized read method to read JSON objects from the input data.

Returns:

object representing the JSON value read from the input

Throws:

java.io.IOException - if a read error occurs.

JSONException - if the input is not properly formed JSON according to RFC4627

peek

public int peek()
         throws java.io.IOException

A special method to take advantage of the features of our parent PushbackWriter. It will read the next character from the input, push it back on the buffer and then return it.

Returns:

integer representing the character read from the input

Throws:

java.io.IOException - if a read error occurs.

read

public int read()
         throws java.io.IOException

Reads a single character.

Overrides:

read in class java.io.PushbackReader

Returns:

The character read, or -1 if the end of stream has been reached.

Throws:

java.io.IOException - If an I/O error occurs

read

public int read(char[] buf,
                int off,
                int len)
         throws java.io.IOException

Reads characters into a portion of an array.

Overrides:

read in class java.io.PushbackReader

Parameters:

buf - Destination buffer

off - Offset at which to start writing characters

len - Maximum number of characters to read

Returns:

The number of characters read, or -1 if the end of the stream has been reached

Throws:

java.io.IOException - If an I/O error occurs

unread

public void unread(int c)
            throws java.io.IOException

Pushes back a single character by copying it to the front of the pushback buffer. After this method returns, the next character to be read will have the value (char)c.

Overrides:

unread in class java.io.PushbackReader

Parameters:

c - The int value representing a character to be pushed back

Throws:

If - the pushback buffer is full, or if some other I/O error occurs

java.io.IOException

unread

public void unread(char[] buf,
                   int off,
                   int len)
            throws java.io.IOException

Pushes back a portion of an array of characters by copying it to the front of the pushback buffer. After this method returns, the next character to be read will have the value cbuf[off], the character after that will have the value cbuf[off+1], and so forth.

Overrides:

unread in class java.io.PushbackReader

Parameters:

buf - Character array to push back

off - Offset of first character to push back

len - Number of characters to push back

Throws:

java.io.IOException - If there is insufficient room in the pushback buffer, or if some other I/O error occurs

unread

public void unread(char[] buf)
            throws java.io.IOException

Pushes back an array of characters by copying it to the front of the pushback buffer. After this method returns, the next character to be read will have the value buf[0], the character after that will have the value buf[1], and so forth.

Overrides:

unread in class java.io.PushbackReader

Parameters:

buf - Character array to push back

Throws:

java.io.IOException - If there is insufficient room in the pushback buffer, or if some other I/O error occurs