vertx-lang-scala-docs_2.12 3.9.1 API < Back
 

# Packages

-  package root
  Definition Classes
    root
-  package io
  Definition Classes
    root
-  package vertx
  Definition Classes
    io
-  package scala
  Definition Classes
    vertx
-  package core
  Definition Classes
    scala
-  package json
  Definition Classes
    core
-  package pointer
  Definition Classes
    json
- JsonPointer
- JsonPointerIterator

c

io.vertx.scala.core.json.pointer

# JsonPointer 

###
Companion object JsonPointer

#### class JsonPointer extends AnyRef

Implementation of RFC6901 Json Pointers.

Linear Supertypes
AnyRef, Any
 
Ordering

1. Alphabetic
2. By Inheritance

Inherited

1. JsonPointer
2. AnyRef
3. Any

1. Hide All
2. Show All

Visibility

1. Public
2. All

### Instance Constructors

1.  new JsonPointer(_asJava: AnyRef)

### Value Members

1.  final def !=(arg0: Any): Boolean
   Definition Classes
     AnyRef → Any
2.  final def ##(): Int
   Definition Classes
     AnyRef → Any
3.  final def ==(arg0: Any): Boolean
   Definition Classes
     AnyRef → Any
4.  def append(pointer: JsonPointer): JsonPointer

   Append all tokens of `pointer` to this pointer
   Note: The base URI of this pointer will remain untouched * @param pointer other pointer

   Append all tokens of `pointer` to this pointer
   Note: The base URI of this pointer will remain untouched * @param pointer other pointer

   returns

     a reference to this, so the API can be used fluently

5.  def append(tokens: Buffer[String]): JsonPointer

   Append an unescaped list of `tokens` to JsonPointer
   Note: If you provide escaped paths the behaviour is undefined * @param tokens unescaped reference tokens

   Append an unescaped list of `tokens` to JsonPointer
   Note: If you provide escaped paths the behaviour is undefined * @param tokens unescaped reference tokens

   returns

     a reference to this, so the API can be used fluently

6.  def append(index: Int): JsonPointer

   Append the `index` as reference token to JsonPointer * @return a reference to this, so the API can be used fluently

7.  def append(token: String): JsonPointer

   Append an unescaped `token` to this pointer
   Note: If you provide escaped path the behaviour is undefined * @param token the unescaped reference token

   Append an unescaped `token` to this pointer
   Note: If you provide escaped path the behaviour is undefined * @param token the unescaped reference token

   returns

     a reference to this, so the API can be used fluently

8.  final def asInstanceOf[T0]: T0
   Definition Classes
     Any
9.  def asJava: AnyRef
10.  def clone(): AnyRef
    Attributes
      protected[java.lang]
    Definition Classes
      AnyRef
    Annotations
      @native() @throws( ... )
11.  def copy(): JsonPointer

    Copy a JsonPointer * @return a copy of this pointer

12.  final def eq(arg0: AnyRef): Boolean
    Definition Classes
      AnyRef
13.  def equals(arg0: Any): Boolean
    Definition Classes
      AnyRef → Any
14.  def finalize(): Unit
    Attributes
      protected[java.lang]
    Definition Classes
      AnyRef
    Annotations
      @throws( classOf[java.lang.Throwable] )
15.  final def getClass(): Class[_]
    Definition Classes
      AnyRef → Any
    Annotations
      @native()
16.  def hashCode(): Int
    Definition Classes
      AnyRef → Any
    Annotations
      @native()
17.  final def isInstanceOf[T0]: Boolean
    Definition Classes
      Any
18.  def isLocalPointer(): Boolean

    Return `true` if the pointer is local (URI with only fragment)

19.  def isParent(child: JsonPointer): Boolean

    Return `true` if this pointer is a parent pointer of `child`.

    Return `true` if this pointer is a parent pointer of `child`.
    For instance `"/properties"` pointer is parent pointer of `"/properties/parent"`

20.  def isRootPointer(): Boolean

    Return `true` if the pointer is a root pointer

21.  final def ne(arg0: AnyRef): Boolean
    Definition Classes
      AnyRef
22.  final def notify(): Unit
    Definition Classes
      AnyRef
    Annotations
      @native()
23.  final def notifyAll(): Unit
    Definition Classes
      AnyRef
    Annotations
      @native()
24.  def parent(): JsonPointer

    Remove last reference token of this pointer * @return a reference to this, so the API can be used fluently

25.  def query(objectToQuery: AnyRef, iterator: JsonPointerIterator): Option[AnyRef]

    Query `objectToQuery` using the provided io.vertx.scala.core.json.pointer.JsonPointerIterator.

    Query `objectToQuery` using the provided io.vertx.scala.core.json.pointer.JsonPointerIterator.
    If you need to query Vert.x json data structures, use io.vertx.scala.core.json.pointer.JsonPointer#queryJson
    Note: if this pointer is a root pointer, this function returns the provided object * @param objectToQuery the object to query

    iterator

      the json pointer iterator that provides the logic to access to the objectToQuery

    returns

      null if pointer points to not existing value, otherwise the requested value

