Record Class DialogInput.Text

java.lang.Object

java.lang.Record

net.minestom.server.dialog.DialogInput.Text

All Implemented Interfaces:

DialogInput

Enclosing interface:

DialogInput

public static record DialogInput.Text(String key, int width, Component label, boolean labelVisible, String initial, int maxLength, @Nullable DialogInput.Text.Multiline multiline)
extends Record
implements DialogInput

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final record	DialogInput.Text.Multiline

Nested classes/interfaces inherited from interface DialogInput

DialogInput.Boolean, DialogInput.NumberRange, DialogInput.SingleOption, DialogInput.Text

Field Summary

Fields

Modifier and Type	Field	Description
static final StructCodec<DialogInput.Text>	CODEC

Fields inherited from interface DialogInput

DEFAULT_WIDTH, REGISTRY

Constructor Summary

Constructors

Constructor	Description
Text(String key, int width, Component label, boolean labelVisible, String initial, int maxLength, @Nullable DialogInput.Text.Multiline multiline)	Creates an instance of a Text record class.

Method Summary

Modifier and Type	Method	Description
StructCodec<? extends DialogInput>	codec()
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	initial()	Returns the value of the initial record component.
String	key()	Returns the value of the key record component.
Component	label()	Returns the value of the label record component.
boolean	labelVisible()	Returns the value of the labelVisible record component.
int	maxLength()	Returns the value of the maxLength record component.
@Nullable DialogInput.Text.Multiline	multiline()	Returns the value of the multiline record component.
final String	toString()	Returns a string representation of this record class.
int	width()	Returns the value of the width record component.

Methods inherited from class Object

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

Field Details

CODEC

public static final StructCodec<DialogInput.Text> CODEC

Constructor Details

Text

public Text(String key,
 int width,
 Component label,
 boolean labelVisible,
 String initial,
 int maxLength,
 @Nullable
 @Nullable DialogInput.Text.Multiline multiline)

Creates an instance of a Text record class.

Parameters:

key - the value for the key record component

width - the value for the width record component

label - the value for the label record component

labelVisible - the value for the labelVisible record component

initial - the value for the initial record component

maxLength - the value for the maxLength record component

multiline - the value for the multiline record component

Method Details

codec

public StructCodec<? extends DialogInput> codec()

Specified by:

codec in interface DialogInput

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. Reference components are compared with Objects::equals(Object,Object); primitive components are compared with the compare method from their corresponding wrapper classes.

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.

Returns:

the value of the key record component

width

public int width()

Returns the value of the width record component.

Returns:

the value of the width record component

label

public Component label()

Returns the value of the label record component.

Returns:

the value of the label record component

labelVisible

public boolean labelVisible()

Returns the value of the labelVisible record component.

Returns:

the value of the labelVisible record component

initial

public String initial()

Returns the value of the initial record component.

Returns:

the value of the initial record component

maxLength

public int maxLength()

Returns the value of the maxLength record component.

Returns:

the value of the maxLength record component

multiline

@Nullable
public @Nullable DialogInput.Text.Multiline multiline()

Returns the value of the multiline record component.

Returns:

the value of the multiline record component