com.codelanx.codelanxlib.command

Class HelpCommand<E extends org.bukkit.plugin.Plugin>

java.lang.Object

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

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

Type Parameters:

E - Represents a Plugin that implements the Commandable interface

All Implemented Interfaces:

Comparable<SubCommand<E>>

public final class HelpCommand<E extends org.bukkit.plugin.Plugin>
extends SubCommand<E>

Displays help information.

Since:

0.0.1

Version:

0.1.0

Author:

1Rogue

Field Summary

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

handler, plugin

Constructor Summary

Constructors

Constructor and Description
HelpCommand(E plugin, CommandHandler<E> handler) HelpCommand constructor.

Method Summary

Modifier and Type	Method and Description
CommandStatus	execute(org.bukkit.command.CommandSender sender, String... args) Displays help information about the various commands registered to and available from the CommandHandler instance that instantiated this class.
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
String	getUsage() Returns the command usage
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(org.bukkit.command.CommandSender sender, String... args) Returns a List of possible strings that could be supplied for the next argument

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

compareTo, hasPermission

Methods inherited from class java.lang.Object

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

Constructor Detail

HelpCommand

public HelpCommand(E plugin,
                   CommandHandler<E> handler)

HelpCommand constructor.

Parameters:

plugin -

handler -

Since:

0.0.1

Method Detail

execute

public CommandStatus execute(org.bukkit.command.CommandSender sender,
                             String... args)

Displays help information about the various commands registered to and available from the CommandHandler instance that instantiated this class.

Specified by:

execute in class SubCommand<E extends org.bukkit.plugin.Plugin>

Parameters:

sender - The command executor

args - The command arguments, starting after the subcommand name

Returns:

The CommandStatus representing the result of the command

Since:

0.0.1

tabComplete

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

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

Specified by:

tabComplete in class SubCommand<E extends org.bukkit.plugin.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

getUsage

public String getUsage()

Returns the command usage

Overrides:

getUsage in class SubCommand<E extends org.bukkit.plugin.Plugin>

Returns:

Usage for this SubCommand

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 SubCommand<E extends org.bukkit.plugin.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 SubCommand<E extends org.bukkit.plugin.Plugin>

Returns:

A small string about the command

Since:

0.0.1