Index (squirtgun-commands 2.0.0-pre2 API)

A B C D E G H I L M N O P S T
All Classes|All Packages

A

AbstractArgument<T> - Class in me.lucyy.squirtgun.command.argument: An abstract argument, encapsulating the name and description fields.
AbstractArgument(String, String, boolean) - Constructor for class me.lucyy.squirtgun.command.argument.AbstractArgument
arguments(CommandArgument<?>...) - Method in class me.lucyy.squirtgun.command.node.NodeBuilder: Adds arguments to this node.

B

build() - Method in class me.lucyy.squirtgun.command.node.NodeBuilder: Builds this node, throwing a NullPointerException if an argument is incorrect or missing.

C

CommandArgument<T> - Interface in me.lucyy.squirtgun.command.argument: An argument.
CommandContext<T extends me.lucyy.squirtgun.platform.PermissionHolder> - Interface in me.lucyy.squirtgun.command.context: The context a command is executed in, responsible for parsin, tab-completing and executing the command.
CommandNode<T extends me.lucyy.squirtgun.platform.PermissionHolder> - Interface in me.lucyy.squirtgun.command.node: A node as part of a command chain.

D

description(String) - Method in class me.lucyy.squirtgun.command.node.NodeBuilder: Sets this node's description.

E

execute() - Method in interface me.lucyy.squirtgun.command.context.CommandContext: Executes the command.
execute() - Method in class me.lucyy.squirtgun.command.context.StringContext
execute(CommandContext<T>) - Method in interface me.lucyy.squirtgun.command.node.CommandNode: Execute this node.
execute(CommandContext<T>) - Method in class me.lucyy.squirtgun.command.node.HelpNode
execute(CommandContext<T>) - Method in class me.lucyy.squirtgun.command.node.PluginInfoNode
execute(CommandContext<T>) - Method in class me.lucyy.squirtgun.command.node.SubcommandHelpNode
execute(CommandContext<T>) - Method in class me.lucyy.squirtgun.command.node.SubcommandNode
executes(Function<CommandContext<T>, Component>) - Method in class me.lucyy.squirtgun.command.node.NodeBuilder: Sets the function to execute this node.

G

getArguments() - Method in interface me.lucyy.squirtgun.command.node.CommandNode: Gets this command's arguments.
getArguments() - Method in class me.lucyy.squirtgun.command.node.HelpNode
getArguments() - Method in class me.lucyy.squirtgun.command.node.SubcommandHelpNode
getArguments() - Method in class me.lucyy.squirtgun.command.node.SubcommandNode
getArgumentValue(String) - Method in interface me.lucyy.squirtgun.command.context.CommandContext: Gets the value of an argument by name.
getArgumentValue(String) - Method in class me.lucyy.squirtgun.command.context.StringContext
getArgumentValue(CommandArgument<U>) - Method in interface me.lucyy.squirtgun.command.context.CommandContext: Gets the value of an argument.
getArgumentValue(CommandArgument<U>) - Method in class me.lucyy.squirtgun.command.context.StringContext
getDescription() - Method in class me.lucyy.squirtgun.command.argument.AbstractArgument
getDescription() - Method in interface me.lucyy.squirtgun.command.argument.CommandArgument: Gets this argument's description for use in help commands.
getDescription() - Method in interface me.lucyy.squirtgun.command.node.CommandNode: Gets this node's description for use in help commands.
getDescription() - Method in class me.lucyy.squirtgun.command.node.HelpNode
getDescription() - Method in class me.lucyy.squirtgun.command.node.PluginInfoNode
getDescription() - Method in class me.lucyy.squirtgun.command.node.SubcommandHelpNode
getDescription() - Method in class me.lucyy.squirtgun.command.node.SubcommandNode
getFormat() - Method in interface me.lucyy.squirtgun.command.context.CommandContext: Gets the format provider to use in message decoration.
getFormat() - Method in class me.lucyy.squirtgun.command.context.StringContext
getName() - Method in class me.lucyy.squirtgun.command.argument.AbstractArgument
getName() - Method in interface me.lucyy.squirtgun.command.argument.CommandArgument: Gets this argument's name.
getName() - Method in interface me.lucyy.squirtgun.command.node.CommandNode: Gets this node's name, which will be used as a literal if needed.
getName() - Method in class me.lucyy.squirtgun.command.node.HelpNode
getName() - Method in class me.lucyy.squirtgun.command.node.PluginInfoNode
getName() - Method in class me.lucyy.squirtgun.command.node.SubcommandHelpNode
getName() - Method in class me.lucyy.squirtgun.command.node.SubcommandNode
getNodes() - Method in class me.lucyy.squirtgun.command.node.SubcommandNode: Gets the child nodes that this node holds.
getPermission() - Method in interface me.lucyy.squirtgun.command.node.CommandNode: Gets the permission needed to execute this node or any children.
getPermission() - Method in class me.lucyy.squirtgun.command.node.SubcommandNode
getRaw() - Method in interface me.lucyy.squirtgun.command.context.CommandContext: Gets the raw input given to this context.
getRaw() - Method in class me.lucyy.squirtgun.command.context.StringContext
getTail() - Method in interface me.lucyy.squirtgun.command.context.CommandContext: Gets the last node in the chain that has been reached.
getTail() - Method in class me.lucyy.squirtgun.command.context.StringContext
getTarget() - Method in interface me.lucyy.squirtgun.command.context.CommandContext: Gets this command context's target.
getTarget() - Method in class me.lucyy.squirtgun.command.context.StringContext
getValue(Queue<String>) - Method in interface me.lucyy.squirtgun.command.argument.CommandArgument: Reads from a queue to get the value for this argument.
getValue(Queue<String>) - Method in class me.lucyy.squirtgun.command.argument.GreedyStringArgument
getValue(Queue<String>) - Method in class me.lucyy.squirtgun.command.argument.ListArgument
getValue(Queue<String>) - Method in class me.lucyy.squirtgun.command.argument.OnlinePlayerArgument
getValue(Queue<String>) - Method in class me.lucyy.squirtgun.command.argument.SingleWordArgument
GreedyStringArgument - Class in me.lucyy.squirtgun.command.argument: An argument that consumes all the available arguments.
GreedyStringArgument(String, String, boolean) - Constructor for class me.lucyy.squirtgun.command.argument.GreedyStringArgument

