com.datasiqn.commandcore.command.builder

Class CommandNode<This extends CommandNode<This>>

java.lang.Object

com.datasiqn.commandcore.command.builder.CommandLink<CommandNode<This>>

com.datasiqn.commandcore.command.builder.CommandNode<This>

Type Parameters:

This - The type of the extended class

Direct Known Subclasses:

ArgumentBuilder, LiteralBuilder

public abstract class CommandNode<This extends CommandNode<This>>
extends CommandLink<CommandNode<This>>

Represents a node that can be added onto a command

Nested Class Summary

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

CommandLink.Executor, CommandLink.Requirement

Field Summary

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

children, executor, requires

Constructor Summary

Constructors

Constructor and Description
CommandNode()

Method Summary

Modifier and Type	Method and Description
protected boolean	canBeOptional()
@NotNull com.datasiqn.resultapi.Result<com.datasiqn.resultapi.None,String>	executeWith(CommandContext context) Executes this node
static Comparator<CommandNode<?>>	getComparator() Gets the comparator for command nodes
protected int	getPriority()
abstract @NotNull List<String>	getTabComplete(@NotNull CommandContext context) Gets the tabcomplete for this node
protected abstract String	getUsageArgument(boolean isOptional)
protected List<String>	getUsages(boolean isOptional)
abstract @NotNull com.datasiqn.resultapi.Result<?,String>	parse(ArgumentReader reader) Attempts to parse a string

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

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

Methods inherited from class java.lang.Object

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

Constructor Detail

CommandNode

public CommandNode()

Method Detail

executeWith

@NotNull
public final @NotNull com.datasiqn.resultapi.Result<com.datasiqn.resultapi.None,String> executeWith(CommandContext context)

Executes this node

Parameters:

context - The context in which the command was executed

Returns:

The result of the execution

Throws:

IllegalStateException - If there's no executor for this CommandNode

getTabComplete

@NotNull
public abstract @NotNull List<String> getTabComplete(@NotNull
                                                               @NotNull CommandContext context)

Gets the tabcomplete for this node

Parameters:

context - The context in which the tab complete is being requested

Returns:

The tabcomplete

parse

@NotNull
public abstract @NotNull com.datasiqn.resultapi.Result<?,String> parse(ArgumentReader reader)

Attempts to parse a string

Parameters:

reader - The reader to parse

Returns:

The result of the parsing

getUsages

protected List<String> getUsages(boolean isOptional)

getPriority

protected int getPriority()

getUsageArgument

protected abstract String getUsageArgument(boolean isOptional)

canBeOptional

protected boolean canBeOptional()

getComparator

public static Comparator<CommandNode<?>> getComparator()

Gets the comparator for command nodes

Returns:

The comparator