Class JsonPointerImpl
- All Implemented Interfaces:
Serializable
,JsonPointer
This class is an immutable representation of a JSON Pointer as specified in 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.
The methods add()
, replace()
,
and remove()
executes the operations specified in
RFC 6902.
- Since:
- 1.1
- See Also:
-
Field Summary
Fields -
Constructor Summary
ConstructorsConstructorDescriptionJsonPointerImpl
(String jsonPointer) Constructs and initializes a JsonPointerImpl. -
Method Summary
Modifier and TypeMethodDescriptionadd
(JsonStructure target, JsonValue value) Adds or replaces a value at the referenced location in the specifiedtarget
with the specifiedvalue
.boolean
containsValue
(JsonStructure target) Returnstrue
if there is a value at the referenced location in the specifiedtarget
.boolean
Compares thisJsonPointer
with another object.private JsonStructure
execute
(BiFunction<NodeReference, JsonValue, JsonStructure> op, JsonStructure target, JsonValue value) Executes the operationprivate static int
Computes the array indexprivate NodeReference[]
getReferences
(JsonStructure target) Computes theNodeReference
s for each node on the path of the JSON Pointer, in reverse order, starting from the leaf nodegetValue
(JsonStructure target) Returns the value at the referenced location in the specifiedtarget
int
hashCode()
Returns the hash code value for thisJsonPointer
object.remove
(JsonStructure target) Removes the value at the reference location in the specifiedtarget
replace
(JsonStructure target, JsonValue value) Replaces the value at the referenced location in the specifiedtarget
with the specifiedvalue
.
-
Field Details
-
serialVersionUID
private static final long serialVersionUID- See Also:
-
tokens
-
jsonPointer
-
-
Constructor Details
-
JsonPointerImpl
Constructs and initializes a JsonPointerImpl.- Parameters:
jsonPointer
- the JSON Pointer string- Throws:
NullPointerException
- ifjsonPointer
isnull
JsonException
- ifjsonPointer
is not a valid JSON Pointer
-
-
Method Details
-
equals
Compares thisJsonPointer
with another object. -
hashCode
public int hashCode()Returns the hash code value for thisJsonPointer
object. The hash code of this object is defined by the hash codes of it's reference tokens. -
containsValue
Returnstrue
if there is a value at the referenced location in the specifiedtarget
.- Specified by:
containsValue
in interfaceJsonPointer
- Parameters:
target
- the target referenced by thisJsonPointer
- Returns:
true
if this pointer points to a value in a specifiedtarget
.
-
getValue
Returns the value at the referenced location in the specifiedtarget
- Specified by:
getValue
in interfaceJsonPointer
- Parameters:
target
- the target referenced by thisJsonPointer
- Returns:
- the referenced value in the target.
- Throws:
NullPointerException
- iftarget
is nullJsonException
- if the referenced value does not exist
-
add
Adds or replaces a value at the referenced location in the specifiedtarget
with the specifiedvalue
.- If the reference is the target (empty JSON Pointer string),
the specified
value
, which must be the same type as specifiedtarget
, is returned. - If the reference is an array element, the specified
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. - If the reference is a name/value pair of a
JsonObject
, and the referenced value exists, the value is replaced by the specifiedvalue
. If the value does not exist, a new name/value pair is added to the object.
- Specified by:
add
in interfaceJsonPointer
- Parameters:
target
- the target referenced by thisJsonPointer
value
- the value to be added- Returns:
- the transformed
target
after the value is added. - Throws:
NullPointerException
- iftarget
isnull
JsonException
- 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.
- If the reference is the target (empty JSON Pointer string),
the specified
-
replace
Replaces the value at the referenced location in the specifiedtarget
with the specifiedvalue
.- Specified by:
replace
in interfaceJsonPointer
- Parameters:
target
- the target referenced by thisJsonPointer
value
- the value to be stored at the referenced location- Returns:
- the transformed
target
after the value is replaced. - Throws:
NullPointerException
- iftarget
isnull
JsonException
- if the referenced value does not exist, or if the reference is the target.
-
remove
Removes the value at the reference location in the specifiedtarget
- Specified by:
remove
in interfaceJsonPointer
- Parameters:
target
- the target referenced by thisJsonPointer
- Returns:
- the transformed
target
after the value is removed. - Throws:
NullPointerException
- iftarget
isnull
JsonException
- if the referenced value does not exist, or if the reference is the target.
-
execute
private JsonStructure execute(BiFunction<NodeReference, JsonValue, JsonStructure> op, JsonStructure target, JsonValue value) Executes the operation- Parameters:
op
- a {code BiFunction} used to specify the operation to execute on the leaf node of the Json Pointertarget
- the target JsonStructure for this JsonPointervalue
- the JsonValue for add and replace, can be null for getvalue and remove
-
getReferences
Computes theNodeReference
s for each node on the path of the JSON Pointer, in reverse order, starting from the leaf node -
getIndex
Computes the array index- Parameters:
token
- the input string token- Returns:
- the array index. -1 if the token is "-"
- Throws:
JsonException
- if the string token is not in correct format
-