com.datasiqn.commandcore.command.builder

Class LiteralBuilder

java.lang.Object

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

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

com.datasiqn.commandcore.command.builder.LiteralBuilder

public class LiteralBuilder
extends CommandNode<LiteralBuilder>

Represents a literal 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
protected int	getPriority()
@NotNull List<String>	getTabComplete(@NotNull CommandContext context) Gets the tabcomplete for this node
protected @NotNull LiteralBuilder	getThis()
protected String	getUsageArgument(boolean isOptional)
static @NotNull LiteralBuilder	literal(@NotNull String literal) Creates a new LiteralBuilder
@NotNull com.datasiqn.resultapi.Result<String,String>	parse(@NotNull ArgumentReader reader) Attempts to parse a string
String	toString()

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

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

parse

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

Description copied from class: CommandNode

Attempts to parse a string

Specified by:

parse in class CommandNode<LiteralBuilder>

Parameters:

reader - The reader to parse

Returns:

The result of the parsing

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<LiteralBuilder>

Parameters:

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

Returns:

The tabcomplete

toString

public String toString()

Overrides:

toString in class Object

getUsageArgument

protected String getUsageArgument(boolean isOptional)

Specified by:

getUsageArgument in class CommandNode<LiteralBuilder>

getPriority

protected int getPriority()

Overrides:

getPriority in class CommandNode<LiteralBuilder>

getThis

@NotNull
protected @NotNull LiteralBuilder getThis()

Specified by:

getThis in class CommandLink<CommandNode<LiteralBuilder>>

literal

@Contract(value="_ -> new")
 @NotNull
public static @NotNull LiteralBuilder literal(@NotNull
                                                                                      @NotNull String literal)

Creates a new LiteralBuilder

Parameters:

literal - The literal string. String cannot be empty or have spaces

Returns:

The created LiteralBuilder instance

Throws:

IllegalArgumentException - If the string is empty or contains spaces