H

HelpNode<T extends me.lucyy.squirtgun.platform.PermissionHolder> - Class in me.lucyy.squirtgun.command.node: A command node that shows a help screen for another node that shows its description, usage, and argument information.
HelpNode(CommandNode<?>) - Constructor for class me.lucyy.squirtgun.command.node.HelpNode

I

isOptional() - Method in class me.lucyy.squirtgun.command.argument.AbstractArgument
isOptional() - Method in interface me.lucyy.squirtgun.command.argument.CommandArgument: Gets whether this argument is optional or not.

L

ListArgument - Class in me.lucyy.squirtgun.command.argument: An argument that accepts a single string from a list.
ListArgument(String, String, boolean, List<String>) - Constructor for class me.lucyy.squirtgun.command.argument.ListArgument

M

me.lucyy.squirtgun.command.argument - package me.lucyy.squirtgun.command.argument
me.lucyy.squirtgun.command.context - package me.lucyy.squirtgun.command.context
me.lucyy.squirtgun.command.node - package me.lucyy.squirtgun.command.node

N

name(String) - Method in class me.lucyy.squirtgun.command.node.NodeBuilder: Sets this node's name.
next(CommandNode<T>) - Method in class me.lucyy.squirtgun.command.node.NodeBuilder: Sets the next node in the chain.
next(CommandContext<T>) - Method in interface me.lucyy.squirtgun.command.node.CommandNode: Returns the node following this node.
next(CommandContext<T>) - Method in class me.lucyy.squirtgun.command.node.SubcommandHelpNode
next(CommandContext<T>) - Method in class me.lucyy.squirtgun.command.node.SubcommandNode
NodeBuilder<T extends me.lucyy.squirtgun.platform.PermissionHolder> - Class in me.lucyy.squirtgun.command.node: A builder to build a node.
NodeBuilder() - Constructor for class me.lucyy.squirtgun.command.node.NodeBuilder

O

OnlinePlayerArgument - Class in me.lucyy.squirtgun.command.argument: An argument that gets a player.
OnlinePlayerArgument(String, String, boolean, Platform) - Constructor for class me.lucyy.squirtgun.command.argument.OnlinePlayerArgument

P

permission(String) - Method in class me.lucyy.squirtgun.command.node.NodeBuilder: Sets this node's required permission.
PluginInfoNode<T extends me.lucyy.squirtgun.platform.PermissionHolder> - Class in me.lucyy.squirtgun.command.node
PluginInfoNode(String, Platform) - Constructor for class me.lucyy.squirtgun.command.node.PluginInfoNode

S

SingleWordArgument - Class in me.lucyy.squirtgun.command.argument: An argument that accepts a single word.
SingleWordArgument(String, String, boolean) - Constructor for class me.lucyy.squirtgun.command.argument.SingleWordArgument
StringContext<T extends me.lucyy.squirtgun.platform.PermissionHolder> - Class in me.lucyy.squirtgun.command.context: A command context that parses a raw string.
StringContext(FormatProvider, T, CommandNode<T>, String) - Constructor for class me.lucyy.squirtgun.command.context.StringContext
SubcommandHelpNode<T extends me.lucyy.squirtgun.platform.PermissionHolder> - Class in me.lucyy.squirtgun.command.node: A help node for a subcommand.
SubcommandHelpNode(SubcommandNode<?>) - Constructor for class me.lucyy.squirtgun.command.node.SubcommandHelpNode
SubcommandNode<T extends me.lucyy.squirtgun.platform.PermissionHolder> - Class in me.lucyy.squirtgun.command.node: A node that tab completes and acts as a "splitter" for other nodes.
SubcommandNode(String, String, boolean, CommandNode<T>...) - Constructor for class me.lucyy.squirtgun.command.node.SubcommandNode

T

tabComplete() - Method in interface me.lucyy.squirtgun.command.context.CommandContext: Gets the string to be shown in the tabcompleter.
tabComplete() - Method in class me.lucyy.squirtgun.command.context.StringContext
tabComplete(Queue<String>) - Method in interface me.lucyy.squirtgun.command.argument.CommandArgument: Tab-completes this node.
tabComplete(Queue<String>) - Method in class me.lucyy.squirtgun.command.argument.GreedyStringArgument
tabComplete(Queue<String>) - Method in class me.lucyy.squirtgun.command.argument.ListArgument
tabComplete(Queue<String>) - Method in class me.lucyy.squirtgun.command.argument.OnlinePlayerArgument
tabComplete(Queue<String>) - Method in class me.lucyy.squirtgun.command.argument.SingleWordArgument
toString() - Method in class me.lucyy.squirtgun.command.argument.AbstractArgument

A B C D E G H I L M N O P S T
All Classes|All Packages