Module qilletni.api

Package dev.qilletni.api.lang.types.collection

Record Class CollectionLimit

java.lang.Object

java.lang.Record

dev.qilletni.api.lang.types.collection.CollectionLimit

Record Components:

limitCount - The numerical part of the limit

limitUnit - The unit of the limit

public record CollectionLimit(int limitCount, CollectionLimitUnit limitUnit)
extends Record

A backing type for the limit type on a collection, e.g. limit[5] or limit[3h]. This defines how much of a collection should be played.

Constructor Summary

Constructors

Constructor	Description
CollectionLimit(int limitCount, CollectionLimitUnit limitUnit)	Creates an instance of a CollectionLimit 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	limitCount()	Returns the value of the limitCount record component.
CollectionLimitUnit	limitUnit()	Returns the value of the limitUnit record component.
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

Constructor Details

CollectionLimit

public CollectionLimit(int limitCount,
 CollectionLimitUnit limitUnit)

Creates an instance of a CollectionLimit record class.

Parameters:

limitCount - the value for the limitCount record component

limitUnit - the value for the limitUnit record component

Method Details

toString

public 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 '=='.

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.

limitCount

public int limitCount()

Returns the value of the limitCount record component.

Returns:

the value of the limitCount record component

limitUnit

public CollectionLimitUnit limitUnit()

Returns the value of the limitUnit record component.

Returns:

the value of the limitUnit record component