Module org.bzdev.obnaming

Package org.bzdev.obnaming

Class NJSUtilities.JSON

java.lang.Object

org.bzdev.util.JSUtilities.JSON

org.bzdev.obnaming.NJSUtilities.JSON

Enclosing class:

NJSUtilities

public static class NJSUtilities.JSON
extends JSUtilities.JSON

Methods for parsing and generating JSON. All the public methods of this class are static. An extended syntax is used for parsing (but not for writing):

• Comments consist of the sequence '//', not within a string, and contain all characters up to the end of a line.
• For a JSON object in a key/value pair, the quoting the key is optional when the key is syntactically a Java identifier.

These extensions are useful when a file containing JSON-formated values is used as an input to a program. The object returned by the parser can be used to configure a named-object factory (using the syntax described in the documentation for NamedObjectFactory.

Nested Class Summary

Nested classes/interfaces inherited from class org.bzdev.util.JSUtilities.JSON

JSUtilities.JSON.Parser

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	JSON()	Constructor.

Method Summary

Modifier and Type	Method	Description
static Object	parse(char[] buffer)	JSON parser that reads JSON-formated text from a character array.
static Object	parse(InputStream is, String charsetName)	JSON parser that reads JSON-formatted text from an InputStream given a String providing the name of a character set.
static Object	parse(InputStream is, Charset cs)	JSON parser that reads JSON-formatted text from an InputStream given a Charset.
static Object	parse(InputStream is, CharsetDecoder dec)	JSON parser that reads JSON-formatted text from an InputStream given a CharsetDecoder.
static Object	parse(Reader r)	JSON parser that reads JSON-formated text from a Reader.
static Object	parse(String s)	JSON parser that reads JSON-formated text from a String.
protected void	write(Writer w, Object object)	Write an object.
static void	writeTo(Writer w, Object object)	Write a JSON representation of an object.

Methods inherited from class org.bzdev.util.JSUtilities.JSON

quote, write, write, write, write, write

Methods inherited from class java.lang.Object

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

Constructor Details

JSON

protected JSON()

Constructor.

Method Details

writeTo

public static void writeTo(Writer w,
 Object object)
                    throws IOException

Write a JSON representation of an object. The type of the object may be NamedObjectOps, JSObject, JSArray, String, Number, or Boolean. For an instance of NamedObjectOps, the name of the object will be written as a JSON string.

Parameters:

w - a writer

object - the object to write

Throws:

IOException - an error occurred while writing

write

protected void write(Writer w,
 Object object)
              throws IOException

Description copied from class: JSUtilities.JSON

Write an object. This method dispatches the operation to methods for specific object types.

Overrides:

write in class JSUtilities.JSON

Parameters:

w - the writer

object - the object

Throws:

IOException - if an IO error occurred

parse

public static Object parse(InputStream is,
 String charsetName)
                    throws IOException,
UnsupportedEncodingException

JSON parser that reads JSON-formatted text from an InputStream given a String providing the name of a character set. The result's type, if the result is not null, is either JSObject, JSArray, String, Number, or Boolean.

Parameters:

is - the input stream (containing a JSON value)

charsetName - the name of the charset used by the input stream

Returns:

the result of parsing

Throws:

IOException - an error occurred while reading from the input stream

UnsupportedEncodingException - the charsetName does not match a known charset

parse

public static Object parse(InputStream is,
 CharsetDecoder dec)
                    throws IOException

JSON parser that reads JSON-formatted text from an InputStream given a CharsetDecoder. The result's type, if the result is not null, is either JSObject, JSArray, String, Number, or Boolean.

Parameters:

is - the input stream (containing a JSON value)

dec - the charset decoder used to turn the input stream into a sequence of characters

Returns:

the result of parsing

Throws:

IOException - an error occurred while reading from the input stream

parse

public static Object parse(InputStream is,
 Charset cs)
                    throws IOException

JSON parser that reads JSON-formatted text from an InputStream given a Charset. The result's type, if the result is not null, is either JSObject, JSArray, String, Number, or Boolean.

Parameters:

is - the input stream (containing a JSON value)

cs - the charset for the input stream

Returns:

the result of parsing

Throws:

IOException - an error occurred while reading from the input stream

parse

public static Object parse(char[] buffer)
                    throws IOException

JSON parser that reads JSON-formated text from a character array. The result's type, if the result is not null, is either JSObject, JSArray, String, Number, or Boolean.

Parameters:

buffer - the input character sequence (containing a JSON value)

Returns:

the result of parsing

Throws:

IOException - an error occurred while reading from the input stream

parse

public static Object parse(String s)
                    throws IOException

JSON parser that reads JSON-formated text from a String. The result's type, if the result is not null, is either JSObject, JSArray, String, Number, or Boolean.

Parameters:

s - the input string (containing a JSON value)

Returns:

the result of parsing

Throws:

IOException - an error occurred while reading from the input stream

parse

public static Object parse(Reader r)
                    throws IOException

JSON parser that reads JSON-formated text from a Reader. The result's type, if the result is not null, is either JSObject, JSArray, String, Number, or Boolean.

Parameters:

r - the reader

Returns:

the object.

Throws:

IOException - an error occurred while reading from the input stream