Package cloud.commandframework.arguments.flags

Class CommandFlag.Builder<T>

java.lang.Object
cloud.commandframework.arguments.flags.CommandFlag.Builder<T>
Enclosing class:
CommandFlag<T>
@API(status=STABLE) public static final class CommandFlag.Builder<T> extends Object

  • Method Details

    • withAliases

      public @NonNull CommandFlag.Builder<T> withAliases(@NonNull String... aliases)
      Create a new builder instance using the given flag aliases. These may at most be one character in length
      Parameters:
      aliases - Flag aliases
      Returns:
      New builder instance

    • withDescription

      @Deprecated @API(status=DEPRECATED, since="1.4.0") public @NonNull CommandFlag.Builder<T> withDescription(@NonNull Description description)
      Deprecated.
      for removal since 1.4.0. Use withDescription(ArgumentDescription) instead.
      Create a new builder instance using the given flag description
      Parameters:
      description - Flag description
      Returns:
      New builder instance

    • withDescription

      @API(status=STABLE, since="1.4.0") public @NonNull CommandFlag.Builder<T> withDescription(@NonNull ArgumentDescription description)
      Create a new builder instance using the given flag description
      Parameters:
      description - Flag description
      Returns:
      New builder instance
      Since:
      1.4.0

    • withArgument

      public <N> @NonNull CommandFlag.Builder<N> withArgument(@NonNull CommandArgument<?,N> argument)
      Create a new builder instance using the given command argument
      Type Parameters:
      N - New argument type
      Parameters:
      argument - Command argument
      Returns:
      New builder instance

    • withArgument

      public <N> @NonNull CommandFlag.Builder<N> withArgument(@NonNull CommandArgument.Builder<?,N> builder)
      Create a new builder instance using the given command argument
      Type Parameters:
      N - New argument type
      Parameters:
      builder - Command argument builder. CommandArgument.Builder.build() will be invoked.
      Returns:
      New builder instance

    • withPermission

      @API(status=STABLE, since="1.6.0") public @NonNull CommandFlag.Builder<T> withPermission(@NonNull CommandPermission permission)
      Create a new builder instance using the given flag permission
      Parameters:
      permission - Flag permission
      Returns:
      New builder instance
      Since:
      1.6.0

    • asRepeatable

      @API(status=STABLE, since="1.7.0") public @NonNull CommandFlag.Builder<T> asRepeatable()
      Marks the flag as CommandFlag.FlagMode.REPEATABLE.
      Returns:
      new builder instance
      Since:
      1.7.0

    • build

      public @NonNull CommandFlag<T> build()
      Build a new command flag instance
      Returns:
      Constructed instance