org.fossnova.json

Interface JsonObject

All Superinterfaces:

java.lang.Cloneable, JsonValue, java.util.Map<java.lang.String,JsonValue>, java.io.Serializable

public interface JsonObject
extends JsonValue, java.util.Map<java.lang.String,JsonValue>

JSON object.

Author:

Richard Opalka

See Also:

JsonValue, JsonValueFactory

Nested Class Summary

Nested classes/interfaces inherited from interface java.util.Map

java.util.Map.Entry<K,V>

Method Summary

Modifier and Type	Method and Description
JsonObject	clone() Clones this JSON object.
boolean	containsKey(java.lang.String key) Delegates the call to Map.containsKey(Object) method.
boolean	containsNullValue() Delegates the call to Map.containsValue(Object) method.
boolean	containsValue(java.lang.Boolean value) Wraps passed value with JsonBoolean and delegates the call to Map.containsValue(Object) method.
boolean	containsValue(JsonValue value) Delegates the call to Map.containsValue(Object) method.
boolean	containsValue(java.lang.Number value) Wraps passed value with JsonNumber and delegates the call to Map.containsValue(Object) method.
boolean	containsValue(java.lang.String value) Wraps passed value with JsonString and delegates the call to Map.containsValue(Object) method.
JsonValue	get(java.lang.String key) Delegates the call to Map.get(Object) method.
JsonValue	put(java.lang.String key, java.lang.Boolean value) Wraps passed value with JsonBoolean and delegates the call to Map.put(Object, Object) method.
JsonValue	put(java.lang.String key, java.lang.Number value) Wraps passed value with JsonNumber and delegates the call to Map.put(Object, Object) method.
JsonValue	put(java.lang.String key, java.lang.String value) Wraps passed value with JsonString and delegates the call to Map.put(Object, Object) method.
JsonValue	putNull(java.lang.String key) Delegates the call to Map.put(Object, Object) method.
JsonValue	remove(java.lang.String key) Delegates the call to Map.remove(Object) method.
void	writeTo(JsonWriter output) Serializes this JSON object to the writer.
void	writeTo(java.io.OutputStream output) Serializes this JSON object to the stream using UTF-8 character set.
void	writeTo(java.io.OutputStream output, java.nio.charset.Charset charset) Serializes this JSON object to the writer using specified character set.
void	writeTo(java.io.Writer output) Serializes this JSON object to the writer.

Methods inherited from interface java.util.Map

clear, compute, computeIfAbsent, computeIfPresent, containsKey, containsValue, entrySet, equals, forEach, get, getOrDefault, hashCode, isEmpty, keySet, merge, put, putAll, putIfAbsent, remove, remove, replace, replace, replaceAll, size, values

Method Detail

containsKey

boolean containsKey(java.lang.String key)

Delegates the call to Map.containsKey(Object) method.

Parameters:

key - JSON string

Returns:

true if this map contains a mapping for the specified key

containsValue

boolean containsValue(java.lang.String value)

Wraps passed value with JsonString and delegates the call to Map.containsValue(Object) method.

Parameters:

value - string to wrap

Returns:

true if this JSON object maps one or more keys to the specified value

containsValue

boolean containsValue(java.lang.Boolean value)

Wraps passed value with JsonBoolean and delegates the call to Map.containsValue(Object) method.

Parameters:

value - boolean to wrap

Returns:

true if this JSON object maps one or more keys to the specified value

containsValue

boolean containsValue(java.lang.Number value)

Wraps passed value with JsonNumber and delegates the call to Map.containsValue(Object) method.

Parameters:

value - number to wrap

Returns:

true if this JSON object maps one or more keys to the specified value

containsValue

boolean containsValue(JsonValue value)

Delegates the call to Map.containsValue(Object) method.

Parameters:

value - JSON value

Returns:

true if this JSON object maps one or more keys to the specified value

containsNullValue

boolean containsNullValue()

Delegates the call to Map.containsValue(Object) method.

Returns:

true if this JSON object maps one or more keys to null

get

JsonValue get(java.lang.String key)

Delegates the call to Map.get(Object) method.

Parameters:

key - JSON string

Returns:

the JSON value to which the specified key is mapped, or null if this JSON object contains no mapping for the key

put

JsonValue put(java.lang.String key,
              java.lang.String value)

Wraps passed value with JsonString and delegates the call to Map.put(Object, Object) method.

Parameters:

key - JSON string

value - string to wrap

Returns:

the previous value associated with key, or null if there was no mapping for key.

put

JsonValue put(java.lang.String key,
              java.lang.Boolean value)

Wraps passed value with JsonBoolean and delegates the call to Map.put(Object, Object) method.

Parameters:

key - JSON string

value - boolean to wrap

Returns:

the previous value associated with key, or null if there was no mapping for key.

put

JsonValue put(java.lang.String key,
              java.lang.Number value)

Wraps passed value with JsonNumber and delegates the call to Map.put(Object, Object) method.

Parameters:

key - JSON string

value - number to wrap

Returns:

the previous value associated with key, or null if there was no mapping for key.

putNull

JsonValue putNull(java.lang.String key)

Delegates the call to Map.put(Object, Object) method.

Parameters:

key - JSON string

Returns:

the previous value associated with key, or null if there was no mapping for key.

remove

JsonValue remove(java.lang.String key)

Delegates the call to Map.remove(Object) method.

Parameters:

key - JSON string

Returns:

the previous value associated with key, or null if there was no mapping for key.

writeTo

void writeTo(JsonWriter output)
      throws java.io.IOException,
             JsonException

Serializes this JSON object to the writer.

Parameters:

output - to write to

Throws:

java.io.IOException - if some I/O error occurs

JsonException - if wrong JSON is detected

writeTo

void writeTo(java.io.Writer output)
      throws java.io.IOException,
             JsonException

Serializes this JSON object to the writer.

Parameters:

output - to write to

Throws:

java.io.IOException - if some I/O error occurs

JsonException - if wrong JSON is detected

writeTo

void writeTo(java.io.OutputStream output)
      throws java.io.IOException,
             JsonException

Serializes this JSON object to the stream using UTF-8 character set.

Parameters:

output - to write to

Throws:

java.io.IOException - if some I/O error occurs

JsonException - if wrong JSON is detected

writeTo

void writeTo(java.io.OutputStream output,
             java.nio.charset.Charset charset)
      throws java.io.IOException,
             JsonException

Serializes this JSON object to the writer using specified character set.

Parameters:

output - to write to

charset - character set

Throws:

java.io.IOException - if some I/O error occurs

JsonException - if wrong JSON is detected

clone

JsonObject clone()

Clones this JSON object.

Specified by:

clone in interface JsonValue

Returns:

new JSON object clone.