Package com.pixelmonmod.pixelmon.items

Record Class HeldItemInteractionResult

java.lang.Object

java.lang.Record

com.pixelmonmod.pixelmon.items.HeldItemInteractionResult

public record HeldItemInteractionResult(boolean success, boolean consume)
extends Record

Field Summary

Fields

Modifier and Type	Field	Description
static HeldItemInteractionResult	FAILURE_AND_CONSUME
static HeldItemInteractionResult	FAILURE_AND_RETAIN
static HeldItemInteractionResult	SUCCESS_AND_CONSUME
static HeldItemInteractionResult	SUCCESS_AND_RETAIN

Constructor Summary

Constructors

Constructor	Description
HeldItemInteractionResult(boolean success, boolean consume)	Creates an instance of a HeldItemInteractionResult record class.

Method Summary

Modifier and Type	Method	Description
boolean	consume()	Returns the value of the consume 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.
boolean	success()	Returns the value of the success record component.
final 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

Field Details

FAILURE_AND_RETAIN

public static HeldItemInteractionResult FAILURE_AND_RETAIN

SUCCESS_AND_RETAIN

public static HeldItemInteractionResult SUCCESS_AND_RETAIN

FAILURE_AND_CONSUME

public static HeldItemInteractionResult FAILURE_AND_CONSUME

SUCCESS_AND_CONSUME

public static HeldItemInteractionResult SUCCESS_AND_CONSUME

Constructor Details

HeldItemInteractionResult

public HeldItemInteractionResult(boolean success,
 boolean consume)

Creates an instance of a HeldItemInteractionResult record class.

Parameters:

success - the value for the success record component

consume - the value for the consume 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 '=='.

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.

success

public boolean success()

Returns the value of the success record component.

Returns:

the value of the success record component

consume

public boolean consume()

Returns the value of the consume record component.

Returns:

the value of the consume record component