Class NodeReference.ObjectReference

java.lang.Object

org.glassfish.json.NodeReference

org.glassfish.json.NodeReference.ObjectReference

Enclosing class:

NodeReference

static class NodeReference.ObjectReference
extends NodeReference

Nested Class Summary

Nested classes/interfaces inherited from class NodeReference

NodeReference.ArrayReference, NodeReference.ObjectReference, NodeReference.RootReference

Field Summary

Fields

Modifier and Type	Field	Description
private final String	key
private final JsonObject	object

Constructor Summary

Constructors

Constructor	Description
ObjectReference(JsonObject object, String key)

Method Summary

Modifier and Type	Method	Description
JsonObject	add(JsonValue value)	Add or replace a value at the referenced location.
boolean	contains()	Return true if a reference points to a valid value, false otherwise.
JsonValue	get()	Get the value at the referenced location.
JsonObject	remove()	Remove the name/value pair from the JSON object, or the value in a JSON array, as specified by the reference
JsonObject	replace(JsonValue value)	Replace the referenced value with the specified value.

Methods inherited from class NodeReference

of, of, of

Methods inherited from class Object

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

Field Details

object

private final JsonObject object

key

private final String key

Constructor Details

ObjectReference

ObjectReference(JsonObject object,
 String key)

Method Details

contains

public boolean contains()

Description copied from class: NodeReference

Return true if a reference points to a valid value, false otherwise.

Specified by:

contains in class NodeReference

Returns:

true if a reference points to a value

get

public JsonValue get()

Description copied from class: NodeReference

Get the value at the referenced location.

Specified by:

get in class NodeReference

Returns:

the JSON value referenced

add

public JsonObject add(JsonValue value)

Description copied from class: NodeReference

Add or replace a value at the referenced location. If the reference is the root of a JSON tree, the added value must be a JSON object or array, which becomes the referenced JSON value. If the reference is an index of a JSON array, the value is inserted into the array at the index. If the index is -1, the value is appended to the array. If the reference is a name of a JSON object, the name/value pair is added to the object, replacing any pair with the same name.

Specified by:

add in class NodeReference

Parameters:

value - the value to be added

Returns:

the JsonStructure after the operation

remove

public JsonObject remove()

Description copied from class: NodeReference

Remove the name/value pair from the JSON object, or the value in a JSON array, as specified by the reference

Specified by:

remove in class NodeReference

Returns:

the JsonStructure after the operation

replace

public JsonObject replace(JsonValue value)

Description copied from class: NodeReference

Replace the referenced value with the specified value.

Specified by:

replace in class NodeReference

Parameters:

value - the JSON value to be stored at the referenced location

Returns:

the JsonStructure after the operation