Package dev.siroshun.codec4j.api.decoder.object

Record Class RequiredFieldError

java.lang.Object

java.lang.Record

dev.siroshun.codec4j.api.decoder.object.RequiredFieldError

Record Components:

fieldName - the name of the field that is not decoded

All Implemented Interfaces:

DecodeError, DecodeError.Failure

public record RequiredFieldError(@NotNull String fieldName)
extends Record
implements DecodeError.Failure

A DecodeError when a required field is not decoded.

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
RequiredFieldError(@NotNull String fieldName)	Constructs a new RequiredFieldError.

Method Summary

Modifier and Type	Method	Description
final boolean	equals(Object o)	Indicates whether some other object is "equal to" this one.
@NotNull String	fieldName()	Returns the value of the fieldName record component.
final int	hashCode()	Returns a hash code value for this object.
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

RequiredFieldError

public RequiredFieldError(@NotNull
 @NotNull String fieldName)

Constructs a new RequiredFieldError.

Parameters:

fieldName - the name of the field that is not decoded

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.

fieldName

@NotNull
public @NotNull String fieldName()

Returns the value of the fieldName record component.

Returns:

the value of the fieldName record component