Package top.focess.qq.api.command

Class Command

java.lang.Object

top.focess.qq.api.command.Command

Direct Known Subclasses:

BotCommand, CommandCommand, FriendCommand, GroupCommand, LoadCommand, PluginCommand, ReloadCommand, StopCommand, UnloadCommand

public abstract class Command
extends Object

Represent a Plugin class that can execute. Just like we use the terminal, we could use it to executing some commands. This is an important way to interact with Mirai QQ Bot. You should declare CommandType to this class ,or you should register it with your plugin manually.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	Command.Executor	This class is used to help define the executor of certain command.

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	Command()	Provide a constructor to help PluginType design.
	Command(@NotNull String name, @NotNull String... aliases)	Instance a Command Class with special name and aliases.

Method Summary

Modifier and Type	Method	Description
@NotNull Command.Executor	addExecutor(int count, @NotNull CommandExecutor executor, String... subCommands)	Add default executor to define how to execute this command.
boolean	execute(@NotNull CommandSender sender, @NotNull String[] args, @NotNull IOHandler ioHandler)	Execute the command with special arguments
@NotNull List<String>	getAliases()
static List<Command>	getCommands()	Get all commands
java.util.function.Predicate<CommandSender>	getExecutorPermission()
@NotNull String	getName()
@NotNull CommandPermission	getPermission()
@NotNull Plugin	getPlugin()
abstract void	init()	Used to initialize the command (the primary goal is to define the default executors)
boolean	isInitialize()
boolean	isRegistered()
static void	register(@NotNull Plugin plugin, @NotNull Command command)	Register the command
void	setExecutorPermission(@NotNull java.util.function.Predicate<CommandSender> executorPermission)
void	setPermission(@NotNull net.mamoe.mirai.contact.MemberPermission permission)	Deprecated.
void	setPermission(CommandPermission permission)	Set the default permission
void	unregister()	Unregister this command
static void	unregister(Plugin plugin)	Unregister all commands in the plugin
static boolean	unregisterAll()	Unregister all commands
abstract void	usage(CommandSender sender, IOHandler ioHandler)	Used to print help information when execute this command with wrong arguments or the executor returns CommandResult.ARGS

Methods inherited from class java.lang.Object

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

Constructor Detail

Command

public Command(@NotNull
               @NotNull String name,
               @NotNull
               @NotNull String... aliases)

Instance a Command Class with special name and aliases.

Parameters:

name - the name of the command

aliases - the aliases of the command

Throws:

CommandLoadException - if there is any exception thrown in the initializing process

Command

protected Command()

Provide a constructor to help PluginType design. Never instance it! It will be instanced when this class is loaded automatically.

Method Detail

setExecutorPermission

public void setExecutorPermission(@NotNull
                                  @NotNull java.util.function.Predicate<CommandSender> executorPermission)

unregister

public static void unregister(Plugin plugin)

Unregister all commands in the plugin

Parameters:

plugin - the plugin that the commands that need to be unregistered belongs to

unregisterAll

public static boolean unregisterAll()

Unregister all commands

Returns:

true if there are some commands not belonging to MainPlugin not been unregistered, false otherwise

getCommands

public static List<Command> getCommands()

Get all commands

Returns:

All commands as a List

register

public static void register(@NotNull
                            @NotNull Plugin plugin,
                            @NotNull
                            @NotNull Command command)

Register the command

Parameters:

plugin - the plugin the command belongs to

command - the command that need to be registered

Throws:

CommandDuplicateException - if the command name already exists in the registered commands

isRegistered

public boolean isRegistered()

getPlugin

@NotNull
public @NotNull Plugin getPlugin()

unregister

public void unregister()

Unregister this command

getName

@NotNull
public @NotNull String getName()

getAliases

@NotNull
public @NotNull List<String> getAliases()

getExecutorPermission

public java.util.function.Predicate<CommandSender> getExecutorPermission()

addExecutor

@NotNull
public final @NotNull Command.Executor addExecutor(int count,
                                                   @NotNull
                                                   @NotNull CommandExecutor executor,
                                                   String... subCommands)

Add default executor to define how to execute this command. for example : this.addExecutor(1, ... ,"example"); which means that it runs when you execute the command with "example" "xxx". this.addExecutor(0, ...); which means that it runs when you just execute the command without anything.

Parameters:

count - the arguments' length that you need

executor - the executor to define this command

subCommands - the known arguments for this executor

Returns:

the Executor to define other proprieties

execute

public final boolean execute(@NotNull
                             @NotNull CommandSender sender,
                             @NotNull
                             @NotNull String[] args,
                             @NotNull
                             @NotNull IOHandler ioHandler)

Execute the command with special arguments

Parameters:

sender - the executor

args - the arguments that command spilt by spaces

ioHandler - the receiver

Returns:

an Executor that help to define the executor of this command

See Also:

Main.CommandLine.exec(CommandSender, String, IOHandler)

getPermission

@NotNull
public @NotNull CommandPermission getPermission()

setPermission

@Deprecated
public final void setPermission(@NotNull
                                @NotNull net.mamoe.mirai.contact.MemberPermission permission)

Deprecated.

Set the default permission

Parameters:

permission - the target permission the command need

init

public abstract void init()

Used to initialize the command (the primary goal is to define the default executors)

usage

public abstract void usage(CommandSender sender,
                           IOHandler ioHandler)

Used to print help information when execute this command with wrong arguments or the executor returns CommandResult.ARGS

Parameters:

sender - the executor which need to print help information

ioHandler - the receiver which need to print help information

isInitialize

public boolean isInitialize()

setPermission

public void setPermission(CommandPermission permission)

Set the default permission

Parameters:

permission - the target permission the command need