Record Class ButtonDefinition

java.lang.Object

java.lang.Record

io.github.kaktushose.jdac.definitions.interactions.component.ButtonDefinition

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 button

label - the label of this button

emoji - the Emoji of this button or null

link - the link of this button or null

style - the ButtonStyle of this button

uniqueId - the uniqueId of this button

All Implemented Interfaces:

Definition, CustomIdJDAEntity<Button>, Invokable, JDAEntity<Button>, ComponentDefinition<Button>, InteractionDefinition

public record ButtonDefinition(ClassDescription classDescription, MethodDescription methodDescription, Collection<String> permissions, String label, @Nullable Emoji emoji, @Nullable String link, ButtonStyle style, @Nullable Integer uniqueId)
extends Record
implements ComponentDefinition<Button>

Representation of a button.

Nested Class Summary

Nested classes/interfaces inherited from interface InteractionDefinition

InteractionDefinition.ReplyConfig

Field Summary

Fields inherited from interface Invokable

log

Constructor Summary

Constructors

Constructor	Description
ButtonDefinition(ClassDescription classDescription, MethodDescription methodDescription, Collection<String> permissions, String label, @Nullable Emoji emoji, @Nullable String link, ButtonStyle style, @Nullable Integer uniqueId)	Creates an instance of a ButtonDefinition record class.

Method Summary

Modifier and Type	Method	Description
static ButtonDefinition	build(MethodBuildContext context)	Constructs a new ButtonDefinition from the given MethodBuildContext.
ClassDescription	classDescription()	Returns the value of the classDescription record component.
String	displayName()	The human-readable name of this definition.
@Nullable Emoji	emoji()	Returns the value of the emoji 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	label()	Returns the value of the label record component.
@Nullable String	link()	Returns the value of the link record component.
MethodDescription	methodDescription()	Returns the value of the methodDescription record component.
Collection<String>	permissions()	Returns the value of the permissions record component.
ButtonStyle	style()	Returns the value of the style record component.
Button	toJDAEntity()	Transforms this definition to an Button with an independent custom id.
Button	toJDAEntity(CustomId customId)	Transforms this definition to an Button with the given CustomId.
final String	toString()	Returns a string representation of this record class.
@Nullable Integer	uniqueId()	Returns the value of the uniqueId record component.
ButtonDefinition	with(@Nullable String label, @Nullable Emoji emoji, @Nullable String link, @Nullable ButtonStyle style, @Nullable Integer uniqueId)	Builds a new ButtonDefinition 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

ButtonDefinition

public ButtonDefinition(ClassDescription classDescription,
 MethodDescription methodDescription,
 Collection<String> permissions,
 String label,
 @Nullable Emoji emoji,
 @Nullable String link,
 ButtonStyle style,
 @Nullable Integer uniqueId)

Creates an instance of a ButtonDefinition 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

label - the value for the label record component

emoji - the value for the emoji record component

link - the value for the link record component

style - the value for the style record component

uniqueId - the value for the uniqueId record component

Method Details

build

public static ButtonDefinition build(MethodBuildContext context)

Constructs a new ButtonDefinition from the given MethodBuildContext.

Returns:

an ButtonDefinition holding the StringSelectMenuDefinition

with

public ButtonDefinition with(@Nullable String label,
 @Nullable Emoji emoji,
 @Nullable String link,
 @Nullable ButtonStyle style,
 @Nullable Integer uniqueId)

Builds a new ButtonDefinition with the given values

toJDAEntity

public Button toJDAEntity()

Transforms this definition to an Button with an independent custom id.

Specified by:

toJDAEntity in interface JDAEntity<Button>

Returns:

the Button

See Also:

• CustomId.independent(String)

toJDAEntity

public Button toJDAEntity(CustomId customId)

Transforms this definition to an Button with the given CustomId.

Specified by:

toJDAEntity in interface CustomIdJDAEntity<Button>

Parameters:

customId - the CustomId to use

Returns:

the Button

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 ComponentDefinition<Button>

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 ComponentDefinition<Button>

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

label

public String label()

Returns the value of the label record component.

Returns:

the value of the label record component

emoji

public @Nullable Emoji emoji()

Returns the value of the emoji record component.

Returns:

the value of the emoji record component

link

public @Nullable String link()

Returns the value of the link record component.

Returns:

the value of the link record component

style

public ButtonStyle style()

Returns the value of the style record component.

Returns:

the value of the style record component

uniqueId

public @Nullable Integer uniqueId()

Returns the value of the uniqueId record component.

Specified by:

uniqueId in interface ComponentDefinition<Button>

Returns:

the value of the uniqueId record component