Package dev.polv.taleapi.command

Class CommandNode.ArgumentNode<V>

java.lang.Object

dev.polv.taleapi.command.CommandNode<CommandNode.ArgumentNode<V>>

dev.polv.taleapi.command.CommandNode.ArgumentNode<V>

Type Parameters:

V - the parsed value type

Enclosing class:

CommandNode<T extends CommandNode<T>>

public static class CommandNode.ArgumentNode<V>
extends CommandNode<CommandNode.ArgumentNode<V>>

An argument command node that parses typed input.

Arguments have a name used to retrieve parsed values and a type that defines how to parse input.

Nested Class Summary

Nested classes/interfaces inherited from class dev.polv.taleapi.command.CommandNode

CommandNode.ArgumentNode<V>, CommandNode.LiteralNode

Field Summary

Fields inherited from class dev.polv.taleapi.command.CommandNode

children, executor, name, requirement

Constructor Summary

Constructors

Constructor	Description
ArgumentNode(String name, ArgumentType<V> type)	Creates a new argument node with the given name and type.

Method Summary

Modifier and Type	Method	Description
SuggestionProvider	getSuggestionProvider()	Returns the custom suggestion provider, if any.
ArgumentType<V>	getType()	Returns the argument type.
String	getUsageText()	Returns the usage string for this node.
CompletableFuture<Suggestions>	listSuggestions(CommandContext context, SuggestionsBuilder builder)	Provides suggestions for autocompletion.
CommandNode.ArgumentNode<V>	suggests(SuggestionProvider provider)	Sets a custom suggestion provider for this argument.
String	toString()

Methods inherited from class dev.polv.taleapi.command.CommandNode

argument, canUse, executes, getChildren, getExecutor, getName, getRequirement, isExecutable, literal, requires, requires, then

Methods inherited from class java.lang.Object

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

Constructor Details

ArgumentNode

public ArgumentNode(String name,
 ArgumentType<V> type)

Creates a new argument node with the given name and type.

Parameters:

name - the name of this argument node

type - the argument type for parsing

Method Details

getType

public ArgumentType<V> getType()

Returns the argument type.

Returns:

the type

getSuggestionProvider

public SuggestionProvider getSuggestionProvider()

Returns the custom suggestion provider, if any.

Returns:

the suggestion provider, or null

suggests

public CommandNode.ArgumentNode<V> suggests(SuggestionProvider provider)

Sets a custom suggestion provider for this argument.

Parameters:

provider - the suggestion provider

Returns:

this node for chaining

getUsageText

public String getUsageText()

Description copied from class: CommandNode

Returns the usage string for this node.

Specified by:

getUsageText in class CommandNode<CommandNode.ArgumentNode<V>>

Returns:

the usage representation

listSuggestions

public CompletableFuture<Suggestions> listSuggestions(CommandContext context,
 SuggestionsBuilder builder)

Description copied from class: CommandNode

Provides suggestions for autocompletion.

Specified by:

listSuggestions in class CommandNode<CommandNode.ArgumentNode<V>>

Parameters:

context - the command context

builder - the suggestions builder

Returns:

a future with suggestions

toString

public String toString()

Overrides:

toString in class Object