Package me.efekos.simpler.commands

Class SubCommand

java.lang.Object

org.bukkit.command.Command

me.efekos.simpler.commands.BaseCommand

me.efekos.simpler.commands.SubCommand

public abstract class SubCommand
extends BaseCommand

Used to make sub commands for CoreCommands. Extend this class to make your own sub commands. Must be annotated with Command to work properly.

Field Summary

Fields inherited from class org.bukkit.command.Command

description, timings, usageMessage

Constructor Summary

Constructors

Constructor	Description
SubCommand(@NotNull String name)	Creates an instance of this command.
SubCommand(@NotNull String name, @NotNull String description, @NotNull String usageMessage, @NotNull List<String> aliases)	Creates an instance of this command.

Method Summary

Modifier and Type	Method	Description
abstract Class<? extends CoreCommand>	getParent()	Returns the parent of this SubCommand.
@NotNull String	getUsage()	Generates a usage using the BaseCommand.getSyntax().

Methods inherited from class me.efekos.simpler.commands.BaseCommand

execute, getDescription, getName, getPermission, getSyntax, hasPermission, isPlayerOnly, onConsoleUse, onPlayerUse, tabComplete, tabComplete

Methods inherited from class org.bukkit.command.Command

broadcastCommandMessage, broadcastCommandMessage, getAliases, getLabel, getPermissionMessage, isRegistered, register, setAliases, setDescription, setLabel, setName, setPermission, setPermissionMessage, setUsage, testPermission, testPermissionSilent, toString, unregister

Methods inherited from class java.lang.Object

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

Constructor Details

SubCommand

public SubCommand(@NotNull
 @NotNull String name)

Creates an instance of this command.

Parameters:

name - Name of the command.

SubCommand

public SubCommand(@NotNull
 @NotNull String name,
 @NotNull
 @NotNull String description,
 @NotNull
 @NotNull String usageMessage,
 @NotNull
 @NotNull List<String> aliases)

Creates an instance of this command.

Parameters:

name - Name of the command.

description - Description of the command.

usageMessage - Usage message of the command.

aliases - Aliases for the command.

Method Details

getParent

public abstract Class<? extends CoreCommand> getParent()

Returns the parent of this SubCommand.

Returns:

Class of the CoreCommand that this SubCommand should belong to.

getUsage

@NotNull
public @NotNull String getUsage()

Generates a usage using the BaseCommand.getSyntax().

Overrides:

getUsage in class BaseCommand

Returns:

Usage syntax of this command in String.