public interface JsonPointer
This interface represents an immutable implementation of a JSON Pointer as defined by RFC 6901.
A JSON Pointer, when applied to a target JsonValue,
defines a reference location in the target.
An empty JSON Pointer string defines a reference to the target itself.
If the JSON Pointer string is non-empty, it must be a sequence
of '/' prefixed tokens, and the target must either be a JsonArray
or JsonObject. If the target is a JsonArray, the pointer
defines a reference to an array element, and the last token specifies the index.
If the target is a JsonObject, the pointer defines a reference to a
name/value pair, and the last token specifies the name.
The method getValue() returns the referenced value.
Methods add(), replace(),
and remove() execute operations specified in
RFC 6902.
| Modifier and Type | Method and Description |
|---|---|
<T extends JsonStructure> |
add(T target,
JsonValue value)
Adds or replaces a value at the referenced location in the specified
target with the specified value. |
boolean |
containsValue(JsonStructure target)
Returns
true if there is a value at the referenced location in the specified target. |
JsonValue |
getValue(JsonStructure target)
Returns the value at the referenced location in the specified
target. |
<T extends JsonStructure> |
remove(T target)
Removes the value at the reference location in the specified
target. |
<T extends JsonStructure> |
replace(T target,
JsonValue value)
Replaces the value at the referenced location in the specified
target with the specified value. |
java.lang.String |
toString()
Returns the string representation of this JSON Pointer.
|
<T extends JsonStructure> T add(T target, JsonValue value)
target with the specified value.
value, which must be the same type as
specified target, is returned.value is inserted
into the array, at the referenced index. The value currently at that location, and
any subsequent values, are shifted to the right (adds one to the indices).
Index starts with 0. If the reference is specified with a "-", or if the
index is equal to the size of the array, the value is appended to the array.JsonObject, and the
referenced value exists, the value is replaced by the specified value.
If the value does not exist, a new name/value pair is added to the object.T - the target type, must be a subtype of JsonValuetarget - the target referenced by this JsonPointervalue - the value to be addedtarget after the value is added.java.lang.NullPointerException - if target is nullJsonException - if the reference is an array element and
the index is out of range (index < 0 || index > array size),
or if the pointer contains references to non-existing objects or arrays.<T extends JsonStructure> T remove(T target)
target.T - the target type, must be a subtype of JsonValuetarget - the target referenced by this JsonPointertarget after the value is removed.java.lang.NullPointerException - if target is nullJsonException - if the referenced value does not exist,
or if the reference is the target.<T extends JsonStructure> T replace(T target, JsonValue value)
target with the specified value.T - the target type, must be a subtype of JsonValuetarget - the target referenced by this JsonPointervalue - the value to be stored at the referenced locationtarget after the value is replaced.java.lang.NullPointerException - if target is nullJsonException - if the referenced value does not exist,
or if the reference is the target.boolean containsValue(JsonStructure target)
true if there is a value at the referenced location in the specified target.target - the target referenced by this JsonPointertrue if this pointer points to a value in a specified target.JsonValue getValue(JsonStructure target)
target.target - the target referenced by this JsonPointerjava.lang.NullPointerException - if target is nullJsonException - if the referenced value does not existjava.lang.String toString()
/' prefixed tokens.toString in class java.lang.Object