26.  def queryJson(jsonElement: AnyRef): Option[AnyRef]

    Query `jsonElement`.

    Query `jsonElement`.
    Note: if this pointer is a root pointer, this function returns the provided json element * @param jsonElement the json element to query

    returns

      null if pointer points to not existing value, otherwise the requested value

27.  def queryJsonOrDefault(jsonElement: AnyRef, defaultValue: AnyRef): Option[AnyRef]

    Query `jsonElement`.

    Query `jsonElement`. If the query result is null, returns the default.
    Note: if this pointer is a root pointer, this function returns the provided object * @param jsonElement the json element to query

    defaultValue

      default value if query result is null

    returns

      null if pointer points to not existing value, otherwise the requested value

28.  def queryOrDefault(objectToQuery: AnyRef, iterator: JsonPointerIterator, defaultValue: AnyRef): AnyRef

    Query `objectToQuery` using the provided io.vertx.scala.core.json.pointer.JsonPointerIterator.

    Query `objectToQuery` using the provided io.vertx.scala.core.json.pointer.JsonPointerIterator. If the query result is null, returns the default.
    If you need to query Vert.x json data structures, use io.vertx.scala.core.json.pointer.JsonPointer#queryJsonOrDefault
    Note: if this pointer is a root pointer, this function returns the provided object * @param objectToQuery the object to query

    iterator

      the json pointer iterator that provides the logic to access to the objectToQuery

    defaultValue

      default value if query result is null

    returns

      null if pointer points to not existing value, otherwise the requested value

29.  final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
      AnyRef
30.  def toString(): String

    Build a string representation of the JSON Pointer

    Build a string representation of the JSON Pointer

    Definition Classes
      JsonPointer → AnyRef → Any
31.  def tracedQuery(objectToQuery: AnyRef, iterator: JsonPointerIterator): Buffer[AnyRef]

    Query `objectToQuery` tracing each element walked during the query, including the first and the result (if any).
    The first element of the list is objectToQuery and the last is the result, or the element before the first null was encountered * @param objectToQuery the object to query

    Query `objectToQuery` tracing each element walked during the query, including the first and the result (if any).
    The first element of the list is objectToQuery and the last is the result, or the element before the first null was encountered * @param objectToQuery the object to query

    iterator

      the json pointer iterator that provides the logic to access to the objectToQuery

    returns

      the stream of walked elements

32.  final def wait(): Unit
    Definition Classes
      AnyRef
    Annotations
      @throws( ... )
33.  final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
      AnyRef
    Annotations
      @throws( ... )
34.  final def wait(arg0: Long): Unit
    Definition Classes
      AnyRef
    Annotations
      @native() @throws( ... )
35.  def write(objectToWrite: AnyRef, iterator: JsonPointerIterator, newElement: AnyRef, createOnMissing: Boolean): AnyRef

    Write `newElement` in `objectToWrite` using this pointer.

    Write `newElement` in `objectToWrite` using this pointer. The path token "-" is handled as append to end of array
    If you need to write in Vert.x json data structures, use io.vertx.scala.core.json.pointer.JsonPointer#writeJson (Object)`
    * @param objectToWrite object to write`

    iterator

      the json pointer iterator that provides the logic to access to the objectToMutate

    newElement

      object to insert

    createOnMissing

      create objects when missing a object key or an array index

    returns

      a reference to objectToWrite if the write was completed, a reference to newElement if the pointer is a root pointer, null if the write failed

36.  def writeJson(jsonElement: AnyRef, newElement: AnyRef, createOnMissing: Boolean): AnyRef

    Write `newElement` in `jsonElement` using this pointer.

    Write `newElement` in `jsonElement` using this pointer. The path token "-" is handled as append to end of array. * @param jsonElement json to query and write

    newElement

      json to insert

    createOnMissing

      create JsonObject when missing a object key or an array index

    returns

      a reference to json if the write was completed, a reference to newElement if the pointer is a root pointer, null if the write failed

37.  def writeJson(jsonElement: AnyRef, newElement: AnyRef): AnyRef

    Write `newElement` in `jsonElement` using this pointer.

    Write `newElement` in `jsonElement` using this pointer. The path token "-" is handled as append to end of array. * @param jsonElement json element to query and write

    newElement

      json to insert

    returns

      a reference to json if the write was completed, a reference to newElement if the pointer is a root pointer, null if the write failed

### Inherited from AnyRef

### Inherited from Any

### Ungrouped