com.datasiqn.commandcore.command.builder

Class CommandLink<T>

java.lang.Object

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

Type Parameters:

T - The type of "This". It is returned every time a chaining method is called, allowing unique methods on the subclass to be called.

Direct Known Subclasses:

CommandBuilder, CommandNode

public abstract class CommandLink<T>
extends Object

Represents a link in a command tree. It shares many common methods that are all present in a CommandBuilder and a CommandNode.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	CommandLink.Executor A function that defines a command executor
static interface	CommandLink.Requirement A function that defines a command requirement.

Field Summary

Fields

Modifier and Type	Field and Description
protected List<CommandNode<?>>	children
protected CommandLink.Executor	executor
protected List<CommandLink.Requirement>	requires

Constructor Summary

Constructors

Constructor and Description
CommandLink()

Method Summary

Modifier and Type	Method and Description
T	executes(@NotNull CommandLink.Executor executor) Sets the executor for this command
@UnmodifiableView @NotNull List<CommandNode<?>>	getChildren() Gets all children nodes
CommandLink.Executor	getExecutor() Gets the executor
protected abstract T	getThis()
T	requires(@NotNull CommandLink.Requirement requirement) Requires the context in which the command is executed in to pass the requires check
T	requiresBlock() Requires the sender to be a BlockCommandSender
T	requiresEntity() Requires the sender to be an Entity
T	requiresLocatable() Requires the sender to be locatable
T	requiresPlayer() Requires the sender to be a Player
T	then(@NotNull CommandNode<?> node) Adds a new node onto this command builder

Methods inherited from class java.lang.Object

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

Field Detail

children

protected final List<CommandNode<?>> children

requires

protected final List<CommandLink.Requirement> requires

executor

protected CommandLink.Executor executor

Constructor Detail

CommandLink

public CommandLink()

Method Detail

requires

public T requires(@NotNull
                  @NotNull CommandLink.Requirement requirement)

Requires the context in which the command is executed in to pass the requires check

Parameters:

requirement - A function that determines if a CommandContext can run the command

Returns:

Itself, for chaining

requiresPlayer

public T requiresPlayer()

Requires the sender to be a Player

Returns:

Itself, for chaining

See Also:

requires(Requirement)

requiresEntity

public T requiresEntity()

Requires the sender to be an Entity

Returns:

Itself, for chaining

See Also:

requires(Requirement)

requiresBlock

public T requiresBlock()

Requires the sender to be a BlockCommandSender

Returns:

Itself, for chaining

See Also:

requires(Requirement)

requiresLocatable

public T requiresLocatable()

Requires the sender to be locatable

Returns:

Itself, for chaining

See Also:

requires(Requirement)

then

public T then(@NotNull
              @NotNull CommandNode<?> node)

Adds a new node onto this command builder

Parameters:

node - The node

Returns:

The builder, for chaining

executes

public T executes(@NotNull
                  @NotNull CommandLink.Executor executor)

Sets the executor for this command

Parameters:

executor - The executor

Returns:

The builder, for chaining

getChildren

@NotNull
public @UnmodifiableView @NotNull List<CommandNode<?>> getChildren()

Gets all children nodes

Returns:

An unmodifiable view of all children nodes

getExecutor

public CommandLink.Executor getExecutor()

Gets the executor

Returns:

The executor

getThis

@NotNull
protected abstract T getThis()