CommandNode (CodelanxLib 0.2.0-SNAPSHOT API)

java.lang.Object
- com.codelanx.codelanxlib.command.CommandNode<E>

Type Parameters:

E - The type of the Plugin associated with this CommandNode

All Implemented Interfaces:

Comparable<CommandNode<?>>, CommandExecutor, TabCompleter

Direct Known Subclasses:

HelpCommand, ReloadCommand
```
public abstract class CommandNode<E extends Plugin>
extends Object
implements CommandExecutor, TabCompleter, Comparable<CommandNode<?>>
```
Represents a singular point in a command argument chain (or even the command itself)

Since:

0.1.0

Version:

0.2.0

Author:

1Rogue

Field Summary

Fields
Modifier and Type Field and Description

protected E plugin
The Plugin relevant to this CommandNode

Fields
Modifier and Type	Field and Description
`protected E`	`plugin` The `Plugin` relevant to this `CommandNode`

Constructor Summary

Constructors
Constructor and Description
`CommandNode(E plugin)` Initializes a new `CommandNode` with no parent object
`CommandNode(E plugin, CommandNode<?> parent)` Initializes a new `CommandNode` with the passed parent object.

Method Summary

All Methods Static Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addChild(CommandNode<? extends Plugin>... children)` Adds new child subcommands to this `CommandNode`
`void`	`addChild(Function<E,CommandNode<? extends Plugin>>... children)` Adds new child subcommands to this `CommandNode`
`<T extends Plugin> void`	`alias(CommandNode<T> toAlias, String... args)` Aliases a passed `CommandNode`.
`protected void`	`aliasAsBukkitCommand(String cmd)` Allows this `CommandNode` to be executed from Bukkit directly
`protected void`	`attachReloadCommand()` Attaches a `ReloadCommand` to this command object, to allow reloading of the `Plugin` relevant to this node
`int`	`compareTo(CommandNode<?> o)` Compares `CommandNode` objects by command name via `getName()`, or their parent objects if possible
`void`	`disallowProxiedSenders()` Disallows execution of this `CommandNode` by a ProxiedCommandSender
`abstract CommandStatus`	`execute(CommandSender sender, String... args)` Represents the code at the end of a `CommandNode` chain
`static String`	`filterUsage(String usageRaw)` Filters out "usage tags" such as `[tag]` or `<tag>`
`Map<String,CommandNode<? extends Plugin>>`	`getAliases()` Returns all `CommandNode` objects held by this node that are aliases of other `CommandNodes`
`CommandNode<? extends Plugin>`	`getChild(String... args)` Iteratively retrieves the child `CommandNode` down the command tree.
`CommandNode<? extends Plugin>`	`getChild(String name)` Returns a subcommand, or `null` if none exists.
`Collection<CommandNode<? extends Plugin>>`	`getChildren()` Returns all subcommands as a `Collection`
`CommandNode<? extends Plugin>`	`getClosestChild(String... args)` Returns the closest possible approximation of where the supplied argument ladder will stop.
`HelpCommand<?>`	`getHelpOutput()` Retrieves the help output for this `CommandNode`, in the form of a `HelpCommand` class
`static <T extends Plugin> CommandNode<T>`	`getLinkingNode(String command, T plugin, Consumer<CommandNode<T>> onConstruct)` Returns an anonymous `CommandNode` instance which is defined as non-executable `CommandNode` used for chaining together other `CommandNode` objects.
`abstract String`	`getName()` Returns the name of the command, used for storing a `HashMap` of the commands as well as the subcommand argument
`CommandNode<? extends Plugin>`	`getParent()` Returns the direct parent `CommandNode` for this node
`String`	`getUsage()` Returns the command usage
`boolean`	`hasRestriction()` Returns `true` if there is a restriction imposed upon this `CommandNode`
`abstract Lang`	`info()` Information about this specific command.
`boolean`	`isExecutable()` Returns whether or not this node can be directly executed
`void`	`minimumArguments(int minimum)` Sets the minimum number of arguments for this command
`boolean`	`onCommand(CommandSender sender, Command command, String label, String[] args)` Called from Bukkit to indicate an executed command
`List<String>`	`onTabComplete(CommandSender sender, Command command, String alias, String[] args)` Called from Bukkit to indicate a call for tab completing
`protected void`	`registerAsBukkitCommand()` Registers this `CommandNode` as a bukkit-executable command, and places this `CommandNode` as the command name
`protected void`	`registerAsListener()` Registers this class as a `Listener` to Bukkit, providing that this command node implements the `Listener` class
`protected void`	`requirePermission(Permissions perm)` Adds a `Permissions` requirement for any executors of this node
`protected void`	`setExecutable(boolean executable)` Sets whether or not this `CommandNode` can be executed.
`void`	`setRestriction(CommandStatus restriction)` Sets a restriction on this `CommandNode` so that it may only be executed by a particular type of `CommandSender`.
`protected abstract List<String>`	`tabComplete(CommandSender sender, String... args)` Returns a `List` of possible strings that could be supplied for the next argument
`String`	`toString()`
`Collection<CommandNode<? extends Plugin>>`	`traverse()` Traverses the `CommandNode` tree and returns all child objects found that satisfy the following: The child's parent is the class that maps to it (aliases will be mapped to, but will not have the mapping parent class as an actual parent).
`protected String`	`usage()` Describes the usage in the context of this specific `CommandNode`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Field Detail
  - plugin
```
protected final E extends Plugin plugin
```
    The Plugin relevant to this CommandNode
- Constructor Detail
  - CommandNode
```
public CommandNode(E plugin)
```
    Initializes a new CommandNode with no parent object
    
    Parameters:
    
    plugin - The Plugin relevant to this node
    
    Since:
    
    0.1.0
    
    See Also:
    
    CommandNode(Plugin, CommandNode)
  - CommandNode
```
public CommandNode(E plugin,
                   CommandNode<?> parent)
