Package io.github.thebusybiscuit.slimefun4.core.commands

Class SubCommand

java.lang.Object

io.github.thebusybiscuit.slimefun4.core.commands.SubCommand

Direct Known Subclasses:

BanItemCommand, ClearDataCommand, DebugCommand, MigrateCommand, ReloadCommand, UnbanItemCommand

public abstract class SubCommand
extends Object

This class represents a SubCommand, it is a Command that starts with /sf ... and is followed by the name of this SubCommand.

Author:

TheBusyBiscuit

See Also:

• SlimefunCommand

Field Summary

Fields

Modifier and Type	Field	Description
protected final SlimefunCommand	cmd
protected final Slimefun	plugin

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	SubCommand(Slimefun plugin, SlimefunCommand cmd, String name, boolean hidden)

Method Summary

Modifier and Type	Method	Description
protected String	getDescription()
String	getDescription(org.bukkit.command.CommandSender sender)	This returns a description for this SubCommand.
final String	getName()	This returns the name of this SubCommand, the name is equivalent to the first argument given to the actual command.
final boolean	isHidden()	This method returns whether this SubCommand is hidden from the HelpCommand.
abstract void	onExecute(org.bukkit.command.CommandSender sender, String[] args)
protected void	recordUsage(Map<SubCommand,Integer> commandUsage)

Methods inherited from class java.lang.Object

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

Field Details

plugin

protected final Slimefun plugin

cmd

protected final SlimefunCommand cmd

Constructor Details

SubCommand

@ParametersAreNonnullByDefault
protected SubCommand(Slimefun plugin,
 SlimefunCommand cmd,
 String name,
 boolean hidden)

Method Details

getName

@Nonnull
public final String getName()

This returns the name of this SubCommand, the name is equivalent to the first argument given to the actual command.

Returns:

The name of this SubCommand

isHidden

public final boolean isHidden()

This method returns whether this SubCommand is hidden from the HelpCommand.

Returns:

Whether to hide this SubCommand

recordUsage

protected void recordUsage(@Nonnull
 Map<SubCommand,Integer> commandUsage)

onExecute

public abstract void onExecute(@Nonnull
 org.bukkit.command.CommandSender sender,
 @Nonnull
 String[] args)

getDescription

@Nonnull
protected String getDescription()

getDescription

@Nonnull
public String getDescription(@Nonnull
 org.bukkit.command.CommandSender sender)

This returns a description for this SubCommand. If the given CommandSender is a Player, the description will be localized with the currently selected Language of that Player.

Parameters:

sender - The CommandSender who requested the description

Returns:

A possibly localized description of this SubCommand