Package dev.siroshun.codec4j.api.error

Interface DecodeError

All Known Subinterfaces:

DecodeError.Failure, DecodeError.FatalError, DecodeError.IgnorableError, DecodeError.InvalidChar, DecodeError.InvalidNumber, DecodeError.InvalidNumberFormat, DecodeError.IterationError, DecodeError.TypeMismatch

All Known Implementing Classes:

AlreadyDecodedError, Base64Codec.InvalidBase64Error, DuplicatedElementError, EnumCodec.UnknownEnumNameDecodeError, EnumCodec.UnknownEnumOrdinalDecodeError, MapCodec.DuplicatedKeyError, RequiredFieldError, UUIDCodec.InvalidUUIDFormatError

@NotNullByDefault
public sealed interface DecodeError
permits DecodeError.Failure, DecodeError.FatalError, DecodeError.IgnorableError, DecodeError.InvalidChar, DecodeError.InvalidNumber, DecodeError.InvalidNumberFormat, DecodeError.IterationError, DecodeError.TypeMismatch

An interface to indicate errors when decoding.

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static interface	DecodeError.Failure	An interface that indicates a DecodeError for custom error type.
static interface	DecodeError.FatalError	An interface that indicates a DecodeError when fatal error occurred while decoding.
static interface	DecodeError.IgnorableError	An interface that marks a DecodeError as ignorable.
static interface	DecodeError.InvalidChar	An interface that indicates a DecodeError when the data is invalid Character.
static interface	DecodeError.InvalidNumber	An interface that indicates a DecodeError when the data is invalid number.
static interface	DecodeError.InvalidNumberFormat	An interface that indicates a DecodeError when the data is an invalid number format.
static interface	DecodeError.IterationError	An interface that indicates a DecodeError when Result.Failure is returned when iterating elements.
static interface	DecodeError.TypeMismatch	An interface that indicates a DecodeError when the type is different from the expected type.

Method Summary

Modifier and Type	Method	Description
default <T> dev.siroshun.jfun.result.Result.Failure<T,DecodeError>	asFailure()	Converts this DecodeError to Result.Failure.
default DecodeError.IgnorableError	asIgnorable()	Makes this DecodeError ignorable.
static DecodeError.FatalError	fatalError(Throwable cause)	Creates a DecodeError when fatal error occurred while decoding.
static DecodeError.InvalidChar	invalidChar(String actualValue)	Creates a DecodeError when the data is invalid Character.
static DecodeError.InvalidNumber	invalidNumber(Type.NumberValue<?> expectedType, Number actualValue)	Creates a DecodeError when the data is invalid number.
static DecodeError.InvalidNumberFormat	invalidNumberFormat(NumberFormatException e)	Creates a DecodeError when the data is an invalid number format.
default boolean	isIgnorable()	Returns whether this DecodeError can be ignored.
static DecodeError.IterationError	iterationError(dev.siroshun.jfun.result.Result.Failure<?,?> cause)	Creates a DecodeError when Result.Failure is returned when iterating elements.
static DecodeError.TypeMismatch	typeMismatch(Type expected, Type actual)	Creates a DecodeError when the type is different from the expected type.

Method Details

typeMismatch

static DecodeError.TypeMismatch typeMismatch(Type expected,
 Type actual)

Creates a DecodeError when the type is different from the expected type.

Parameters:

expected - the expected Type

actual - the actual Type

Returns:

a new DecodeError

invalidChar

static DecodeError.InvalidChar invalidChar(String actualValue)

Creates a DecodeError when the data is invalid Character.

Parameters:

actualValue - the actual String

Returns:

a new DecodeError

invalidNumber

static DecodeError.InvalidNumber invalidNumber(Type.NumberValue<?> expectedType,
 Number actualValue)

Creates a DecodeError when the data is invalid number.

Parameters:

expectedType - the expected Type.NumberValue

actualValue - the actual Number value

Returns:

a new DecodeError

invalidNumberFormat

static DecodeError.InvalidNumberFormat invalidNumberFormat(NumberFormatException e)

Creates a DecodeError when the data is an invalid number format.

Parameters:

e - the caused NumberFormatException

Returns:

a new DecodeError

iterationError

static DecodeError.IterationError iterationError(dev.siroshun.jfun.result.Result.Failure<?,?> cause)

Creates a DecodeError when Result.Failure is returned when iterating elements.

Parameters:

cause - the Result.Failure

Returns:

a new DecodeError

fatalError

static DecodeError.FatalError fatalError(Throwable cause)

Creates a DecodeError when fatal error occurred while decoding.

Parameters:

cause - the Throwable that caused the error

Returns:

a new DecodeError

asFailure

default <T>
dev.siroshun.jfun.result.Result.Failure<T,DecodeError> asFailure()

Converts this DecodeError to Result.Failure.

Type Parameters:

T - any type

Returns:

the Result.Failure

asIgnorable

default DecodeError.IgnorableError asIgnorable()

Makes this DecodeError ignorable.

Returns:

DecodeError.IgnorableError with this DecodeError

isIgnorable

default boolean isIgnorable()

Returns whether this DecodeError can be ignored.

Returns:

true if this DecodeError can be ignored, otherwise false