kmp-jsonpointer/com.commonsware.json.pointer/JsonPointer

JsonPointer

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.

Types

Companion

object Companion

Companion object for creating JsonPointer instances and providing constants.

Properties

depth

val depth: Int

Returns the number of path segments in this pointer.

isRoot

val isRoot: Boolean

Checks if this pointer is the root pointer.

parent

val parent: JsonPointer

Returns the parent pointer of this pointer.

Functions

get

operator fun get(index: Int): String

Returns the path segment at the specified index.

getSegment

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

Returns the path segment at the specified index.

plus

operator fun plus(other: JsonPointer): JsonPointer

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

pop

fun pop(): Pair<String, JsonPointer>

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

toFragment

fun toFragment(): String

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

toString

open override fun toString(): String

Returns the string representation of this pointer.