Record Class IntProvider.Clamped

java.lang.Object

java.lang.Record

fr.fidorial.world.dimension.IntProvider.Clamped

Record Components:

minInclusive - the minimum allowed value that the result will be

maxInclusive - the maximum allowed value that the result will be

source - the provider being clamped

All Implemented Interfaces:

IntProvider

Enclosing interface:

IntProvider

public static record IntProvider.Clamped(int minInclusive, int maxInclusive, IntProvider source)
extends Record
implements IntProvider

Since:

0.1.0

Nested Class Summary

Nested classes/interfaces inherited from interface IntProvider

IntProvider.BiasedToBottom, IntProvider.Clamped, IntProvider.ClampedNormal, IntProvider.Constant, IntProvider.Uniform, IntProvider.WeightedList

Constructor Summary

Constructors

Constructor	Description
Clamped(int minInclusive, int maxInclusive, IntProvider source)	Creates an instance of a Clamped 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	maxInclusive()	Returns the value of the maxInclusive record component.
int	minInclusive()	Returns the value of the minInclusive record component.
IntProvider	source()	Returns the value of the source record component.
final String	toString()	Returns a string representation of this record class.

Methods inherited from class Object

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

Constructor Details

Clamped

public Clamped(int minInclusive,
 int maxInclusive,
 IntProvider source)

Creates an instance of a Clamped record class.

Parameters:

minInclusive - the value for the minInclusive record component

maxInclusive - the value for the maxInclusive record component

source - the value for the source 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. Reference components are compared with Objects::equals(Object,Object); primitive components 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.

minInclusive

public int minInclusive()

Returns the value of the minInclusive record component.

Returns:

the value of the minInclusive record component

maxInclusive

public int maxInclusive()

Returns the value of the maxInclusive record component.

Returns:

the value of the maxInclusive record component

source

public IntProvider source()

Returns the value of the source record component.

Returns:

the value of the source record component