Record Class DataError.OutOfBounds

java.lang.Object

java.lang.Record

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

Record Components:

value - The encountered invalid value.

min - The expected inclusive minimum.

max - The expected inclusive maximum.

All Implemented Interfaces:

DataError

Enclosing interface:

DataError

public static record DataError.OutOfBounds(Number value, Number min, Number max)
extends Record
implements DataError

Represents a numerical state violating explicit threshold boundaries.

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
OutOfBounds(Number value, Number min, Number max)	Creates an instance of a OutOfBounds 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.
Number	max()	Returns the value of the max record component.
String	message()
Number	min()	Returns the value of the min record component.
final String	toString()	Returns a string representation of this record class.
Number	value()	Returns the value of the value record component.

Methods inherited from class Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Details

OutOfBounds

public OutOfBounds(Number value,
 Number min,
 Number max)

Creates an instance of a OutOfBounds record class.

Parameters:

value - the value for the value record component

min - the value for the min record component

max - the value for the max 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 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.

value

public Number value()

Returns the value of the value record component.

Returns:

the value of the value record component

min

public Number min()

Returns the value of the min record component.

Returns:

the value of the min record component

max

public Number max()

Returns the value of the max record component.

Returns:

the value of the max record component