Record Class ConfigField.ChoiceField

java.lang.Object

java.lang.Record

com.botwithus.bot.api.config.ConfigField.ChoiceField

All Implemented Interfaces:

ConfigField

Enclosing interface:

ConfigField

public static record ConfigField.ChoiceField(String key, String label, List<String> choices, String value)
extends Record
implements ConfigField

A field whose value is one of an enumerated set of choices.

Nested Class Summary

Nested classes/interfaces inherited from interface ConfigField

ConfigField.BoolField, ConfigField.ChoiceField, ConfigField.IntField, ConfigField.ItemIdField, ConfigField.StringField

Constructor Summary

Constructors

Constructor	Description
ChoiceField(String key, String label, List<String> choices, String value)	Creates an instance of a ChoiceField record class.

Method Summary

Modifier and Type	Method	Description
List<String>	choices()	Returns the value of the choices 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.
String	key()	Returns the value of the key record component.
String	label()	Returns the value of the label record component.
final String	toString()	Returns a string representation of this record class.
String	value()	Returns the value of the value record component.

Methods inherited from class Object

getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface ConfigField

defaultAsString

Constructor Details

ChoiceField

public ChoiceField(String key,
 String label,
 List<String> choices,
 String value)

Creates an instance of a ChoiceField record class.

Parameters:

key - the value for the key record component

label - the value for the label record component

choices - the value for the choices record component

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

key

public String key()

Returns the value of the key record component.

Specified by:

key in interface ConfigField

Returns:

the value of the key record component

label

public String label()

Returns the value of the label record component.

Specified by:

label in interface ConfigField

Returns:

the value of the label record component

choices

public List<String> choices()

Returns the value of the choices record component.

Returns:

the value of the choices record component

value

public String value()

Returns the value of the value record component.

Returns:

the value of the value record component