Record Class ModalDefinition

java.lang.Object

java.lang.Record

com.github.kaktushose.jda.commands.definitions.interactions.ModalDefinition

Record Components:

classDescription - the ClassDescription of the declaring class of the methodDescription()

methodDescription - the MethodDescription of the method this definition is bound to

permissions - a Collection of permissions for this modal

title - the title of the modal

textInputs - the TextInputs of this modal

All Implemented Interfaces:

Definition, CustomIdJDAEntity<net.dv8tion.jda.api.interactions.modals.Modal>, Invokable, InteractionDefinition

public record ModalDefinition(@NotNull ClassDescription classDescription, @NotNull MethodDescription methodDescription, @NotNull Collection<String> permissions, @NotNull String title, @NotNull SequencedCollection<ModalDefinition.TextInputDefinition> textInputs)
extends Record
implements InteractionDefinition, CustomIdJDAEntity<net.dv8tion.jda.api.interactions.modals.Modal>

Representation of a modal.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final record	ModalDefinition.TextInputDefinition	Representation of a modal text input defined by TextInput

Nested classes/interfaces inherited from interface com.github.kaktushose.jda.commands.definitions.interactions.InteractionDefinition

InteractionDefinition.ReplyConfig

Field Summary

Fields inherited from interface com.github.kaktushose.jda.commands.definitions.features.internal.Invokable

log

Constructor Summary

Constructors

Constructor	Description
ModalDefinition(@NotNull ClassDescription classDescription, @NotNull MethodDescription methodDescription, @NotNull Collection<String> permissions, @NotNull String title, @NotNull SequencedCollection<ModalDefinition.TextInputDefinition> textInputs)	Creates an instance of a ModalDefinition record class.

Method Summary

Modifier and Type	Method	Description
static Optional<ModalDefinition>	build(MethodBuildContext context)	Builds a new ModalDefinition from the given MethodBuildContext.
@NotNull ClassDescription	classDescription()	Returns the value of the classDescription record component.
@NotNull String	displayName()	The human-readable name of this definition.
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.
@NotNull MethodDescription	methodDescription()	Returns the value of the methodDescription record component.
@NotNull Collection<String>	permissions()	Returns the value of the permissions record component.
@NotNull SequencedCollection<ModalDefinition.TextInputDefinition>	textInputs()	Returns the value of the textInputs record component.
@NotNull String	title()	Returns the value of the title record component.
@NotNull net.dv8tion.jda.api.interactions.modals.Modal	toJDAEntity(@NotNull CustomId customId)	Transforms this definition to an Modal with the given custom id.
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

Methods inherited from interface com.github.kaktushose.jda.commands.definitions.interactions.InteractionDefinition

definitionId, newInstance, replyConfig

Methods inherited from interface com.github.kaktushose.jda.commands.definitions.features.internal.Invokable

invoke

Constructor Details

ModalDefinition

public ModalDefinition(@NotNull
 @NotNull ClassDescription classDescription,
 @NotNull
 @NotNull MethodDescription methodDescription,
 @NotNull
 @NotNull Collection<String> permissions,
 @NotNull
 @NotNull String title,
 @NotNull
 @NotNull SequencedCollection<ModalDefinition.TextInputDefinition> textInputs)

Creates an instance of a ModalDefinition record class.

Parameters:

classDescription - the value for the classDescription record component

methodDescription - the value for the methodDescription record component

permissions - the value for the permissions record component

title - the value for the title record component

textInputs - the value for the textInputs record component

Method Details

build

public static Optional<ModalDefinition> build(MethodBuildContext context)

Builds a new ModalDefinition from the given MethodBuildContext.

Returns:

an Optional holding the ModalDefinition

toJDAEntity

@NotNull
public @NotNull net.dv8tion.jda.api.interactions.modals.Modal toJDAEntity(@NotNull
 @NotNull CustomId customId)

Transforms this definition to an Modal with the given custom id.

Specified by:

toJDAEntity in interface CustomIdJDAEntity<net.dv8tion.jda.api.interactions.modals.Modal>

Parameters:

customId - the CustomId to use to build this JDA entity

Returns:

the Modal

See Also:

• CustomId.independent(String)

displayName

@NotNull
public @NotNull String displayName()

Description copied from interface: Definition

The human-readable name of this definition.

Specified by:

displayName in interface Definition

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.

classDescription

@NotNull
public @NotNull ClassDescription classDescription()

Returns the value of the classDescription record component.

Specified by:

classDescription in interface Invokable

Returns:

the value of the classDescription record component

methodDescription

@NotNull
public @NotNull MethodDescription methodDescription()

Returns the value of the methodDescription record component.

Specified by:

methodDescription in interface Invokable

Returns:

the value of the methodDescription record component

permissions

@NotNull
public @NotNull Collection<String> permissions()

Returns the value of the permissions record component.

Specified by:

permissions in interface InteractionDefinition

Returns:

the value of the permissions record component

title

@NotNull
public @NotNull String title()

Returns the value of the title record component.

Returns:

the value of the title record component

textInputs

@NotNull
public @NotNull SequencedCollection<ModalDefinition.TextInputDefinition> textInputs()

Returns the value of the textInputs record component.

Returns:

the value of the textInputs record component