StringSelectMenuDefinition (jda-commands 4.0.0-beta.3 API)

java.lang.Object

java.lang.Record

com.github.kaktushose.jda.commands.definitions.interactions.component.menu.StringSelectMenuDefinition

Record Components:: clazzDescription - 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 menu; selectOptions - the SelectOptions of this menu; placeholder - the placeholder text of this menu; minValue - the minimum amount of choices; maxValue - the maximum amount of choices

All Implemented Interfaces:: Definition, CustomIdJDAEntity<StringSelectMenu>, com.github.kaktushose.jda.commands.definitions.features.internal.Invokable, JDAEntity<StringSelectMenu>, ComponentDefinition<StringSelectMenu>, SelectMenuDefinition<StringSelectMenu>, InteractionDefinition

public record StringSelectMenuDefinition(@NotNull ClassDescription clazzDescription, @NotNull MethodDescription methodDescription, @NotNull Collection<String> permissions, @NotNull Set<StringSelectMenuDefinition.SelectOptionDefinition> selectOptions, @NotNull String placeholder, int minValue, int maxValue) extends Record implements SelectMenuDefinition<StringSelectMenu>

Representation of a string select menu.

Nested Class Summary

Nested Classes

Modifier and Type

Class

Description

static final record

StringSelectMenuDefinition.SelectOptionDefinition

Representation of a select option for a string select menu defined by a SelectOption.

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

StringSelectMenuDefinition(@NotNull ClassDescription clazzDescription, @NotNull MethodDescription methodDescription, @NotNull Collection<String> permissions, @NotNull Set<StringSelectMenuDefinition.SelectOptionDefinition> selectOptions, @NotNull String placeholder, int minValue, int maxValue)

Creates an instance of a StringSelectMenuDefinition record class.
Method Summary

Modifier and Type

Method

Description

static Optional<StringSelectMenuDefinition>

build(MethodBuildContext context)

Builds a new StringSelectMenuDefinition from the given MethodBuildContext.

@NotNull ClassDescription

clazzDescription()

Returns the value of the clazzDescription 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.

int

maxValue()

Returns the value of the maxValue record component.

@NotNull MethodDescription

methodDescription()

Returns the value of the methodDescription record component.

int

minValue()

Returns the value of the minValue record component.

@NotNull Collection<String>

permissions()

Returns the value of the permissions record component.

@NotNull String

placeholder()

Returns the value of the placeholder record component.

@NotNull Set<StringSelectMenuDefinition.SelectOptionDefinition>

selectOptions()

Returns the value of the selectOptions record component.

@NotNull StringSelectMenu

toJDAEntity()

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

@NotNull StringSelectMenu

toJDAEntity(@NotNull CustomId customId)

Transforms this definition to an StringSelectMenu with the given CustomId.

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
- StringSelectMenuDefinition
  
  public StringSelectMenuDefinition(@NotNull @NotNull ClassDescription clazzDescription, @NotNull @NotNull MethodDescription methodDescription, @NotNull @NotNull Collection<String> permissions, @NotNull @NotNull Set<StringSelectMenuDefinition.SelectOptionDefinition> selectOptions, @NotNull @NotNull String placeholder, int minValue, int maxValue)
  
  Creates an instance of a StringSelectMenuDefinition record class.
  
  Parameters:
  
  clazzDescription - the value for the clazzDescription record component
  
  methodDescription - the value for the methodDescription record component
  
  permissions - the value for the permissions record component
  
  selectOptions - the value for the selectOptions record component
  
  placeholder - the value for the placeholder record component
  
  minValue - the value for the minValue record component
  
  maxValue - the value for the maxValue record component
Method Details
- build
  
  public static Optional<StringSelectMenuDefinition> build(MethodBuildContext context)
  
  Builds a new StringSelectMenuDefinition from the given MethodBuildContext.
  
  Returns:
  
  an Optional holding the StringSelectMenuDefinition
- toJDAEntity
  @NotNull public @NotNull StringSelectMenu toJDAEntity()
  
  Transforms this definition to an StringSelectMenu with an independent custom id.
  
  Specified by:
  
  toJDAEntity in interface JDAEntity<StringSelectMenu>
  
  Returns:
  
  the StringSelectMenu
  
  See Also:
  
  CustomId.independent(String)
- toJDAEntity
  
  @NotNull public @NotNull StringSelectMenu toJDAEntity(@NotNull @NotNull CustomId customId)
  
  Transforms this definition to an StringSelectMenu with the given CustomId.
  
  Specified by:
  
  toJDAEntity in interface CustomIdJDAEntity<StringSelectMenu>
  
  Parameters:
  
  customId - the CustomId to use
  
  Returns:
  
  the StringSelectMenu
- 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. 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.
- clazzDescription
  
  @NotNull public @NotNull ClassDescription clazzDescription()
  
  Returns the value of the clazzDescription record component.
  
  Specified by:
  
  clazzDescription in interface ComponentDefinition<StringSelectMenu>
  
  Specified by:
  
  clazzDescription in interface com.github.kaktushose.jda.commands.definitions.features.internal.Invokable
  
  Returns:
  
  the value of the clazzDescription record component
- methodDescription
  
  @NotNull public @NotNull MethodDescription methodDescription()
  
  Returns the value of the methodDescription record component.
  
  Specified by:
  
  methodDescription in interface ComponentDefinition<StringSelectMenu>
  
  Specified by:
  
  methodDescription in interface com.github.kaktushose.jda.commands.definitions.features.internal.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
- selectOptions
  
  @NotNull public @NotNull Set<StringSelectMenuDefinition.SelectOptionDefinition> selectOptions()
  
  Returns the value of the selectOptions record component.
  
  Returns:
  
  the value of the selectOptions record component
- placeholder
  
  @NotNull public @NotNull String placeholder()
  
  Returns the value of the placeholder record component.
  
  Specified by:
  
  placeholder in interface SelectMenuDefinition<StringSelectMenu>
  
  Returns:
  
  the value of the placeholder record component
- minValue
  
  public int minValue()
  
  Returns the value of the minValue record component.
  
  Specified by:
  
  minValue in interface SelectMenuDefinition<StringSelectMenu>
  
  Returns:
  
  the value of the minValue record component
- maxValue
  
  public int maxValue()
  
  Returns the value of the maxValue record component.
  
  Specified by:
  
  maxValue in interface SelectMenuDefinition<StringSelectMenu>
  
  Returns:
  
  the value of the maxValue record component