Module org.shredzone.acme4j

Package org.shredzone.acme4j.toolbox

Class JSON

java.lang.Object

org.shredzone.acme4j.toolbox.JSON

All Implemented Interfaces:

Serializable

public final class JSON
extends Object
implements Serializable

A model containing a JSON result. The content is immutable.

See Also:

• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	JSON.Array	Represents a JSON array.
static final class	JSON.Value	A single JSON value.

Method Summary

Modifier and Type	Method	Description
boolean	contains(String key)	Checks if this object contains the given key.
static JSON	empty()	Returns a JSON of an empty document.
static JSON	fromMap(Map<String,Object> data)	Creates a JSON object from a map.
JSON.Value	get(String key)	Returns the JSON.Value of the given key.
JSON.Value	getFeature(String key)	Returns the JSON.Value of the given key.
Set<String>	keySet()	Returns a set of all keys of this object.
static JSON	parse(InputStream in)	Parses JSON from an InputStream.
static JSON	parse(String json)	Parses JSON from a String.
Map<String,Object>	toMap()	Returns the content as unmodifiable Map.
String	toString()	Returns the content as JSON string.

Methods inherited from class java.lang.Object

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

Method Details

parse

public static JSON parse(InputStream in)
                  throws IOException

Parses JSON from an InputStream.

Parameters:

in - InputStream to read from. Will be closed after use.

Returns:

JSON of the read content.

Throws:

IOException

parse

public static JSON parse(String json)

Parses JSON from a String.

Parameters:

json - JSON string

Returns:

JSON of the read content.

fromMap

public static JSON fromMap(Map<String,Object> data)

Creates a JSON object from a map.

The map's content is deeply copied. Changes to the map won't reflect in the created JSON structure.

Parameters:

data - Map structure

Returns:

JSON of the map's content.

Since:

3.2.0

empty

public static JSON empty()

Returns a JSON of an empty document.

Returns:

Empty JSON

keySet

public Set<String> keySet()

Returns a set of all keys of this object.

Returns:

Set of keys

contains

public boolean contains(String key)

Checks if this object contains the given key.

Parameters:

key - Name of the key to check

Returns:

true if the key is present

get

public JSON.Value get(String key)

Returns the JSON.Value of the given key.

Parameters:

key - Key to read

Returns:

JSON.Value of the key

getFeature

public JSON.Value getFeature(String key)

Returns the JSON.Value of the given key.

Parameters:

key - Key to read

Returns:

JSON.Value of the key

Throws:

AcmeNotSupportedException - if the key is not present. The key is used as feature name.

toString

public String toString()

Returns the content as JSON string.

Overrides:

toString in class Object

toMap

public Map<String,Object> toMap()

Returns the content as unmodifiable Map.

Since:

2.8