```
    Initializes a new CommandNode with the passed parent object. This also attaches a HelpCommand as a sub-command in order to automate help output
    
    Parameters:
    
    plugin - The Plugin relevant to this node
    
    parent - The parent CommandNode, or null for none
    
    Since:
    
    0.1.0
- Method Detail
  - onCommand
```
public final boolean onCommand(CommandSender sender,
                               Command command,
                               String label,
                               String[] args)
```
    Called from Bukkit to indicate an executed command
    
    Specified by:
    
    onCommand in interface CommandExecutor
    
    Parameters:
    
    sender -
    
    command -
    
    label -
    
    args -
    
    Returns:
    
    true if the returned CommandStatus was not a CommandStatus.FAILED
    
    Since:
    
    0.1.0
  - execute
```
public abstract CommandStatus execute(CommandSender sender,
                                      String... args)
```
    Represents the code at the end of a CommandNode chain
    
    Parameters:
    
    sender - The command executor
    
    args - The command arguments, starting after the subcommand name
    
    Returns:
    
    The CommandStatus representing the result of the command. This will throw an NPE if null is returned
    
    Since:
    
    0.1.0
  - onTabComplete
```
public final List<String> onTabComplete(CommandSender sender,
                                        Command command,
                                        String alias,
                                        String[] args)
```
    Called from Bukkit to indicate a call for tab completing
    
    Specified by:
    
    onTabComplete in interface TabCompleter
    
    Parameters:
    
    sender -
    
    command -
    
    alias -
    
    args -
    
    Returns:
    
    Since:
    
    0.1.0
  - tabComplete
```
protected abstract List<String> tabComplete(CommandSender sender,
                                            String... args)
