Package dev.sympho.modular_commands.api.command.parameter.parse

Record Class ChoicesParser.Choice<P extends @NonNull Object>

java.lang.Object

java.lang.Record

dev.sympho.modular_commands.api.command.parameter.parse.ChoicesParser.Choice<P>

Type Parameters:

P - The raw value type.

Record Components:

name - The choice name.

value - The choice value.

Enclosing interface:

ChoicesParser<P extends @NonNull Object,T extends @NonNull Object>

public static record ChoicesParser.Choice<P extends @NonNull Object>(String name, P extends @NonNull Object value)
extends Record

A possible choice to be selected.

Since:

1.0

Constructor Summary

Constructors

Constructor	Description
Choice(String name, P value)	Creates an instance of a Choice 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.
String	name()	Returns the value of the name record component.
static <P extends @NonNull Object> ChoicesParser.Choice<P>	of(String name, P choice)	Creates a new choice.
static <P extends @NonNull Object, V extends @NonNull Object> Map.Entry<ChoicesParser.Choice<P>,V>	of(String name, P choice, V value)	Creates a new choice mapping.
final String	toString()	Returns a string representation of this record class.
P	value()	Returns the value of the value record component.

Methods inherited from class java.lang.Object

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

Constructor Details

Choice

public Choice(String name,
 P value)

Creates an instance of a Choice record class.

Parameters:

name - the value for the name record component

value - the value for the value record component

Method Details

of

public static <P extends @NonNull Object>
ChoicesParser.Choice<P> of(String name,
 P choice)

Creates a new choice.

Type Parameters:

P - The raw value type.

Parameters:

name - The choice name.

choice - The choice value.

Returns:

The choice.

of

public static <P extends @NonNull Object,
V extends @NonNull Object>
Map.Entry<ChoicesParser.Choice<P>,V> of(String name,
 P choice,
 V value)

Creates a new choice mapping.

Type Parameters:

P - The raw value type.

V - The mapped value type.

Parameters:

name - The choice name.

choice - The choice value.

value - The mapped value.

Returns:

The choice.

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.

name

public String name()

Returns the value of the name record component.

Returns:

the value of the name record component

value

public P value()

Returns the value of the value record component.

Returns:

the value of the value record component