All Implemented Interfaces:


public final class JSONPointer

JSON Pointer.

Author:: Peter Wall

Nested Class Summary

Nested Classes
Modifier and Type	Class	Description
`public class`	`JSONPointer.Companion`

Field Summary

Fields
Modifier and Type	Field	Description
`private final Integer`	`depth`
`private final String`	`current`
`private final Boolean`	`isRoot`
`public final static JSONPointer.Companion`	`Companion`

Constructor Summary

Constructors
Constructor	Description
`JSONPointer(String pointer)`	Construct a `JSONPointer` from the supplied `String`, which must consist of zero or more tokens representing either an object property name or an array index, with each token preceded by a slash (`/`).

Enum Constant Summary

Enum Constants
Enum Constant	Description

Method Summary

Modifier and Type	Method	Description
`final Integer`	`getDepth()`
`final String`	`getCurrent()`
`final Boolean`	`isRoot()`
`final Array<String>`	`tokensAsArray()`	Get the tokens that make up this pointer as an Array.
`final List<String>`	`tokensAsList()`	Get the tokens that make up this pointer as a List.
`final JSONPointer`	`parent()`	Return a new `JSONPointer` referencing the parent object or array of the value referenced by this pointer.
`final JSONPointer`	`child(String string)`	Return a new `JSONPointer` referencing the nominated child property of the object referenced by this pointer.
`final JSONPointer`	`child(Integer index)`	Return a new `JSONPointer` referencing the nominated child item of the array referenced by this pointer.
`final JSONPointer`	`child(JSONPointer childPointer)`	Return a new `JSONPointer` concatenating this pointer with a child pointer.
`final JSONPointer`	`withParent(String string)`	Return a new `JSONPointer` concatenating a parent element name with this pointer.
`final JSONPointer`	`withParent(Integer index)`	Return a new `JSONPointer` concatenating a parent array index with this pointer.
`final JSONPointer`	`withParent(JSONPointer parent)`	Return a new `JSONPointer` concatenating a parent pointer with this pointer.
`final JSONPointer`	`plus(String string)`	Return a new `JSONPointer` concatenating this pointer with a child element name.
`final JSONPointer`	`plus(Integer index)`	Return a new `JSONPointer` concatenating this pointer with a child array index.
`final JSONPointer`	`plus(JSONPointer childPointer)`	Return a new `JSONPointer` concatenating this pointer with a child pointer.
`final JSONPointer`	`truncate(Integer n)`	Truncate the pointer to the first n tokens.
`final String`	`toURIFragment()`	Convert the `JSONPointer` to a form suitable for use in a URI fragment.
`final String`	`getToken(Integer index)`	Get the token at the specified index.
`final Void`	`throwPointerException(String text)`	Throw a JSONPointerException with this pointer as the key.
`final String`	`toString(Integer numTokens)`	Create the string form of this pointer using the first n tokens.
`String`	`toString()`
`Boolean`	`equals(Object other)`
`Integer`	`hashCode()`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - JSONPointer
```
JSONPointer(String pointer)
```
    Construct a JSONPointer from the supplied String, which must consist of zero or more tokens representing either an object property name or an array index, with each token preceded by a slash (/).
- Method Detail
  - getDepth
```
 final Integer getDepth()
```
  - getCurrent
```
 final String getCurrent()
```
  - isRoot
```
 final Boolean isRoot()
```
  - tokensAsArray
```
 final Array<String> tokensAsArray()
```
    Get the tokens that make up this pointer as an Array.
  - tokensAsList
```
 final List<String> tokensAsList()
```
    Get the tokens that make up this pointer as a List.
  - parent
```
 final JSONPointer parent()
```
    Return a new JSONPointer referencing the parent object or array of the value referenced by this pointer.
  - child
```
 final JSONPointer child(String string)
```
    Return a new JSONPointer referencing the nominated child property of the object referenced by this pointer.
  - child
```
 final JSONPointer child(Integer index)
```
    Return a new JSONPointer referencing the nominated child item of the array referenced by this pointer.
  - child
```
 final JSONPointer child(JSONPointer childPointer)
```
    Return a new JSONPointer concatenating this pointer with a child pointer.
  - withParent
```
 final JSONPointer withParent(String string)
```
    Return a new JSONPointer concatenating a parent element name with this pointer.
  - withParent
```
 final JSONPointer withParent(Integer index)
```
    Return a new JSONPointer concatenating a parent array index with this pointer.
  - withParent
```
 final JSONPointer withParent(JSONPointer parent)
```
    Return a new JSONPointer concatenating a parent pointer with this pointer.
  - plus
```
 final JSONPointer plus(String string)
```
    Return a new JSONPointer concatenating this pointer with a child element name.
  - plus
```
 final JSONPointer plus(Integer index)
```
    Return a new JSONPointer concatenating this pointer with a child array index.
  - plus
```
 final JSONPointer plus(JSONPointer childPointer)
```
    Return a new JSONPointer concatenating this pointer with a child pointer.
  - truncate
```
 final JSONPointer truncate(Integer n)
```
    Truncate the pointer to the first n tokens.
  - toURIFragment
```
 final String toURIFragment()
```
    Convert the JSONPointer to a form suitable for use in a URI fragment. This means applying not only the JSON Pointer escaping rules, but also encoding into UTF-8 and then applying URI percent encoding.
  - getToken
```
 final String getToken(Integer index)
```
    Get the token at the specified index.
  - throwPointerException
```
 final Void throwPointerException(String text)
```
    Throw a JSONPointerException with this pointer as the key.
  - toString
```
 final String toString(Integer numTokens)
```
    Create the string form of this pointer using the first n tokens.
  - toString
```
 String toString()
```
  - equals
```
 Boolean equals(Object other)
```
  - hashCode
```
 Integer hashCode()
```

Class JSONPointer

Nested Class Summary

Field Summary

Constructor Summary

Enum Constant Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

JSONPointer

Method Detail

getDepth

getCurrent

isRoot

tokensAsArray

tokensAsList

parent

child

child

child

withParent

withParent

withParent

plus

plus

plus

truncate

toURIFragment

getToken

throwPointerException

toString

toString

equals

hashCode