```
    Returns a List of possible strings that could be supplied for the next argument
    
    Parameters:
    
    sender - The command "tabber"
    
    args - The command arguments, starting after the subcommand name and contains potentially unfinished arguments
    
    Returns:
    
    A List of strings that can be supplied for the next arg
    
    Since:
    
    0.1.0
  - getName
```
public abstract String getName()
```
    Returns the name of the command, used for storing a HashMap of the commands as well as the subcommand argument
    
    Returns:
    
    The command's name
    
    Since:
    
    0.1.0
  - getUsage
```
public final String getUsage()
```
    Returns the command usage
    
    Returns:
    
    Usage for this CommandNode
    
    Since:
    
    0.1.0
  - usage
```
protected String usage()
```
    Describes the usage in the context of this specific CommandNode
    
    Returns:
    
    The usage, defaults to getName()
    
    Since:
    
    0.1.0
  - info
```
public abstract Lang info()
```
    Information about this specific command. Should be kept concise
    
    Returns:
    
    A small string about the command
    
    Since:
    
    0.1.0
  - getParent
```
public final CommandNode<? extends Plugin> getParent()
```
    Returns the direct parent CommandNode for this node
    
    Returns:
    
    The parent of this node
    
    Since:
    
    0.1.0
  - addChild
```
public final void addChild(CommandNode<? extends Plugin>... children)
```
    Adds new child subcommands to this CommandNode
    
    Parameters:
    
    children - Any CommandNodes to add
    
    Since:
    
    0.1.0
  - addChild
```
@SafeVarargs
public final void addChild(Function<E,CommandNode<? extends Plugin>>... children)
```
    Adds new child subcommands to this CommandNode
    
    Parameters:
    
    children - Any CommandNodes to add
    
    Since:
    
    0.2.0
  - getChild
```
public final CommandNode<? extends Plugin> getChild(String name)
```
    Returns a subcommand, or null if none exists.
    
    Parameters:
    
    name - The name of the subcommand
    
    Returns:
    
    A relevant CommandNode, or null if it does not exist
    
    Since:
    
    0.1.0
  - getChild
```
public CommandNode<? extends Plugin> getChild(String... args)
```
    Iteratively retrieves the child CommandNode down the command tree. If at any point in the depth search a node does not exist, this will return null
    
    Parameters:
    
    args - The different CommandNode names to search through
    
    Returns:
    
    The child node, or null if not found
    
    Since:
    
    0.1.0
  - getClosestChild
```
public CommandNode<? extends Plugin> getClosestChild(String... args)
```
    Returns the closest possible approximation of where the supplied argument ladder will stop. As soon as the search reaches a nonexistent child child node, the parent node is returned, up to and including the original node this method is called upon
    
    Parameters:
    
    args - The argument ladder to climb through
    
    Returns:
    
    The closest CommandNode approximation found
    
    Since:
    
    0.1.0
  - getChildren
```
public final Collection<CommandNode<? extends Plugin>> getChildren()
```
    Returns all subcommands as a Collection
    
    Returns:
    
    A Collection of all registered CommandNode
    
    Since:
    
    0.0.1
  - compareTo
```
public final int compareTo(CommandNode<?> o)
```
    Compares CommandNode objects by command name via getName(), or their parent objects if possible
    
    Specified by:
    
    compareTo in interface Comparable<CommandNode<?>>
    
    Parameters:
    
    o - The CommandNode to compare to
    
    Returns:
    
    Since:
    
    0.1.0
  - traverse
```
public Collection<CommandNode<? extends Plugin>> traverse()
```
    Traverses the CommandNode tree and returns all child objects found that satisfy the following:
    - The child's parent is the class that maps to it (aliases will be mapped to, but will not have the mapping parent class as an actual parent).
    - The node is not a HelpCommand
    - The value of the node's isExecutable() is true
    Returns:
    
    All found CommandNode children for this node
    
    Since:
    
    0.1.0
  - getAliases
```
public final Map<String,CommandNode<? extends Plugin>> getAliases()
```
    Returns all CommandNode objects held by this node that are aliases of other CommandNodes
    
    Returns:
    
    Any aliased CommandNode objects
    
    Since:
    
    0.1.0
  - attachReloadCommand
```
protected final void attachReloadCommand()
```
    Attaches a ReloadCommand to this command object, to allow reloading of the Plugin relevant to this node
    
    Since:
    
    0.1.0
  - setExecutable
```
protected final void setExecutable(boolean executable)
```
    Sets whether or not this CommandNode can be executed. If this is set to false, then the returned value of execute(CommandSender, String...) should be CommandStatus.NOT_EXECUTABLE. Normally a call to this method can easily be supplemented by using getLinkingNode(String, Plugin, Consumer) instead.
    
    Parameters:
    
    executable - true if this node can be directly executed
    
    Since:
    
    0.1.0
    
    See Also:
    
    getLinkingNode(String, Plugin, Consumer)
  - requirePermission
```
protected final void requirePermission(Permissions perm)
```
    Adds a Permissions requirement for any executors of this node
    
    Parameters:
    
    perm - The Permissions requirement to add to this node
    
    Since:
    
    0.1.0
  - isExecutable
```
public final boolean isExecutable()
```
    Returns whether or not this node can be directly executed
    
    Returns:
    
    true if this node can be directly executed
    
    Since:
    
    0.1.0
  - minimumArguments
```
public final void minimumArguments(int minimum)
```
    Sets the minimum number of arguments for this command
    
    Parameters:
    
    minimum - The minimum number of arguments for this command
    
    Since:
    
    0.1.0
  - disallowProxiedSenders
```
public final void disallowProxiedSenders()
```
    Disallows execution of this CommandNode by a ProxiedCommandSender
    
    Since:
    
    0.1.0
  - setRestriction
```
public final void setRestriction(CommandStatus restriction)
```
    Sets a restriction on this CommandNode so that it may only be executed by a particular type of CommandSender. This method only allows the following types:
    Parameters:
    
    restriction - The CommandStatus type to restrict with
    
    Since:
    
    0.1.0
  - hasRestriction
```
public boolean hasRestriction()
```
    Returns true if there is a restriction imposed upon this CommandNode
    
    Returns:
    
    true if this CommandNode can only be executed by one type of sender
    
    Since:
    
    0.1.0
  - alias
```
public final <T extends Plugin> void alias(CommandNode<T> toAlias,
                                           String... args)
