Package de.uniks.networkparser.json

Class JsonObject

java.lang.Object

de.uniks.networkparser.list.AbstractArray<K>

de.uniks.networkparser.list.SimpleKeyValueList<java.lang.String,java.lang.Object>

de.uniks.networkparser.json.JsonObject

All Implemented Interfaces:

BaseItem, Entity

Direct Known Subclasses:

Event, JsonObjectLazy

public class JsonObject
extends SimpleKeyValueList<java.lang.String,java.lang.Object>
implements Entity

A JsonObject is an unordered collection of name/value pairs. Its external form is a string wrapped in curly braces with colons between the names and values, and commas between the values and names. The internal form is an object having get and opt methods for accessing the values by name, and put methods for adding or replacing values by name. The values can be any of these types: Boolean, JsonArray, JsonObject, Number, String, or the JsonObject.NULL object. A JsonObject constructor can be used to convert an external form JSON text into an internal form whose values can be retrieved with the get and opt methods, or to convert values into a JSON text using the put and toString methods. A get method returns a value if one can be found, and throws an exception if one cannot be found. An opt method returns a default value instead of throwing an exception, and so is useful for obtaining optional values.

The generic get() and opt() methods return an object, which you can cast or query for type. There are also typed get and opt methods that do type checking and type coercion for you. The opt methods differ from the get methods in that they do not throw. Instead, they return a specified value, such as null.

The put methods add or replace values in an object. For example,

 myString = new JsonObject().put("JSON", "Hello, World!").toString();
 

produces the string {"JSON": "Hello, World"}.

The texts produced by the toString methods strictly conform to the JSON syntax rules. The constructors are more forgiving in the texts they will accept:

• An extra , (comma) may appear just before the closing brace.
• Strings may be quoted with ' (single quote).
• Strings do not need to be quoted at all if they do not begin with a quote or single quote, and if they do not contain leading or trailing spaces, and if they do not contain any of these characters: {} [ ] / \ : , = ; # and if they do not look like numbers and if they are not the reserved words true, false, or null.
• Keys can be followed by = or => as well as by :.
• Values can be followed by ; (semicolon) as well as by , (comma).

Nested Class Summary

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

java.util.Map.Entry<K extends java.lang.Object,V extends java.lang.Object>

Field Summary

Fields

Modifier and Type	Field	Description
static char	END
static char	START

Fields inherited from class de.uniks.networkparser.list.AbstractArray

ALLOWDUPLICATE, ALLOWEMPTYVALUE, BIDI, CASESENSITIVE, flag, MAP, READONLY, REMOVED, VISIBLE

Fields inherited from interface de.uniks.networkparser.interfaces.BaseItem

CLASS, CRLF, ENCODING

Constructor Summary

Constructors

Constructor	Description
JsonObject()

Method Summary

Modifier and Type	Method	Description
JsonObject	addToList(java.lang.String key, java.lang.Object value)	Accumulate values under a key.
static JsonObject	create(java.lang.String value)
Entity	getElementBy(java.lang.String key, java.lang.String value)
JsonArray	getJsonArray(java.lang.String key)	Get the JsonArray value associated with a key.
JsonObject	getJsonObject(java.lang.String key)	Get the JsonObject value associated with a key.
BaseItem	getNewList(boolean keyValue)	Get a new Instance of JsonArray, JsonObject
boolean	has(java.lang.String key)	check if Entity has the Key
protected java.lang.String	parseItem(EntityStringConverter converter)
JsonObject	setType(java.lang.String type)
java.lang.String	toString()	Make a JSON text of this JsonObject.
java.lang.String	toString(int indentFactor)	Make a prettyprinted JSON text of this JsonObject.
JsonObject	withEntity(SimpleKeyValueList<?,?> entity)	Tokener to init the JsonObject
JsonObject	withKeyValue(java.lang.Object key, java.lang.Object value)
JsonObject	withKeyValue(java.lang.String key, java.lang.Object value)
Entity	without(java.lang.String key)
JsonObject	withTokener(Tokener x)	Tokener to init the JsonObject
JsonObject	withValue(Buffer values)	Set the value to Tokener or pairs of values
JsonObject	withValue(java.lang.String... values)	Set the value to Tokener or pairs of values

Methods inherited from class de.uniks.networkparser.list.AbstractArray

addHashItem, addKeyValue, checkValue, clear, contains, containsAll, containsAll, fireProperty, first, flag, get, getByIndex, getPositionKey, getTypClass, getValue, hashKey, hasKeyAndPos, indexOf, init, init, init, isAllowDuplicate, isAllowEmptyValue, isCaseSensitive, isEmpty, isReadOnly, isVisible, last, lastIndexOf, move, pack, removeAll, removeByObject, removeItem, reset, reset, retainAll, setAllowEmptyValue, setFlag, setValue, size, subList, toArray, toArray, toString, with, withAllowDuplicate, withAllowEmptyValue, withCaseSensitive, withFlag, without, withSize, withType, withVisible

Methods inherited from interface de.uniks.networkparser.interfaces.BaseItem

add, size, toString

Methods inherited from interface de.uniks.networkparser.interfaces.Entity

