Package dev.sympho.modular_commands.api.command.parameter

Record Class Parameter<T extends @NonNull Object>

java.lang.Object
java.lang.Record
dev.sympho.modular_commands.api.command.parameter.Parameter<T>
Type Parameters:
T - The type of argument that is provided.
Record Components:
name - The name of the parameter.
description - The description of the parameter.
required - Whether the parameter must be provided to invoke the command.
defaultValue - The default value for the parameter.
parser - The parser to use to process received arguments.
public record Parameter<T extends @NonNull Object>(@MatchesRegex("(?U)^[-_\\p{L}\\p{N}\\p{sc=Deva}\\p{sc=Thai}]{1,32}+$") String name, @MatchesRegex("(?Us)^.{1,100}+$") String description, boolean required, @Nullable T extends @NonNull Object defaultValue, ArgumentParser<?,T extends @NonNull Object> parser) extends Record
Specification for a parameter received for a command.

Irrespective of whether the command it is used with is compatible with interactions or not, all values must be compatible with the Discord API specification for command parameters.

Since:
1.0
Version:
1.0

  • Field Details

  • Constructor Details

    • Parameter

      public Parameter(@MatchesRegex("(?U)^[-_\\p{L}\\p{N}\\p{sc=Deva}\\p{sc=Thai}]{1,32}+$") String name, @MatchesRegex("(?Us)^.{1,100}+$") String description, boolean required, @Nullable T defaultValue, ArgumentParser<?,T> parser)
      Creates an instance of a Parameter record class.
      Parameters:
      name - the value for the name record component
      description - the value for the description record component
      required - the value for the required record component
      defaultValue - the value for the defaultValue record component
      parser - the value for the parser record component

  • Method Details

    • builder

      @SideEffectFree public static <T extends @NonNull Object> ParameterBuilder<T> builder()
      Creates a new builder.
      Type Parameters:
      T - The argument type.
      Returns:
      The builder.

    • 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 '=='.
      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.

    • name

      public @MatchesRegex("(?U)^[-_\\p{L}\\p{N}\\p{sc=Deva}\\p{sc=Thai}]{1,32}+$") String name()
      Returns the value of the name record component.
      Returns:
      the value of the name record component

    • description

      public @MatchesRegex("(?Us)^.{1,100}+$") String description()
      Returns the value of the description record component.
      Returns:
      the value of the description record component

    • required

      public boolean required()
      Returns the value of the required record component.
      Returns:
      the value of the required record component

    • defaultValue

      public @Nullable T defaultValue()
      Returns the value of the defaultValue record component.
      Returns:
      the value of the defaultValue record component

    • parser

      public ArgumentParser<?,T> parser()
      Returns the value of the parser record component.
      Returns:
      the value of the parser record component