Package dev.siroshun.codec4j.api.error

Interface EncodeError

All Known Subinterfaces:

EncodeError.Failure, EncodeError.FatalError, EncodeError.NotWritableType

@NotNullByDefault
public sealed interface EncodeError
permits EncodeError.Failure, EncodeError.FatalError, EncodeError.NotWritableType

An interface to indicate errors when encoding.

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static interface	EncodeError.Failure	An interface that indicates a EncodeError for custom error type.
static interface	EncodeError.FatalError	An interface that indicates a EncodeError when a fatal error occurred while encoding.
static interface	EncodeError.NotWritableType	An interface that indicates a EncodeError when the type is not writable.

Method Summary

Modifier and Type	Method	Description
default <T> dev.siroshun.jfun.result.Result.Failure<T,EncodeError>	asFailure()	Converts this EncodeError to Result.Failure.
static EncodeError.FatalError	fatalError(Throwable cause)	Creates a EncodeError when a fatal error occurred while encoding.
static EncodeError.NotWritableType	notWritableType(Type type)	Creates a EncodeError when the type is not writable.

Method Details

notWritableType

static EncodeError.NotWritableType notWritableType(Type type)

Creates a EncodeError when the type is not writable.

Parameters:

type - the Type that is not writable

Returns:

a new EncodeError

fatalError

static EncodeError.FatalError fatalError(Throwable cause)

Creates a EncodeError when a fatal error occurred while encoding.

Parameters:

cause - the Throwable that caused the error

Returns:

a new EncodeError

asFailure

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

Converts this EncodeError to Result.Failure.

Type Parameters:

T - any type

Returns:

the Result.Failure