Package dev.siroshun.codec4j.api.codec

Record Class EnumCodec.UnknownEnumNameDecodeError

java.lang.Object

java.lang.Record

dev.siroshun.codec4j.api.codec.EnumCodec.UnknownEnumNameDecodeError

Record Components:

enumClass - the Enum class

name - the unknown enum name

All Implemented Interfaces:

DecodeError, DecodeError.Failure

Enclosing class:

EnumCodec

public static record EnumCodec.UnknownEnumNameDecodeError(Class<?> enumClass, String name)
extends Record
implements DecodeError.Failure

A DecodeError.Failure for Codecs created by EnumCodec.byName(Class).

Nested Class Summary

Nested classes/interfaces inherited from interface dev.siroshun.codec4j.api.error.DecodeError

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

Constructor Summary

Constructors

Constructor	Description
UnknownEnumNameDecodeError(Class<?> enumClass, String name)	Creates an instance of a UnknownEnumNameDecodeError record class.

Method Summary

Modifier and Type	Method	Description
Class<?>	enumClass()	Returns the value of the enumClass record component.
final boolean	equals(Object o)	Indicates whether some other object is "equal to" this one.
final int	hashCode()	Returns a hash code value for this object.
String	name()	Returns the value of the name record component.
final String	toString()	Returns a string representation of this record class.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface dev.siroshun.codec4j.api.error.DecodeError

asFailure, asIgnorable, isIgnorable

Constructor Details

UnknownEnumNameDecodeError

public UnknownEnumNameDecodeError(Class<?> enumClass,
 String name)

Creates an instance of a UnknownEnumNameDecodeError record class.

Parameters:

enumClass - the value for the enumClass record component

name - the value for the name record component

Method Details

toString

public final String toString()

Returns a string representation of this record class. The representation contains the name of the class, followed by the name and value of each of the record components.

Specified by:

toString in class Record

Returns:

a string representation of this object

hashCode

public final int hashCode()

Returns a hash code value for this object. The value is derived from the hash code of each of the record components.

Specified by:

hashCode in class Record

Returns:

a hash code value for this object

equals

public final boolean equals(Object o)

Indicates whether some other object is "equal to" this one. The objects are equal if the other object is of the same class and if all the record components are equal. All components in this record class are compared with Objects::equals(Object,Object).

Specified by:

equals in class Record

Parameters:

o - the object with which to compare

Returns:

true if this object is the same as the o argument; false otherwise.

enumClass

public Class<?> enumClass()

Returns the value of the enumClass record component.

Returns:

the value of the enumClass record component

name

public String name()

Returns the value of the name record component.

Returns:

the value of the name record component