Record Class DataError.IndexOutOfBounds

java.lang.Object

java.lang.Record

com.github.darksoulq.abyssallib.common.serialization.DataError.IndexOutOfBounds

Record Components:

index - The queried index.

size - The structural collection bounds.

All Implemented Interfaces:

DataError

Enclosing interface:

DataError

public static record DataError.IndexOutOfBounds(int index, int size)
extends Record
implements DataError

Represents an invalid index queried against an array or list.

Nested Class Summary

Nested classes/interfaces inherited from interface DataError

DataError.Custom, DataError.DuplicateKey, DataError.IndexOutOfBounds, DataError.InvalidFormat, DataError.MissingField, DataError.NullValue, DataError.OutOfBounds, DataError.PathAware, DataError.TypeMismatch, DataError.UnknownEnum, DataError.UnsupportedOperation

Constructor Summary

Constructors

Constructor	Description
IndexOutOfBounds(int index, int size)	Creates an instance of a IndexOutOfBounds record class.

Method Summary

Modifier and Type	Method	Description
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.
int	index()	Returns the value of the index record component.
String	message()
int	size()	Returns the value of the size record component.
final String	toString()	Returns a string representation of this record class.

Methods inherited from class Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Details

IndexOutOfBounds

public IndexOutOfBounds(int index,
 int size)

Creates an instance of a IndexOutOfBounds record class.

Parameters:

index - the value for the index record component

size - the value for the size record component

Method Details

message

public String message()

Specified by:

message in interface DataError

Returns:

The formatted message describing the context of the failure.

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 the compare method from their corresponding wrapper classes.

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.

index

public int index()

Returns the value of the index record component.

Returns:

the value of the index record component

size

public int size()

Returns the value of the size record component.

Returns:

the value of the size record component