kpointer-core/com.commonsware.kpointer/KPointer

KPointer

value class KPointer(source)

Represents a JSON Pointer as defined in RFC 6901.

A JSON Pointer is a string that identifies a specific value within a JSON document using an array of reference tokens. Segments are separated by '/' and may contain '~' (for escaping) characters.

Relative JSON Pointers (draft-bhutton-relative-json-pointer-00) are supported via the plus operator, which accepts a relative pointer string and returns a RelativePointerResult. The minus operator computes the relative pointer string that navigates from this pointer to another.

Types

object Companion

Companion object for creating KPointer instances and providing constants.

Properties

Returns the number of path segments in this pointer.

val isRoot: Boolean

Checks if this pointer is the root pointer.

val parent: KPointer

Returns the parent pointer of this pointer.

Functions

operator fun get(index: Int): String

Returns the path segment at the specified index.

fun ~~getSegment~~(index: Int): String

Returns the path segment at the specified index.

operator fun minus(other: KPointer): String

Returns the Relative JSON Pointer string that navigates from this pointer to other.

operator fun plus(other: KPointer): KPointer

Concatenates this pointer with another pointer, creating a new pointer with combined segments.

operator fun plus(other: String): RelativePointerResult

Applies a Relative JSON Pointer (draft-bhutton-relative-json-pointer-00) to this pointer.

fun pop(): Pair<String, KPointer>

Pops the first segment from this pointer, returning both the segment and a new pointer without that segment.

fun toDotNotation(): String

Returns the dot-notation string representation of this pointer.

fun toFragment(): String

Returns the URI fragment identifier representation of this pointer, as defined in RFC 6901 §6.

open override fun toString(): String

Returns the string representation of this pointer.