public interface JsonPointer
このインターフェースは、RFC 6901 で定義されている JSON ポインターの不変の実装を表します。
JSON ポインターは、ターゲット JsonValue
に適用されると、ターゲット内の参照場所を定義します。
空の JSON ポインター文字列は、ターゲット自体への参照を定義します。
JSON ポインター文字列が空でない場合、'/' プレフィックストークンのシーケンスである必要があり、ターゲットは JsonArray
または JsonObject
のいずれかである必要があります。ターゲットが JsonArray
の場合、ポインターは配列要素への参照を定義し、最後のトークンはインデックスを指定します。ターゲットが JsonObject
の場合、ポインターは名前と値のペアへの参照を定義し、最後のトークンは名前を指定します。
メソッド getValue()
は、参照された値を返します。メソッド add()
、replace()
、remove()
は、RFC 6902 で指定された操作を実行します。
修飾子と型 | メソッドと説明 |
---|---|
<T extends JsonStructure> | add(T target, JsonValue value) 指定された target の参照された場所の値を指定された value で追加または置換します。 |
boolean | containsValue(JsonStructure target) 指定された target の参照された場所に値がある場合、true を返します。 |
JsonValue | getValue(JsonStructure target) 指定された target の参照された場所の値を返します。 |
<T extends JsonStructure> | remove(T target) 指定された target の参照位置の値を削除します。 |
<T extends JsonStructure> | replace(T target, JsonValue value) 指定された target 内の参照された場所の値を、指定された value で置き換えます。 |
StringSE | toString() この JSON ポインターの文字列表現を返します。 |
<T extends JsonStructure> T add(T target, JsonValue value)
target
の参照された場所の値を指定された value
で追加または置換します。target
と同じ型である必要がある、指定された value
が返されます。value
が参照されたインデックスで配列に挿入されます。現在その位置にある値と後続の値は、右にシフトされます(インデックスに 1 を加えます)。インデックスは 0 から始まります。参照が "-" で指定されている場合、またはインデックスが配列のサイズと等しい場合、値は配列に追加されます。JsonObject
の名前と値のペアであり、参照される値が存在する場合、値は指定された value
で置き換えられます。値が存在しない場合、新しい名前と値のペアがオブジェクトに追加されます。T
- ターゲット型。JsonValue
のサブ型である必要があります target
- この JsonPointer
によって参照されるターゲット value
- 追加する値 target
NullPointerExceptionSE
- target
が null
の場合 JsonException
- 参照が配列要素であり、インデックスが範囲外(index < 0 || index > array size
)である場合、またはポインターが存在しないオブジェクトまたは配列への参照を含む場合 <T extends JsonStructure> T remove(T target)
target
の参照位置の値を削除します。T
- ターゲット型。JsonValue
のサブ型である必要があります target
- この JsonPointer
によって参照されるターゲット target
NullPointerExceptionSE
- target
が null
の場合 JsonException
- 参照される値が存在しない場合、または参照がターゲットである場合。<T extends JsonStructure> T replace(T target, JsonValue value)
target
内の参照された場所の値を、指定された value
で置き換えます。T
- ターゲット型。JsonValue
のサブ型である必要があります target
- この JsonPointer
によって参照されるターゲット value
- 参照された場所に格納される値 target
NullPointerExceptionSE
- target
が null
の場合 JsonException
- 参照される値が存在しない場合、または参照がターゲットである場合。boolean containsValue(JsonStructure target)
target
の参照された場所に値がある場合、true
を返します。target
- この JsonPointer
によって参照されるターゲット true
(このポインターが指定された target
の値を指す場合)。JsonValue getValue(JsonStructure target)
target
の参照された場所の値を返します。target
- この JsonPointer
によって参照されるターゲット NullPointerExceptionSE
- target
が null の場合 JsonException
- 参照された値が存在しない場合 StringSE toString()
/
" プレフィックス付きトークンのシーケンスです。ObjectSE
の toStringSE
Copyright © 2018,2020 Eclipse Foundation.
Use is subject to license terms.