main.java.com.djrapitops.plan.command

Class SubCommand

java.lang.Object

main.java.com.djrapitops.plan.command.SubCommand

Direct Known Subclasses:

AnalyzeCommand, HelpCommand, InfoCommand, InspectCommand, ManageBackupCommand, ManageClearCommand, ManageCommand, ManageHelpCommand, ManageHotswapCommand, ManageImportCommand, ManageMoveCommand, ManageRemoveCommand, ManageRestoreCommand, ManageStatusCommand, QuickAnalyzeCommand, QuickInspectCommand, ReloadCommand, SearchCommand

public abstract class SubCommand
extends Object

Abstract subcommand class that stores all the required information of a command.

Since:

1.0.0

Author:

Rsl1122

Constructor Summary

Constructors

Constructor and Description
SubCommand(String name, Permissions permission, String usage, CommandType commandType, String arguments) Class constructor, called with super(...) in subcommands.

Method Summary

Modifier and Type	Method and Description
String	getArguments() Used to get a string format of required arguments.
CommandType	getCommandType() Used to get the command type.
String	getFirstName() Used to get the first alias.
String	getName() Used to get all aliases.
Permissions	getPermission() Used to get the permission required by the command.
String	getUsage() Used to get the info about usage of the command.
abstract boolean	onCommand(org.bukkit.command.CommandSender sender, org.bukkit.command.Command cmd, String commandLabel, String[] args) The Command Execution method.

Methods inherited from class java.lang.Object

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

Constructor Detail

SubCommand

public SubCommand(String name,
                  Permissions permission,
                  String usage,
                  CommandType commandType,
                  String arguments)

Class constructor, called with super(...) in subcommands.

Parameters:

name - Name(s) (aliases) of the command

permission - Required permission

usage - Usage information

commandType - Type Enum

arguments - Additional possible arguments the command requires

Method Detail

getArguments

public String getArguments()

Used to get a string format of required arguments.

Returns:

Additional possible arguments the command requires

getFirstName

public String getFirstName()

Used to get the first alias.

Returns:

First alias of the command

getName

public String getName()

Used to get all aliases.

Returns:

All aliases separated with ','

getPermission

public Permissions getPermission()

Used to get the permission required by the command.

Returns:

Required permission

getUsage

public String getUsage()

Used to get the info about usage of the command.

Returns:

Usage information

getCommandType

public CommandType getCommandType()

Used to get the command type.

Returns:

CommandType Enum.

onCommand

public abstract boolean onCommand(org.bukkit.command.CommandSender sender,
                                  org.bukkit.command.Command cmd,
                                  String commandLabel,
                                  String[] args)

The Command Execution method.

Parameters:

sender - Parameter of onCommand in CommandExecutor.

cmd - Parameter of onCommand in CommandExecutor.

commandLabel - Parameter of onCommand in CommandExecutor.

args - Parameter of onCommand in CommandExecutor.

Returns:

Was the execution successful?

See Also:

CommandExecutor