com.datasiqn.commandcore.command.builder

Class CommandBuilder

java.lang.Object

com.datasiqn.commandcore.command.builder.CommandLink<CommandBuilder>

com.datasiqn.commandcore.command.builder.CommandBuilder

public class CommandBuilder
extends CommandLink<CommandBuilder>

Represents a builder that creates commands

Nested Class Summary

Nested classes/interfaces inherited from class com.datasiqn.commandcore.command.builder.CommandLink

CommandLink.Executor, CommandLink.Requirement

Field Summary

Fields

Modifier and Type	Field and Description
protected String[]	aliases
protected String	description
protected String	name
protected String	permission

Fields inherited from class com.datasiqn.commandcore.command.builder.CommandLink

children, executor, requires

Constructor Summary

Constructors

Constructor and Description
CommandBuilder(@NotNull String name) Creates a new CommandBuilder

Method Summary

Modifier and Type	Method and Description
CommandBuilder	alias(String... aliases) Sets the command's aliases
@NotNull Command	build() Creates a new Command instance using the supplied values
CommandBuilder	description(@Nullable String description) Sets the description of the command
protected @NotNull CommandBuilder	getThis()
CommandBuilder	permission(@Nullable String permission) Sets the permission of the command

Methods inherited from class com.datasiqn.commandcore.command.builder.CommandLink

executes, getChildren, getExecutor, requires, requiresBlock, requiresEntity, requiresLocatable, requiresPlayer, then

Methods inherited from class java.lang.Object

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

Field Detail

name

protected final String name

permission

protected String permission

description

protected String description

aliases

protected String[] aliases

Constructor Detail

CommandBuilder

public CommandBuilder(@NotNull
                      @NotNull String name)

Creates a new CommandBuilder

Parameters:

name - The name of the command

Method Detail

permission

public CommandBuilder permission(@Nullable
                                 @Nullable String permission)

Sets the permission of the command

Parameters:

permission - The permission

Returns:

The builder, for chaining

description

public CommandBuilder description(@Nullable
                                  @Nullable String description)

Sets the description of the command

Parameters:

description - The description

Returns:

The builder, for chaining

alias

public CommandBuilder alias(@NotNull
                            String... aliases)

Sets the command's aliases

Parameters:

aliases - The aliases

Returns:

The builder, for chaining

build

@NotNull
public @NotNull Command build()

Creates a new Command instance using the supplied values

Returns:

The built Command instance

getThis

@NotNull
protected @NotNull CommandBuilder getThis()

Specified by:

getThis in class CommandLink<CommandBuilder>