Interface PointerError

All Known Implementing Classes:

PointerError.DuplicateName, PointerError.IndexOutOfRange, PointerError.InvalidEscape, PointerError.InvalidFragment, PointerError.InvalidIndex, PointerError.MemberNotFound, PointerError.MissingSlash, PointerError.NotAContainer

public sealed interface PointerError
permits PointerError.MissingSlash, PointerError.InvalidEscape, PointerError.InvalidFragment, PointerError.MemberNotFound, PointerError.DuplicateName, PointerError.InvalidIndex, PointerError.IndexOutOfRange, PointerError.NotAContainer

An error of a JSON Pointer (RFC 6901, Section 7): invalid syntax, or a pointer that does not reference a value.

Error	Cause
PointerError.MissingSlash	a pointer that is not empty does not start with /
PointerError.InvalidEscape	a ~ is not followed by 0 or 1
PointerError.InvalidFragment	a URI fragment identifier is not valid, or its bytes are not UTF-8
PointerError.MemberNotFound	an object has no member with the name
PointerError.DuplicateName	an object has more than one member with the name
PointerError.InvalidIndex	a token for an array is not an array index, for example 01, x, or -
PointerError.IndexOutOfRange	an array index is not less than the length of the array
PointerError.NotAContainer	a token follows a value that is not an object or an array

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final record	PointerError.DuplicateName	An object has more than one member with the name of a token.
static final record	PointerError.IndexOutOfRange	An array index is not less than the length of the array.
static final record	PointerError.InvalidEscape	A ~ is not followed by 0 or 1 (RFC 6901, Section 3).
static final record	PointerError.InvalidFragment	A URI fragment identifier is not a valid JSON Pointer (RFC 6901, Section 6): it does not start with #, it has a character that a fragment does not permit, a percent-encoding is not complete, or the bytes are not UTF-8.
static final record	PointerError.InvalidIndex	A token for an array is not an array index: digits without a leading zero (RFC 6901, Section 4).
static final record	PointerError.MemberNotFound	An object has no member with the name of a token.
static final record	PointerError.MissingSlash	A pointer that is not empty does not start with / (RFC 6901, Section 3).
static final record	PointerError.NotAContainer	A token follows a value that is not an object or an array.

Method Summary

Modifier and Type	Method	Description
default String	message()	Returns a description of the error for people.

Method Details

message

default String message()

Returns a description of the error for people.

Returns:

the description