Interface DataError

All Known Implementing Classes:

DataError.Custom, DataError.DuplicateKey, DataError.IndexOutOfBounds, DataError.InvalidFormat, DataError.MissingField, DataError.NullValue, DataError.OutOfBounds, DataError.PathAware, DataError.TypeMismatch, DataError.UnknownEnum, DataError.UnsupportedOperation

public interface DataError

Defines a structured error encountered during serialization or deserialization processes.

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final record	DataError.Custom	Represents a generic or untyped error state.
static final record	DataError.DuplicateKey	Represents a structural collision where a key is parsed twice.
static final record	DataError.IndexOutOfBounds	Represents an invalid index queried against an array or list.
static final record	DataError.InvalidFormat	Represents a string formatting constraint violation.
static final record	DataError.MissingField	Represents an error where a mandatory structural field is absent.
static final record	DataError.NullValue	Represents an unexpected null value encountered where a strict type was required.
static final record	DataError.OutOfBounds	Represents a numerical state violating explicit threshold boundaries.
static final record	DataError.PathAware	Wraps an existing DataError to append contextual path resolution tracking.
static final record	DataError.TypeMismatch	Represents an error where a parsed type conflicts with the expected schema format.
static final record	DataError.UnknownEnum	Represents a string matching failure mapped to an Enum definition.
static final record	DataError.UnsupportedOperation	Represents an invocation against an unmapped or unavailable operational state.

Method Summary

Modifier and Type	Method	Description
static DataError	custom(String msg)	Instantiates a generic error.
static DataError	duplicateKey(String key)	Instantiates a collision duplicate error.
static DataError	indexOutOfBounds(int index, int size)	Instantiates a boundary mapping error.
static DataError	invalidFormat(String value, String pattern)	Instantiates a formatting constraint error.
String	message()
static DataError	missingField(String field)	Instantiates a missing field constraint error.
static DataError	nullValue(String expected)	Instantiates a null state error.
static DataError	outOfBounds(Number value, Number min, Number max)	Instantiates a mathematical threshold error.
static DataError	typeMismatch(String expected, String actual)	Instantiates a type mismatch error.
static DataError	unknownEnum(String value, String enumClass)	Instantiates an enum constant error.
static DataError	unsupportedOperation(String operation)	Instantiates a restricted operation error.

Method Details

message

String message()

Returns:

The formatted message describing the context of the failure.

custom

static DataError custom(String msg)

Instantiates a generic error.

Parameters:

msg - The target message.

Returns:

A constructed DataError.

typeMismatch

static DataError typeMismatch(String expected,
 String actual)

Instantiates a type mismatch error.

Parameters:

expected - Target type sequence.

actual - Encountered type sequence.

Returns:

A constructed DataError.

missingField

static DataError missingField(String field)

Instantiates a missing field constraint error.

Parameters:

field - Target nested key.

Returns:

A constructed DataError.

outOfBounds

static DataError outOfBounds(Number value,
 Number min,
 Number max)

Instantiates a mathematical threshold error.

Parameters:

value - Target node.

min - Acceptable low.

max - Acceptable high.

Returns:

A constructed DataError.

unknownEnum

static DataError unknownEnum(String value,
 String enumClass)

Instantiates an enum constant error.

Parameters:

value - Evaluated input.

enumClass - Target Enum descriptor.

Returns:

A constructed DataError.

nullValue

static DataError nullValue(String expected)

Instantiates a null state error.

Parameters:

expected - Expected structural wrapper.

Returns:

A constructed DataError.

invalidFormat

static DataError invalidFormat(String value,
 String pattern)

Instantiates a formatting constraint error.

Parameters:

value - Evaluated string.

pattern - Required sequence.

Returns:

A constructed DataError.

indexOutOfBounds

static DataError indexOutOfBounds(int index,
 int size)

Instantiates a boundary mapping error.

Parameters:

index - Targeted query index.

size - Structural upper bound.

Returns:

A constructed DataError.

duplicateKey

static DataError duplicateKey(String key)

Instantiates a collision duplicate error.

Parameters:

key - Evaluated key.

Returns:

A constructed DataError.

unsupportedOperation

static DataError unsupportedOperation(String operation)

Instantiates a restricted operation error.

Parameters:

operation - Evaluated action.

Returns:

A constructed DataError.