Package dev.siroshun.codec4j.api.codec

Class EnumCodec

java.lang.Object

dev.siroshun.codec4j.api.codec.EnumCodec

public final class EnumCodec
extends Object

A Codec for Enums.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final record	EnumCodec.UnknownEnumNameDecodeError	A DecodeError.Failure for Codecs created by byName(Class).
static final record	EnumCodec.UnknownEnumOrdinalDecodeError	A DecodeError.Failure for Codecs created by byOrdinal(Class).

Method Summary

Modifier and Type	Method	Description
static <E extends Enum<E>> Codec<E>	byName(Class<E> enumClass)	Creates a new Codec of the specified Enum class using Enum.name() for encoding/decoding.
static <E extends Enum<E>> Codec<E>	byOrdinal(Class<E> enumClass)	Creates a new Codec of the specified Enum class using Enum.ordinal() for encoding/decoding.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Details

byName

public static <E extends Enum<E>> Codec<E> byName(Class<E> enumClass)

Creates a new Codec of the specified Enum class using Enum.name() for encoding/decoding.

Type Parameters:

E - a type of the Enum

Parameters:

enumClass - the class of EnumCodec

Returns:

a new Codec of the specified Enum class

byOrdinal

public static <E extends Enum<E>> Codec<E> byOrdinal(Class<E> enumClass)

Creates a new Codec of the specified Enum class using Enum.ordinal() for encoding/decoding.

Type Parameters:

E - a type of the Enum

Parameters:

enumClass - the class of EnumCodec

Returns:

a new Codec of the specified Enum class