getKeyByIndex, getString, getValue, getValueByIndex, put, setAllowEmptyValue

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Methods inherited from interface java.util.Map

clear, compute, computeIfAbsent, computeIfPresent, entry, forEach, getOrDefault, hashCode, isEmpty, merge, of, of, of, of, of, of, of, of, of, of, of, ofEntries, putIfAbsent, remove, replace, replace, replaceAll, size

Methods inherited from class java.lang.Object

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

Methods inherited from class de.uniks.networkparser.list.SimpleKeyValueList

add, add, add, addToKeyValue, comparator, containsKey, containsValue, copyEntity, entrySet, equals, get, getBoolean, getDouble, getInt, getInt, getKey, getKeyByIndex, getLong, getPositionValue, getString, getString, getValueByIndex, increment, indexOfValue, isComparator, iterator, keyIterator, keySet, put, putAll, remove, removeByIndex, removePos, replaceAllValues, setValue, setValueItem, toTable, values, valuesArrayIntern, with, withComparator, withKeyValueString, withList, withMap, withMultIndex

Field Detail

START

public static final char START

See Also:

Constant Field Values

END

public static final char END

See Also:

Constant Field Values

Constructor Detail

JsonObject

public JsonObject()

Method Detail

getJsonArray

public JsonArray getJsonArray(java.lang.String key)

Get the JsonArray value associated with a key.

Parameters:

key - A key string.

Returns:

A JsonArray which is the value. if the key is not found or if the value is not a JsonArray.

getJsonObject

public JsonObject getJsonObject(java.lang.String key)

Get the JsonObject value associated with a key.

Parameters:

key - A key string.

Returns:

A JsonObject which is the value.

Throws:

java.lang.RuntimeException - if the key is not found or if the value is not a JsonObject.

toString

public java.lang.String toString()

Make a JSON text of this JsonObject. For compactness, no whitespace is added. If this would not result in a syntactically correct JSON text, then null will be returned instead.

Warning: This method assumes that the data structure is acyclical.

Specified by:

toString in interface BaseItem

Overrides:

toString in class AbstractArray<java.lang.String>

Returns:

a printable, displayable, portable, transmittable representation of the object, beginning with { (left brace) and ending with } (right brace).

toString

public java.lang.String toString(int indentFactor)

Make a prettyprinted JSON text of this JsonObject.

Warning: This method assumes that the data structure is acyclical.

Specified by:

toString in interface Entity

Parameters:

indentFactor - The number of spaces to add to each level of indentation.

Returns:

a printable, displayable, portable, transmittable representation of the object, beginning with { (left brace) and ending with } (right brace).

parseItem

protected java.lang.String parseItem(EntityStringConverter converter)

Overrides:

parseItem in class AbstractArray<java.lang.String>

withValue

public JsonObject withValue(java.lang.String... values)

Set the value to Tokener or pairs of values

Parameters:

values - a simple String of Value or pairs of key-values

Returns:

Itself

withValue

public JsonObject withValue(Buffer values)

Set the value to Tokener or pairs of values

Specified by:

withValue in interface Entity

Parameters:

values - a simple String of Value or pairs of key-values

Returns:

Itself

withTokener

public JsonObject withTokener(Tokener x)

Tokener to init the JsonObject

Parameters:

x - tokener to add values with the tokener

Returns:

Itself

withEntity

public JsonObject withEntity(SimpleKeyValueList<?,?> entity)

Tokener to init the JsonObject

Parameters:

entity - entity to add values with the tokener

Returns:

Itself

getNewList

public BaseItem getNewList(boolean keyValue)

Get a new Instance of JsonArray, JsonObject

Specified by:

getNewList in interface BaseItem

Overrides:

getNewList in class SimpleKeyValueList<java.lang.String,java.lang.Object>

has

public boolean has(java.lang.String key)

Description copied from interface: Entity

check if Entity has the Key

Specified by:

has in interface Entity

Parameters:

key - The Key for search

Returns:

success if the item has the Property

withKeyValue

public JsonObject withKeyValue(java.lang.Object key,
                               java.lang.Object value)

Overrides:

withKeyValue in class SimpleKeyValueList<java.lang.String,java.lang.Object>

addToList

public JsonObject addToList(java.lang.String key,
                            java.lang.Object value)

Accumulate values under a key. It is similar to the put method except that if there is already an object stored under the key then a EntityList is stored under the key to hold all of the accumulated values. If there is already a EntityList, then the new value is appended to it. In contrast, the put method replaces the previous value. If only one value is accumulated that is not a EntityList, then the result will be the same as using put. But if multiple values are accumulated, then the result will be like append.

Parameters:

key - A key string.

value - An object to be accumulated under the key.

Returns:

this.

withKeyValue

public JsonObject withKeyValue(java.lang.String key,
                               java.lang.Object value)

without

public Entity without(java.lang.String key)

Specified by:

without in interface Entity

create

public static JsonObject create(java.lang.String value)

getElementBy

public Entity getElementBy(java.lang.String key,
                           java.lang.String value)

Specified by:

getElementBy in interface Entity

setType

public JsonObject setType(java.lang.String type)

Specified by:

setType in interface Entity