me.realized.duels.api.command

Class SubCommand

java.lang.Object

me.realized.duels.api.command.SubCommand

public abstract class SubCommand
extends java.lang.Object

An abstract SubCommand class that hooks into commands registered by Duels.

See Also:

Duels.registerSubCommand(String, SubCommand)

Constructor Summary

Constructors

Constructor and Description
SubCommand(java.lang.String name, java.lang.String usage, java.lang.String description, java.lang.String permission, boolean playerOnly, int length, java.lang.String... aliases) The constructor for a subcommand.

Method Summary

Modifier and Type	Method and Description
abstract void	execute(org.bukkit.command.CommandSender sender, java.lang.String label, java.lang.String[] args)
java.lang.String[]	getAliases() The aliases of this subcommand.
java.lang.String	getDescription() The description of this subcommand.
int	getLength() The length of this subcommand.
java.lang.String	getName() The name of this subcommand.
java.lang.String	getPermission() The permission of this subcommand.
java.lang.String	getUsage() The usage of this subcommand.
boolean	isPlayerOnly() Whether or not this subcommand can only be used by a player.

Methods inherited from class java.lang.Object

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

Constructor Detail

SubCommand

public SubCommand(@NotNull
                  java.lang.String name,
                  @Nullable
                  java.lang.String usage,
                  @Nullable
                  java.lang.String description,
                  @Nullable
                  java.lang.String permission,
                  boolean playerOnly,
                  int length,
                  java.lang.String... aliases)

The constructor for a subcommand.

Parameters:

name - Name of this subcommand. Should not be null!

usage - Usage of this subcommand. May be null.

description - Description of this subcommand. May be null.

permission - Permission of this subcommand. May be null.

playerOnly - Whether or not this subcommand should be player only.

length - Length of this subcommand. Must be greater than or equal to 1.

aliases - Aliases of this subcommand.

Method Detail

getName

public java.lang.String getName()

The name of this subcommand.

Returns:

Never-null String that is the name of this subcommand.

getUsage

public java.lang.String getUsage()

The usage of this subcommand.

Returns:

Usage of this subcommand or null if unspecified.

getDescription

public java.lang.String getDescription()

The description of this subcommand.

Returns:

Description of this subcommand or null if unspecified.

getPermission

public java.lang.String getPermission()

The permission of this subcommand. If set to null, it will inherit its parent's permission.

Returns:

Permission of this subcommand or null if unspecified.

isPlayerOnly

public boolean isPlayerOnly()

Whether or not this subcommand can only be used by a player. If the parent of this subcommand is player only, this value will not be considered.

Returns:

True if this subcommand is player only. False otherwise.

getLength

public int getLength()

The length of this subcommand.

Returns:

Length of this subcommand.

getAliases

public java.lang.String[] getAliases()

The aliases of this subcommand.

Returns:

Aliases of this subcommand.

execute

public abstract void execute(org.bukkit.command.CommandSender sender,
                             java.lang.String label,
                             java.lang.String[] args)