com.djrapitops.plugin.command

Class TreeCommand<T extends IPlugin>

java.lang.Object

com.djrapitops.plugin.command.SubCommand

com.djrapitops.plugin.command.TreeCommand<T>

Type Parameters:

T - IPlugin implementation type.

public abstract class TreeCommand<T extends IPlugin>
extends SubCommand

Abstract class for any command that has multiple subcommands.

Since:

2.0.0

Author:

Rsl1122

Field Summary

Fields

Modifier and Type	Field and Description
protected T	plugin

Constructor Summary

Constructors

Constructor and Description
TreeCommand(T plugin, String name, CommandType type, String permission, String usage, String helpPrefix)
TreeCommand(T plugin, SubCommand values, String helpPrefix) Class Constructor.

Method Summary

Modifier and Type	Method and Description
void	add(SubCommand... commands)
abstract void	addCommands()
ColorScheme	getColorScheme()
SubCommand	getCommand(String name) Checks SubCommands for matching aliases.
List<SubCommand>	getCommands() Used to get the list of all subcommands.
String	getHelpCmd()
boolean	onCommand(ISender sender, String commandLabel, String[] args) Checks if Sender has rights to run the command and executes matching subcommand.
TreeCommand<T>	setColorScheme(ColorScheme cs)
void	setDefaultCommand(String defaultCommand)

Methods inherited from class com.djrapitops.plugin.command.SubCommand

addHelp, getArguments, getCommandType, getFirstName, getInDepthHelp, getName, getPermission, getUsage, hasPermission, setInDepthHelp

Methods inherited from class java.lang.Object

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

Field Detail

plugin

protected final T extends IPlugin plugin

Constructor Detail

TreeCommand

public TreeCommand(T plugin,
                   SubCommand values,
                   String helpPrefix)

Class Constructor.

Parameters:

plugin - Current instance

values -

helpPrefix -

TreeCommand

public TreeCommand(T plugin,
                   String name,
                   CommandType type,
                   String permission,
                   String usage,
                   String helpPrefix)

Method Detail

setDefaultCommand

public void setDefaultCommand(String defaultCommand)

add

public void add(SubCommand... commands)

addCommands

public abstract void addCommands()

getCommands

public List<SubCommand> getCommands()

Used to get the list of all subcommands.

Returns:

Initialized SubCommands

getCommand

public SubCommand getCommand(String name)

Checks SubCommands for matching aliases.

Parameters:

name - SubCommand in text form that might match alias.

Returns:

SubCommand, null if no match.

onCommand

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

Checks if Sender has rights to run the command and executes matching subcommand.

Specified by:

onCommand in class SubCommand

Parameters:

sender - source of the command.

commandLabel - label.

args - arguments of the command

Returns:

true

getHelpCmd

public String getHelpCmd()

getColorScheme

public ColorScheme getColorScheme()

setColorScheme

public TreeCommand<T> setColorScheme(ColorScheme cs)