Record Class ModalDefinition

java.lang.Object

java.lang.Record

io.github.kaktushose.jdac.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<Modal>, Invokable, InteractionDefinition

public record ModalDefinition(ClassDescription classDescription, MethodDescription methodDescription, Collection<String> permissions, String title, SequencedCollection<ModalDefinition.TextInputDefinition> textInputs)
extends Record
implements InteractionDefinition, CustomIdJDAEntity<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 InteractionDefinition

InteractionDefinition.ReplyConfig

Field Summary

Fields inherited from interface Invokable

log

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
static ModalDefinition	build(MethodBuildContext context)	Builds a new ModalDefinition from the given MethodBuildContext.
ClassDescription	classDescription()	Returns the value of the classDescription record component.
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.
MethodDescription	methodDescription()	Returns the value of the methodDescription record component.
Collection<String>	permissions()	Returns the value of the permissions record component.
SequencedCollection<ModalDefinition.TextInputDefinition>	textInputs()	Returns the value of the textInputs record component.
String	title()	Returns the value of the title record component.
Modal	toJDAEntity(CustomId customId)	Transforms this definition to an Modal with the given custom id.
final String	toString()	Returns a string representation of this record class.
ModalDefinition	with(@Nullable String title, @Nullable List<ModalDefinition.TextInputDefinition> textInputs)	Builds a new ModalDefinition with the given values.

Methods inherited from class Object

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

Methods inherited from interface InteractionDefinition

definitionId

Methods inherited from interface Invokable

invoke

Constructor Details

ModalDefinition

public ModalDefinition(ClassDescription classDescription,
 MethodDescription methodDescription,
 Collection<String> permissions,
 String title,
 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 ModalDefinition build(MethodBuildContext context)

Builds a new ModalDefinition from the given MethodBuildContext.

Returns:

an Optional holding the ModalDefinition

with

public ModalDefinition with(@Nullable String title,
 @Nullable List<ModalDefinition.TextInputDefinition> textInputs)

Builds a new ModalDefinition with the given values.

toJDAEntity

public Modal toJDAEntity(CustomId customId)

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

Specified by:

toJDAEntity in interface CustomIdJDAEntity<Modal>

Parameters:

customId - the CustomId to use to build this JDA entity

Returns:

the Modal

See Also:

• CustomId.independent(String)

displayName

public 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

public 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

public 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

public 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

public String title()

Returns the value of the title record component.

Returns:

the value of the title record component

textInputs

public SequencedCollection<ModalDefinition.TextInputDefinition> textInputs()

Returns the value of the textInputs record component.

Returns:

the value of the textInputs record component