com.codelanx.codelanxlib.command

Class HelpCommand<E extends Plugin>

java.lang.Object

com.codelanx.codelanxlib.command.CommandNode<E>

com.codelanx.codelanxlib.command.HelpCommand<E>

Type Parameters:

E - The Plugin that caused this class to be instantiated

All Implemented Interfaces:

Comparable<CommandNode<?>>, CommandExecutor, TabCompleter

public final class HelpCommand<E extends Plugin>
extends CommandNode<E>

Provides a listing of help information derived from all CommandNode objects that are returned from a call to a parent's CommandNode.traverse() method

Since:

0.0.1

Version:

0.1.0

Author:

1Rogue

Field Summary

Fields inherited from class com.codelanx.codelanxlib.command.CommandNode

plugin

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	HelpCommand(E plugin) HelpCommand constructor.

Method Summary

Modifier and Type	Method and Description
CommandStatus	execute(CommandSender sender, String... args) Displays help information from all linked child CommandNode nodes for the parent CommandNode relevant to this HelpCommand instance
int	getItemsPerPage() Returns the number of commands displayed per page
String	getName() Subcommand name: "help" Returns the name of the command, used for storing a HashMap of the commands as well as the subcommand argument
InternalLang	info() Information about this specific command.
void	setItemsPerPage(int factor) Sets the number of commands to show information for per page.
List<String>	tabComplete(CommandSender sender, String... args) Returns a List of possible strings that could be supplied for the next argument
String	usage() Describes the usage in the context of this specific CommandNode

Methods inherited from class com.codelanx.codelanxlib.command.CommandNode

addChild, addChild, alias, aliasAsBukkitCommand, attachReloadCommand, compareTo, disallowProxiedSenders, filterUsage, getAliases, getChild, getChild, getChildren, getClosestChild, getHelpOutput, getLinkingNode, getParent, getUsage, hasRestriction, isExecutable, minimumArguments, onCommand, onTabComplete, registerAsBukkitCommand, registerAsListener, requirePermission, setExecutable, setRestriction, toString, traverse

Methods inherited from class java.lang.Object

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

Constructor Detail

HelpCommand

protected HelpCommand(E plugin)

HelpCommand constructor.

Parameters:

plugin -

Since:

0.0.1

Method Detail

execute

public CommandStatus execute(CommandSender sender,
                             String... args)

Displays help information from all linked child CommandNode nodes for the parent CommandNode relevant to this HelpCommand instance

Specified by:

execute in class CommandNode<E extends Plugin>

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.0.1

tabComplete

public List<String> tabComplete(CommandSender sender,
                                String... args)

Returns a List of possible strings that could be supplied for the next argument

Specified by:

tabComplete in class CommandNode<E extends Plugin>

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

setItemsPerPage

public void setItemsPerPage(int factor)

Sets the number of commands to show information for per page. This will forcefully refresh the Paginator cache

Parameters:

factor - The number of commands per page

Since:

0.1.0

getItemsPerPage

public int getItemsPerPage()

Returns the number of commands displayed per page

Returns:

The number of commands shown per page

Since:

0.1.0

usage

public String usage()

Describes the usage in the context of this specific CommandNode

Overrides:

usage in class CommandNode<E extends Plugin>

Returns:

The usage, defaults to CommandNode.getName()

Since:

0.0.1

getName

public String getName()

Subcommand name: "help"

Returns the name of the command, used for storing a HashMap of the commands as well as the subcommand argument

Specified by:

getName in class CommandNode<E extends Plugin>

Returns:

The command's name

Since:

0.0.1

info

public InternalLang info()

Information about this specific command. Should be kept concise

Specified by:

info in class CommandNode<E extends Plugin>

Returns:

A small string about the command

Since:

0.0.1