Package studio.mevera.imperat.command

Class CommandUsage.Builder<S extends Source>

java.lang.Object

studio.mevera.imperat.command.CommandUsage.Builder<S>

Enclosing interface:

CommandUsage<S extends Source>

public static class CommandUsage.Builder<S extends Source>
extends Object

Method Summary

Modifier and Type	Method	Description
CommandUsage<S>	build(@NotNull Command<S> command)
CommandUsage<S>	build(@NotNull Command<S> command, boolean help)
CommandUsage<S>	buildAsHelp(@NotNull Command<S> command)
CommandUsage.Builder<S>	cooldown(long value, TimeUnit unit)
CommandUsage.Builder<S>	cooldown(long value, TimeUnit unit, @Nullable String permission)
CommandUsage.Builder<S>	cooldown(@Nullable UsageCooldown cooldown)
CommandUsage.Builder<S>	coordinator(CommandCoordinator<S> commandCoordinator)
CommandUsage.Builder<S>	description(String description)
CommandUsage.Builder<S>	examples(String... examples)
CommandUsage.Builder<S>	execute(CommandExecution<S> execution)
final CommandUsage.Builder<S>	parameterBuilders(List<? extends ParameterBuilder<S,?>> builders)
CommandUsage.Builder<S>	parameters(List<CommandParameter<S>> params)
final CommandUsage.Builder<S>	parameters(CommandParameter<S>... params)
final CommandUsage.Builder<S>	parameters(ParameterBuilder<S,?>... builders)
CommandUsage.Builder<S>	permission(String permission)
CommandUsage.Builder<S>	registerFlags(Set<FlagData<S>> flags)
CommandUsage.Builder<S>	setPropertiesFromCommandMainUsage(Command<S> command)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Details

coordinator

public CommandUsage.Builder<S> coordinator(CommandCoordinator<S> commandCoordinator)

examples

public CommandUsage.Builder<S> examples(String... examples)

execute

public CommandUsage.Builder<S> execute(CommandExecution<S> execution)

permission

public CommandUsage.Builder<S> permission(String permission)

cooldown

public CommandUsage.Builder<S> cooldown(long value,
 TimeUnit unit)

cooldown

public CommandUsage.Builder<S> cooldown(long value,
 TimeUnit unit,
 @Nullable
 @Nullable String permission)

cooldown

public CommandUsage.Builder<S> cooldown(@Nullable
 @Nullable UsageCooldown cooldown)

description

public CommandUsage.Builder<S> description(String description)

parameters

@SafeVarargs
public final CommandUsage.Builder<S> parameters(ParameterBuilder<S,?>... builders)

parameterBuilders

public final CommandUsage.Builder<S> parameterBuilders(List<? extends ParameterBuilder<S,?>> builders)

parameters

@SafeVarargs
public final CommandUsage.Builder<S> parameters(CommandParameter<S>... params)

parameters

public CommandUsage.Builder<S> parameters(List<CommandParameter<S>> params)

registerFlags

public CommandUsage.Builder<S> registerFlags(Set<FlagData<S>> flags)

setPropertiesFromCommandMainUsage

public CommandUsage.Builder<S> setPropertiesFromCommandMainUsage(Command<S> command)

build

public CommandUsage<S> build(@NotNull
 @NotNull Command<S> command,
 boolean help)

build

public CommandUsage<S> build(@NotNull
 @NotNull Command<S> command)

buildAsHelp

public CommandUsage<S> buildAsHelp(@NotNull
 @NotNull Command<S> command)