Record Class SlashCommandDefinition

java.lang.Object

java.lang.Record

io.github.kaktushose.jdac.definitions.interactions.command.SlashCommandDefinition

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 command

name - the name of the command

commandConfig - the CommandDefinition.CommandConfig to use

description - the command description

commandOptions - a SequencedCollection of OptionDataDefinitions

All Implemented Interfaces:

Definition, Invokable, JDAEntity<CommandData>, CommandDefinition, InteractionDefinition

public record SlashCommandDefinition(ClassDescription classDescription, MethodDescription methodDescription, Collection<String> permissions, String name, CommandDefinition.CommandConfig commandConfig, String description, SequencedCollection<OptionDataDefinition> commandOptions)
extends Record
implements CommandDefinition

Representation of a slash command.

Nested Class Summary

Nested classes/interfaces inherited from interface CommandDefinition

CommandDefinition.CommandConfig

Nested classes/interfaces inherited from interface InteractionDefinition

InteractionDefinition.ReplyConfig

Field Summary

Fields inherited from interface Invokable

log

Constructor Summary

Constructors

Constructor	Description
SlashCommandDefinition(ClassDescription classDescription, MethodDescription methodDescription, Collection<String> permissions, String name, CommandDefinition.CommandConfig commandConfig, String description, SequencedCollection<OptionDataDefinition> commandOptions)	Creates an instance of a SlashCommandDefinition record class.

Method Summary

Modifier and Type	Method	Description
static SlashCommandDefinition	build(MethodBuildContext context)	Builds a new SlashCommandDefinition from the given MethodBuildContext.
ClassDescription	classDescription()	Returns the value of the classDescription record component.
CommandDefinition.CommandConfig	commandConfig()	Returns the value of the commandConfig record component.
SequencedCollection<OptionDataDefinition>	commandOptions()	Returns the value of the commandOptions record component.
Command.Type	commandType()	The Command.Type of this command.
String	description()	Returns the value of the description 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.
String	name()	Returns the value of the name record component.
Collection<String>	permissions()	Returns the value of the permissions record component.
SlashCommandData	toJDAEntity()	Transforms this definition into SlashCommandData.
final String	toString()	Returns a string representation of this record class.
SubcommandData	toSubcommandData(String name)	Transforms this definition into SubcommandData.

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

SlashCommandDefinition

public SlashCommandDefinition(ClassDescription classDescription,
 MethodDescription methodDescription,
 Collection<String> permissions,
 String name,
 CommandDefinition.CommandConfig commandConfig,
 String description,
 SequencedCollection<OptionDataDefinition> commandOptions)

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

name - the value for the name record component

commandConfig - the value for the commandConfig record component

description - the value for the description record component

commandOptions - the value for the commandOptions record component

Method Details

build

public static SlashCommandDefinition build(MethodBuildContext context)

Builds a new SlashCommandDefinition from the given MethodBuildContext.

Returns:

an Optional holding the SlashCommandDefinition

toJDAEntity

public SlashCommandData toJDAEntity()

Transforms this definition into SlashCommandData.

This does not set CommandData.setLocalizationFunction(LocalizationFunction)!

Specified by:

toJDAEntity in interface JDAEntity<CommandData>

Returns:

the SlashCommandData

toSubcommandData

public SubcommandData toSubcommandData(String name)

Transforms this definition into SubcommandData.

Returns:

the SubcommandData

displayName

public String displayName()

Description copied from interface: Definition

The human-readable name of this definition.

Specified by:

displayName in interface Definition

commandType

public Command.Type commandType()

Description copied from interface: CommandDefinition

The Command.Type of this command.

Specified by:

commandType in interface CommandDefinition

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

name

public String name()

Returns the value of the name record component.

Specified by:

name in interface CommandDefinition

Returns:

the value of the name record component

commandConfig

public CommandDefinition.CommandConfig commandConfig()

Returns the value of the commandConfig record component.

Specified by:

commandConfig in interface CommandDefinition

Returns:

the value of the commandConfig record component

description

public String description()

Returns the value of the description record component.

Returns:

the value of the description record component

commandOptions

public SequencedCollection<OptionDataDefinition> commandOptions()

Returns the value of the commandOptions record component.

Returns:

the value of the commandOptions record component