com.codelanx.codelanxlib.command

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

java.lang.Object

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

Type Parameters:

E - Represents a Plugin that implements the Commandable interface

All Implemented Interfaces:

Comparable<SubCommand<E>>

Direct Known Subclasses:

HelpCommand, ReloadCommand

public abstract class SubCommand<E extends org.bukkit.plugin.Plugin>
extends Object
implements Comparable<SubCommand<E>>

Skeleton class representing the structure of a sub-command for CommandHandler

Note: this class has a natural ordering that is inconsistent with equals.

Since:

0.0.1

Version:

0.1.0

Author:

1Rogue

Field Summary

Fields

Modifier and Type	Field and Description
protected CommandHandler<E>	handler The CommandHandler responsible for this command
protected E	plugin The main Plugin instance

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
int	compareTo(SubCommand<E> o) Compares SubCommand objects by command name via getName() {inheritDoc}
abstract CommandStatus	execute(org.bukkit.command.CommandSender sender, String... args) Executes a relevant command grabbed from the CommandHandler.
abstract String	getName() 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
boolean	hasPermission(org.bukkit.command.CommandSender sender, String... tokens) Returns a permissions check for <plugin-name>.cmd.<subcommand-name>, can be nested into further permissions by passing tokens to append to the end of the permission string TODO: Figure out catch for multiple CommandHandlers
abstract Lang	info() Information about this specific command.
abstract 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 java.lang.Object

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

Field Detail

plugin

protected final E extends org.bukkit.plugin.Plugin plugin

The main Plugin instance

handler

protected final CommandHandler<E extends org.bukkit.plugin.Plugin> handler

The CommandHandler responsible for this command

Constructor Detail

SubCommand

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

SubCommand constructor

Parameters:

plugin - The Plugin associated with this command

handler - The CommandHandler responsible for this command

Since:

0.0.1

Method Detail

execute

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

Executes a relevant command grabbed from the CommandHandler.

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 abstract List<String> tabComplete(org.bukkit.command.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.0.1

getUsage

public String getUsage()

Returns the command usage

Returns:

Usage for this SubCommand

Since:

0.0.1

info

public abstract Lang info()

Information about this specific command. Should be kept concise

Returns:

A small string about the command

Since:

0.0.1

hasPermission

public boolean hasPermission(org.bukkit.command.CommandSender sender,
                             String... tokens)

Returns a permissions check for <plugin-name>.cmd.<subcommand-name>, can be nested into further permissions by passing tokens to append to the end of the permission string TODO: Figure out catch for multiple CommandHandlers

Parameters:

sender - The CommandSender executing this command

tokens - Any additional tokens to append to the end of the string

Returns:

true if they have permission, false otherwise

Since:

0.0.1

compareTo

public int compareTo(SubCommand<E> o)

Compares SubCommand objects by command name via getName()

{inheritDoc}

Specified by:

compareTo in interface Comparable<SubCommand<E extends org.bukkit.plugin.Plugin>>

Parameters:

o - The SubCommand to compare to

Returns:

Since:

0.1.0