com.datasiqn.commandcore.command.builder

Class ArgumentBuilder<T>

java.lang.Object

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

com.datasiqn.commandcore.command.builder.CommandNode<ArgumentBuilder<T>>

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

Type Parameters:

T - The type of the argument

public class ArgumentBuilder<T>
extends CommandNode<ArgumentBuilder<T>>

Represents an argument node

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

Method Summary

Modifier and Type	Method and Description
static <T> @NotNull ArgumentBuilder<T>	argument(ArgumentType<T> type, String argName) Creates a new ArgumentBuilder
protected boolean	canBeOptional()
protected int	getPriority()
@NotNull List<String>	getTabComplete(@NotNull CommandContext context) Gets the tabcomplete for this node
protected @NotNull ArgumentBuilder<T>	getThis()
protected String	getUsageArgument(boolean isOptional)
@NotNull com.datasiqn.resultapi.Result<T,String>	parse(ArgumentReader reader) Attempts to parse a string
String	toString()

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

executeWith, getComparator, getUsages

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, wait, wait, wait

Method Detail

getTabComplete

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

Description copied from class: CommandNode

Gets the tabcomplete for this node

Specified by:

getTabComplete in class CommandNode<ArgumentBuilder<T>>

Parameters:

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

Returns:

The tabcomplete

parse

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

Description copied from class: CommandNode

Attempts to parse a string

Specified by:

parse in class CommandNode<ArgumentBuilder<T>>

Parameters:

reader - The reader to parse

Returns:

The result of the parsing

toString

public String toString()

Overrides:

toString in class Object

getUsageArgument

protected String getUsageArgument(boolean isOptional)

Specified by:

getUsageArgument in class CommandNode<ArgumentBuilder<T>>

getPriority

protected int getPriority()

Overrides:

getPriority in class CommandNode<ArgumentBuilder<T>>

canBeOptional

protected boolean canBeOptional()

Overrides:

canBeOptional in class CommandNode<ArgumentBuilder<T>>

getThis

@NotNull
protected @NotNull ArgumentBuilder<T> getThis()

Specified by:

getThis in class CommandLink<CommandNode<ArgumentBuilder<T>>>

argument

@Contract(value="_, _ -> new")
 @NotNull
public static <T> @NotNull ArgumentBuilder<T> argument(ArgumentType<T> type,
                                                                                                  String argName)

Creates a new ArgumentBuilder

Type Parameters:

T - The type of the argument

Parameters:

type - The argument type

argName - The name of the argument

Returns:

The created ArgumentBuilder instance