Package io.github.mqzn.commands.arguments

Class AbstractArgument<T>

java.lang.Object
io.github.mqzn.commands.arguments.AbstractArgument<T>
Type Parameters:
T - the data type of the argument parameter
All Implemented Interfaces:
Argument<T>
Direct Known Subclasses:
ArgumentBoolean, ArgumentEnum, ArgumentLiteral, ArgumentNumber, ArgumentStringArray, ArgumentWord
public abstract class AbstractArgument<T> extends Object implements Argument<T>
This class represents an argument as a command-syntax parameter to be used in usages and context parsing

  • Field Details

    • suggestions

      @NotNull protected final @NotNull List<T> suggestions

  • Constructor Details

    • AbstractArgument

      public AbstractArgument(@NotNull @NotNull String id, @NotNull @NotNull Class<T> type)

    • AbstractArgument

      public AbstractArgument(@NotNull @NotNull String id, @NotNull @NotNull Class<T> type, boolean optional, boolean useRemainingSpace)

    • AbstractArgument

      public AbstractArgument(String id, Class<T> type, boolean useRemainingSpace)

    • AbstractArgument

      public AbstractArgument(@NotNull @NotNull ArgumentData data, Class<T> type)

  • Method Details

    • id

      public String id()
      The id of the Required argument
      Specified by:
      id in interface Argument<T>
      Returns:
      the id of the Required argument

    • description

      public Optional<@Nullable String> description()
      The description of an argument
      Specified by:
      description in interface Argument<T>
      Returns:
      the description for usage

    • type

      public Class<T> type()
      The type of the argument
      Specified by:
      type in interface Argument<T>
      Returns:
      the class type of the argument

    • defaultValue

      @Nullable public T defaultValue()
      Description copied from interface: Argument
      The default value of this argument if the default value is null, means it has no default values, so it's a REQUIRED argument !
      Specified by:
      defaultValue in interface Argument<T>
      Returns:
      the default value of the argument if it's not set by default it's going to be null

    • setDefaultValue

      @NotNull public @NotNull Argument<T> setDefaultValue(@Nullable T value)
      Description copied from interface: Argument
      Modifies the default value of the argument
      Specified by:
      setDefaultValue in interface Argument<T>
      Parameters:
      value - the new default value
      Returns:
      builder pattern

    • isOptional

      public boolean isOptional()
      Specified by:
      isOptional in interface Argument<T>
      Returns:
      whether this argument is optional or not

    • setOptional

      public void setOptional(boolean optional)
      Sets the argument to be optional or not
      Specified by:
      setOptional in interface Argument<T>
      Parameters:
      optional - whether it's going to be optional or not

    • asOptional

      public Argument<T> asOptional()
      Sets it automatically as optional (true)
      Returns:
      builder-pattern

    • useRemainingSpace

      public boolean useRemainingSpace()
      Whether the argument can become greedy and use the remaining args till the end of the args
      Specified by:
      useRemainingSpace in interface Argument<T>
      Returns:
      Whether the argument can become greedy * and use the remaining args till the end of the args

    • description

      public Argument<T> description(@Nullable @Nullable String description)
      Sets the description of the argument
      Specified by:
      description in interface Argument<T>
      Parameters:
      description - the new description of the argument
      Returns:
      builder-pattern

    • suggest

      public Argument<T> suggest(@NotNull T suggestion)
      Adds a suggestion object into the argument for TAB-completion
      Specified by:
      suggest in interface Argument<T>
      Parameters:
      suggestion - the suggestion to add
      Returns:
      builder-pattern

    • suggestions

      @NotNull public @NotNull List<T> suggestions()
      Specified by:
      suggestions in interface Argument<T>
      Returns:
      the suggestions of this argument

    • suggest

      @SafeVarargs public final Argument<T> suggest(@NotNull @NotNull T... suggestions)
      Suggests multiple suggestions for this argument
      Specified by:
      suggest in interface Argument<T>
      Parameters:
      suggestions - the suggestions to add
      Returns:
      builder-pattern

    • toString

      public String toString(T obj)
      changes the type of argument's object to a string
      Specified by:
      toString in interface Argument<T>
      Parameters:
      obj - the object type of the argument
      Returns:
      object as string

    • toString

      public String toString()
      Overrides:
      toString in class Object

    • equals

      public boolean equals(Object o)
      Overrides:
      equals in class Object

    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class Object