kpointer-core/com.commonsware.kpointer

Package-level declarations

Types

DotEmptySegment

class DotEmptySegment(message: String) : KPointerException

A dot-notation pointer string produced an empty segment (a trailing dot, consecutive dots, or leading double dots).

FragmentMalformedPercentEncoding

class FragmentMalformedPercentEncoding(message: String) : KPointerException

A URI fragment pointer string contained a truncated or otherwise invalid %XX percent-encoding sequence.

FragmentMissingHash

class FragmentMissingHash(message: String) : KPointerException

A URI fragment pointer string did not start with #.

KPointer

@JvmInline

value class KPointer

Represents a JSON Pointer as defined in RFC 6901.

KPointerException

sealed class KPointerException : IllegalArgumentException

Base type for every failure kPointer raises while parsing a pointer string or applying a Relative JSON Pointer.

PointerMissingLeadingSlash

class PointerMissingLeadingSlash(message: String) : KPointerException

A strict RFC 6901 pointer string did not start with / (and was not the empty string).

RelativeAdjustNonInteger

class RelativeAdjustNonInteger(message: String) : KPointerException

A Relative JSON Pointer applied an index adjustment (+N/-N) to a segment that is not a non-negative integer.

RelativeAdjustOnRoot

class RelativeAdjustOnRoot(message: String) : KPointerException

A Relative JSON Pointer applied an index adjustment (+N/-N) when the traversed pointer was the root.

RelativeHashOnRoot

class RelativeHashOnRoot(message: String) : KPointerException

A Relative JSON Pointer used the # suffix when the resolved pointer was the root.

RelativeLevelsExceedDepth

class RelativeLevelsExceedDepth(message: String) : KPointerException

A Relative JSON Pointer requested more levels up than the base pointer's depth.

RelativeMalformedSyntax

class RelativeMalformedSyntax(message: String) : KPointerException

A Relative JSON Pointer string was syntactically malformed (empty, no leading non-negative integer, a leading-zero number, a malformed index adjustment, or unexpected trailing characters).

RelativeNegativeIndex

class RelativeNegativeIndex(message: String) : KPointerException

A Relative JSON Pointer index adjustment (+N/-N) produced a negative index.

RelativePointerResult

sealed interface RelativePointerResult

The result of applying a Relative JSON Pointer (see KPointer.plus).

Functions

canonicalErrorKind

fun KPointerException.canonicalErrorKind(): String

Maps this core parse/relative failure to its canonical, language-neutral errorKind string.