com.djrapitops.plugin.command

Class SubCommand

java.lang.Object

com.djrapitops.plugin.command.SubCommand

Direct Known Subclasses:

StatusCommand, TreeCommand

public abstract class SubCommand
extends Object

Abstract class for any command that implements a functionality.

Since:

2.0.0

Author:

Rsl1122

Constructor Summary

Constructors

Constructor and Description
SubCommand(String name, CommandType type)
SubCommand(String name, CommandType type, String permission)
SubCommand(String name, CommandType type, String permission, String usage)
SubCommand(String name, CommandType type, String permission, String usage, String arguments)

Method Summary

Modifier and Type	Method and Description
String[]	addHelp() Override this method to automatically set the In depth help
String	getArguments()
CommandType	getCommandType()
String	getFirstName()
String[]	getInDepthHelp()
String	getName()
String	getPermission()
String	getUsage()
boolean	hasPermission(ISender sender)
abstract boolean	onCommand(ISender sender, String commandLabel, String[] args)
void	setInDepthHelp(String[] inDepthHelp)

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,
                  CommandType type,
                  String permission,
                  String usage,
                  String arguments)

SubCommand

public SubCommand(String name,
                  CommandType type)

SubCommand

public SubCommand(String name,
                  CommandType type,
                  String permission)

SubCommand

public SubCommand(String name,
                  CommandType type,
                  String permission,
                  String usage)

Method Detail

onCommand

public abstract boolean onCommand(ISender sender,
                                  String commandLabel,
                                  String[] args)

getCommandType

public CommandType getCommandType()

hasPermission

public boolean hasPermission(ISender sender)

getName

public String getName()

getFirstName

public String getFirstName()

getPermission

public String getPermission()

getUsage

public String getUsage()

getArguments

public String getArguments()

getInDepthHelp

public String[] getInDepthHelp()

addHelp

public String[] addHelp()

Override this method to automatically set the In depth help

Returns:

Lines of In Depth help.

setInDepthHelp

public void setInDepthHelp(String[] inDepthHelp)