```
    Aliases a passed CommandNode. If no string arguments are supplied, the passed child node will be aliased under this parent node using the child's returned value from getName()
    
    If arguments are supplied, then this method will iterate down through child nodes until an appropriate node is found, and will then use the last argument as the alias for the passed child node. If any nodes do not exist when iterating through child nodes, this method will create them via getLinkingNode(String, Plugin, Consumer)
    
    Type Parameters:
    
    T - The type of the passed CommandNode alias's plugin
    
    Parameters:
    
    toAlias - The CommandNode to alias
    
    args - The arguments chaining from this node to the alias
    
    Since:
    
    0.1.0
  - aliasAsBukkitCommand
```
protected final void aliasAsBukkitCommand(String cmd)
```
    Allows this CommandNode to be executed from Bukkit directly
    
    Parameters:
    
    cmd - The command to register as under Bukkit
    
    Since:
    
    0.1.0
  - registerAsBukkitCommand
```
protected final void registerAsBukkitCommand()
```
    Registers this CommandNode as a bukkit-executable command, and places this CommandNode as the command name
    
    Since:
    
    0.1.0
  - registerAsListener
```
protected final void registerAsListener()
```
    Registers this class as a Listener to Bukkit, providing that this command node implements the Listener class
    
    Since:
    
    0.2.0
  - getLinkingNode
```
public static <T extends Plugin> CommandNode<T> getLinkingNode(String command,
                                                               T plugin,
                                                               Consumer<CommandNode<T>> onConstruct)
```
    Returns an anonymous CommandNode instance which is defined as non-executable CommandNode used for chaining together other CommandNode objects.
    
    Type Parameters:
    
    T - The type of the Plugin relevant to the new node
    
    Parameters:
    
    command - The value for getName()
    
    plugin - The relevant Plugin to this new node
    
    onConstruct - Code to execute upon construction of the object, can be null
    
    Returns:
    
    The newly created CommandNode object
    
    Since:
    
    0.1.0
  - filterUsage
```
public static String filterUsage(String usageRaw)
```
    Filters out "usage tags" such as [tag] or <tag>
    
    Parameters:
    
    usageRaw - The raw usage string to modify
    
    Returns:
    
    The newly formatted usage string
    
    Since:
    
    0.1.0
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
  - getHelpOutput
```
public HelpCommand<?> getHelpOutput()
```
    Retrieves the help output for this CommandNode, in the form of a HelpCommand class
    
    Returns:
    
    The HelpCommand attached to this node
    
    Since:
    
    0.1.0

Class CommandNode<E extends Plugin>

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

plugin

Constructor Detail

CommandNode

CommandNode

Method Detail

onCommand

execute

onTabComplete

tabComplete

getName

getUsage

usage

info

getParent

addChild

addChild

getChild

getChild

getClosestChild

getChildren

compareTo

traverse

getAliases

attachReloadCommand

setExecutable

requirePermission

isExecutable

minimumArguments

disallowProxiedSenders

setRestriction

hasRestriction

alias

aliasAsBukkitCommand

registerAsBukkitCommand

registerAsListener

getLinkingNode

filterUsage

toString

getHelpOutput