Class Parameter<T>

java.lang.Object
com.kamikazejam.kamicommon.command.Parameter<T>
public class Parameter<T> extends Object
One declared argument of a KamiCommand, pairing a Type with a display name and an optional default value. Build one with of(Type) and the fluent builder; a parameter is required exactly when no default was supplied, and a default of null is legal and different from having none. KamiCommand.addParameter(Parameter) enforces ordering, throwing IllegalArgumentException for a required parameter declared after an optional one and IllegalStateException for anything declared after a concatenating one.
See Also:

  • Method Details

    • isRequired

      public boolean isRequired()

    • isOptional

      public boolean isOptional()

    • isDefaultValueSet

      public boolean isDefaultValueSet()
      Returns:
      IFF a default value is set (may still be null)

    • getDefaultDesc

      @Nullable public @Nullable String getDefaultDesc()
      Returns:
      null if no default value is set, or the description of the default value if set, otherwise the default value as a string

    • isRequiredFor

      public boolean isRequiredFor(@Nullable @Nullable CommandSender sender)

    • isOptionalFor

      public boolean isOptionalFor(CommandSender sender)

    • getTemplate

      @NotNull public @NotNull String getTemplate(@Nullable @Nullable CommandSender sender)

    • builder

      @NotNull public static <T> Parameter.Builder<T> builder(@NotNull @NotNull Type<T> type)

    • of

      @NotNull public static <T> Parameter.Builder<T> of(@NotNull @NotNull Type<T> type)