Record Class IntProvider.WeightedList

java.lang.Object

java.lang.Record

fr.fidorial.world.dimension.IntProvider.WeightedList

Record Components:

distribution - the pool of weighted entries to pick from, never empty

All Implemented Interfaces:

IntProvider

Enclosing interface:

IntProvider

public static record IntProvider.WeightedList(List<IntProvider.WeightedList.Entry> distribution)
extends Record
implements IntProvider

Since:

0.1.0

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final record	IntProvider.WeightedList.Entry	One entry of a IntProvider.WeightedList.

Nested classes/interfaces inherited from interface IntProvider

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

Constructor Summary

Constructors

Constructor	Description
WeightedList(List<IntProvider.WeightedList.Entry> distribution)	Creates an instance of a WeightedList record class.

Method Summary

Modifier and Type	Method	Description
List<IntProvider.WeightedList.Entry>	distribution()	Returns the value of the distribution 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.
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

WeightedList

public WeightedList(List<IntProvider.WeightedList.Entry> distribution)

Creates an instance of a WeightedList record class.

Parameters:

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

distribution

public List<IntProvider.WeightedList.Entry> distribution()

Returns the value of the distribution record component.

Returns:

the value of the distribution record component