Options
All
  • Public
  • Public/Protected
  • All
Menu

Class JsonPointerIterator

The JsonPointerIterator is used by the read/write algorithms of the JsonPointer to read/write the querying data structure

Every method takes the currentValue as parameter, representing the actual value held by the query algorithm.

Implementations of this interface should be stateless, so they can be reused

You can implement this interface to query the structure you want using json pointers

Hierarchy

  • JsonPointerIterator

Index

Properties

Static Readonly JSON_ITERATOR

JSON_ITERATOR: JsonPointerIterator

Instance of a JsonPointerIterator to query Vert.x Json structures

Methods

appendArrayElement

  • appendArrayElement(currentValue: any | null | undefined, value: any | null | undefined): boolean
  • Append array element

    Parameters

    • currentValue: any | null | undefined
    • value: any | null | undefined

    Returns boolean

getArrayElement

  • getArrayElement(currentValue: any | null | undefined, i: number): any
  • Move the iterator the array element at specified index

    Parameters

    • currentValue: any | null | undefined
    • i: number

    Returns any

getObjectParameter

  • getObjectParameter(currentValue: any | null | undefined, key: string, createOnMissing: boolean): any
  • Returns the object parameter with specified key.

    Parameters

    • currentValue: any | null | undefined
    • key: string
    • createOnMissing: boolean

    Returns any

isArray

  • isArray(currentValue: any | null | undefined): boolean
  • Parameters

    • currentValue: any | null | undefined

    Returns boolean

isNull

  • isNull(currentValue: any | null | undefined): boolean
  • Parameters

    • currentValue: any | null | undefined

    Returns boolean

isObject

  • isObject(currentValue: any | null | undefined): boolean
  • Parameters

    • currentValue: any | null | undefined

    Returns boolean

objectContainsKey

  • objectContainsKey(currentValue: any | null | undefined, key: string): boolean
  • Parameters

    • currentValue: any | null | undefined
    • key: string

    Returns boolean

writeArrayElement

  • writeArrayElement(currentValue: any | null | undefined, i: number, value: any | null | undefined): boolean
  • Write array element at specified index

    Parameters

    • currentValue: any | null | undefined
    • i: number
    • value: any | null | undefined

    Returns boolean

writeObjectParameter

  • writeObjectParameter(currentValue: any | null | undefined, key: string, value: any | null | undefined): boolean
  • Write object parameter at specified key

    Parameters

    • currentValue: any | null | undefined
    • key: string
    • value: any | null | undefined

    Returns boolean

Generated using TypeDoc