Package top.focess.qq.api.command

Class Command.Executor

java.lang.Object

top.focess.qq.api.command.Command.Executor

Enclosing class:

Command

public static class Command.Executor
extends Object

This class is used to help define the executor of certain command. There is some special methods used to give more details of this executor.

Method Summary

Modifier and Type	Method	Description
Command	getCommand()	Get the command this Executor belongs to
@NotNull Command.Executor	overrideExecutorPermission(@NotNull java.util.function.Predicate<CommandSender> executorPermission)	Set the executor permission check for this Executor When execute this Executor, it will only check the executorPermission
@NotNull Command.Executor	removeExecutorPermission()	Remove the executor permission check for this Executor
@NotNull Command.Executor	setCommandResultExecutors(@NotNull CommandResult result, @NotNull CommandResultExecutor executor)	Set the executor of the special CommandResult after executing this Executor
@NotNull Command.Executor	setDataConverters(@NotNull DataConverter<?>... dataConverters)	Set the DataConverters for the arguments.
@NotNull Command.Executor	setExecutorPermission(@NotNull java.util.function.Predicate<CommandSender> executorPermission)	Set the executor permission check for this Executor When execute this Executor, it will check Command.executorPermission and the executorPermission
@NotNull Command.Executor	setPermission(@NotNull net.mamoe.mirai.contact.MemberPermission permission)	Deprecated.
@NotNull Command.Executor	setPermission(@NotNull CommandPermission permission)	Set the executor Mirai Permission (Only if the CommandSender has the command that this executor belongs to and this executor's permissions, this executor runs)
@NotNull Command.Executor	setUseDefaultConverter(boolean flag)	Set whether force use the DataConverter.DEFAULT_DATA_CONVERTER or not.

Methods inherited from class java.lang.Object

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

Method Detail

setPermission

@NotNull
@Deprecated
public @NotNull Command.Executor setPermission(@NotNull
                                               @NotNull net.mamoe.mirai.contact.MemberPermission permission)

Deprecated.

Set the executor Mirai Permission (Only if the CommandSender has the command that this executor belongs to and this executor's permissions, this executor runs)

Parameters:

permission - the executor Mirai Permission

Returns:

the Executor itself

setPermission

@NotNull
public @NotNull Command.Executor setPermission(@NotNull
                                               @NotNull CommandPermission permission)

Set the executor Mirai Permission (Only if the CommandSender has the command that this executor belongs to and this executor's permissions, this executor runs)

Parameters:

permission - the executor Mirai Permission

Returns:

the Executor itself

setCommandResultExecutors

@NotNull
public @NotNull Command.Executor setCommandResultExecutors(@NotNull
                                                           @NotNull CommandResult result,
                                                           @NotNull
                                                           @NotNull CommandResultExecutor executor)

Set the executor of the special CommandResult after executing this Executor

Parameters:

result - the target CommandResult

executor - the executor of the special CommandResult

Returns:

the Executor itself

setDataConverters

@NotNull
public @NotNull Command.Executor setDataConverters(@NotNull
                                                   @NotNull DataConverter<?>... dataConverters)

Set the DataConverters for the arguments. Only if setUseDefaultConverter(boolean) is set false, this method will influence the DataCollection parser.

Parameters:

dataConverters - used to parser arguments this executor needs.

Returns:

the Executor itself

See Also:

setUseDefaultConverter(boolean)

setUseDefaultConverter

@NotNull
public @NotNull Command.Executor setUseDefaultConverter(boolean flag)

Set whether force use the DataConverter.DEFAULT_DATA_CONVERTER or not. If this is set true, the influence by setDataConverters(DataConverter[]) is ignored.

Parameters:

flag - true force use the DataConverter.DEFAULT_DATA_CONVERTER, false ignore it

Returns:

the Executor itself

See Also:

setDataConverters(DataConverter[])

setExecutorPermission

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

Set the executor permission check for this Executor When execute this Executor, it will check Command.executorPermission and the executorPermission

Parameters:

executorPermission - the executor permission check for this Executor

Returns:

the Executor self

removeExecutorPermission

@NotNull
public @NotNull Command.Executor removeExecutorPermission()

Remove the executor permission check for this Executor

Returns:

the Executor self

overrideExecutorPermission

@NotNull
public @NotNull Command.Executor overrideExecutorPermission(@NotNull
                                                            @NotNull java.util.function.Predicate<CommandSender> executorPermission)

Set the executor permission check for this Executor When execute this Executor, it will only check the executorPermission

Parameters:

executorPermission - the executor permission check for this Executor

Returns:

the Executor self

getCommand

public Command getCommand()

Get the command this Executor belongs to

Returns:

the command this Executor belongs to