Package dev.jorel.commandapi

Class CommandAPICommand

java.lang.Object

dev.jorel.commandapi.ExecutableCommand<CommandAPICommand,org.bukkit.command.CommandSender>

dev.jorel.commandapi.AbstractCommandAPICommand<CommandAPICommand,Argument<?>,org.bukkit.command.CommandSender>

dev.jorel.commandapi.CommandAPICommand

All Implemented Interfaces:

BukkitExecutable<CommandAPICommand>, ChainableBuilder<CommandAPICommand>, PlatformExecutable<CommandAPICommand,org.bukkit.command.CommandSender>

public class CommandAPICommand
extends AbstractCommandAPICommand<CommandAPICommand,Argument<?>,org.bukkit.command.CommandSender>
implements BukkitExecutable<CommandAPICommand>

Field Summary

Fields

Modifier and Type	Field	Description
protected CommandAPIExecutor<org.bukkit.command.CommandSender,AbstractCommandSender<? extends org.bukkit.command.CommandSender>>	executor

Fields inherited from class dev.jorel.commandapi.AbstractCommandAPICommand

arguments, isConverted, subcommands

Fields inherited from class dev.jorel.commandapi.ExecutableCommand

meta

Constructor Summary

Constructors

Constructor	Description
CommandAPICommand(dev.jorel.commandapi.CommandMetaData<org.bukkit.command.CommandSender> meta)
CommandAPICommand(String commandName)

Method Summary

Modifier and Type	Method	Description
CommandAPICommand	clearExecutors()
CommandAPIExecutor<org.bukkit.command.CommandSender,AbstractCommandSender<? extends org.bukkit.command.CommandSender>>	getExecutor()
CommandAPICommand	instance()
protected CommandAPICommand	newConcreteCommandAPICommand(dev.jorel.commandapi.CommandMetaData<org.bukkit.command.CommandSender> metaData)
void	register(String namespace)	Registers the command with a given namespace
void	register(org.bukkit.plugin.java.JavaPlugin plugin)	Registers this command with a given JavaPlugin instance
void	setExecutor(CommandAPIExecutor<org.bukkit.command.CommandSender,AbstractCommandSender<? extends org.bukkit.command.CommandSender>> arg0)
CommandAPICommand	withHelp(org.bukkit.help.HelpTopic helpTopic)	Sets the HelpTopic for this command.

Methods inherited from class dev.jorel.commandapi.AbstractCommandAPICommand

copy, getArguments, getSubcommands, isConverted, setArguments, setSubcommands, withArguments, withArguments, withOptionalArguments, withOptionalArguments, withSubcommand, withSubcommands

Methods inherited from class dev.jorel.commandapi.ExecutableCommand

getAliases, getFullDescription, getName, getPermission, getRequirements, getShortDescription, getUsage, override, register, setAliases, setPermission, setRequirements, withAliases, withFullDescription, withHelp, withoutPermission, withoutPermission, withPermission, withPermission, withRequirement, withShortDescription, withUsage

Methods inherited from class java.lang.Object

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

Methods inherited from interface dev.jorel.commandapi.BukkitExecutable

executes, executes, executes, executes, executesCommandBlock, executesCommandBlock, executesCommandBlock, executesCommandBlock, executesConsole, executesConsole, executesConsole, executesConsole, executesEntity, executesEntity, executesEntity, executesEntity, executesFeedbackForwarding, executesFeedbackForwarding, executesFeedbackForwarding, executesFeedbackForwarding, executesNative, executesNative, executesNative, executesNative, executesPlayer, executesPlayer, executesPlayer, executesPlayer, executesProxy, executesProxy, executesProxy, executesProxy, executesRemoteConsole, executesRemoteConsole, executesRemoteConsole, executesRemoteConsole

Methods inherited from interface dev.jorel.commandapi.PlatformExecutable

getExecutor

Field Details

executor

protected CommandAPIExecutor<org.bukkit.command.CommandSender,AbstractCommandSender<? extends org.bukkit.command.CommandSender>> executor

Constructor Details

CommandAPICommand

public CommandAPICommand(dev.jorel.commandapi.CommandMetaData<org.bukkit.command.CommandSender> meta)

CommandAPICommand

public CommandAPICommand(String commandName)

Method Details

newConcreteCommandAPICommand

protected CommandAPICommand newConcreteCommandAPICommand(dev.jorel.commandapi.CommandMetaData<org.bukkit.command.CommandSender> metaData)

Specified by:

newConcreteCommandAPICommand in class AbstractCommandAPICommand<CommandAPICommand,Argument<?>,org.bukkit.command.CommandSender>

instance

public CommandAPICommand instance()

Specified by:

instance in interface ChainableBuilder<CommandAPICommand>

withHelp

public CommandAPICommand withHelp(org.bukkit.help.HelpTopic helpTopic)

Sets the HelpTopic for this command. Using this method will override any declared short description, full description or usage description provided via the following methods:

• ExecutableCommand.withShortDescription(String)
• ExecutableCommand.withFullDescription(String)
• ExecutableCommand.withUsage(String...)
• ExecutableCommand.withHelp(String, String)

Parameters:

helpTopic - the help topic to use for this command

Returns:

this command builder

register

public void register(String namespace)

Registers the command with a given namespace

Overrides:

register in class AbstractCommandAPICommand<CommandAPICommand,Argument<?>,org.bukkit.command.CommandSender>

Parameters:

namespace - The namespace of this command. This cannot be null or empty

register

public void register(org.bukkit.plugin.java.JavaPlugin plugin)

Registers this command with a given JavaPlugin instance

Parameters:

plugin - The plugin instance used to determine this command's namespace

getExecutor

public CommandAPIExecutor<org.bukkit.command.CommandSender,AbstractCommandSender<? extends org.bukkit.command.CommandSender>> getExecutor()

setExecutor

public void setExecutor(CommandAPIExecutor<org.bukkit.command.CommandSender,AbstractCommandSender<? extends org.bukkit.command.CommandSender>> arg0)

clearExecutors

public CommandAPICommand clearExecutors()