模块 mxlib.command.api

程序包 cn.mcres.karlatemp.mxlib.command

接口 CommandProvider

所有已知实现类:

AbstractCommandProvider, BaseCommandProvider, BukkitCommandProvider, LoggerProvider, PrintStreamProvider

public interface CommandProvider

The commands provider

方法概要

修饰符和类型	方法	说明
@Nullable ICommand	buildCommand(Class<?> commandClass)	Build command in a class
ICommand	buildCommands(Package package_, List<Class<?>> classes)	Create new command in a package.
HelpTemplate	getHelp()	Get help template.
boolean	hasPermission(Object sender, String permission)	Check sender has permission or not.
Logger	logger()	Get Provider's Logger
void	noPermission(Object sender, ICommand command)	Executed when denied for lack of permissions
default String	parse_message(String desc)
@Nullable Object	resolveSender(Object sender, @Nullable Class<?> toClass)	Try resolve sender. null if fail.
void	senderNotResolve(Object sender, Class<?> toClass)	Call when sender cannot resolve to target class.
default void	sendMessage(Level level, Object sender, Object message)
void	sendMessage(Level level, Object sender, String message)	Send a message to sender.
MTranslate	translate()
void	translate(Level level, Object sender, String trans)	Try send a translate message to sender.
void	translate(Level level, Object sender, String trans, Object... params)	Try send a translate message to sender.
@NotNull CommandProvider	withParent(CommandProvider provider)	Call when command class used current class.

方法详细资料

buildCommands

ICommand buildCommands(Package package_,
                       List<Class<?>> classes)

Create new command in a package.

参数:

package_ - Command Class package.

classes - Class found.

返回:

The build-in command.

buildCommand

@Nullable
@Nullable ICommand buildCommand(Class<?> commandClass)

Build command in a class

参数:

commandClass - The source of command.

返回:

A command build.

resolveSender

@Nullable
@Nullable Object resolveSender(Object sender,
                               @Nullable
                               @Nullable Class<?> toClass)

Try resolve sender. null if fail.

参数:

sender - The sender object.

toClass - Target class check(use in command). null if don't check type.

返回:

null if fail. or resolved object.

另请参阅:

MSender, DefaultCommand.check(Object)

senderNotResolve

void senderNotResolve(Object sender,
                      Class<?> toClass)

Call when sender cannot resolve to target class.

参数:

sender - The resolved object.

toClass - Target class.

withParent

@NotNull
@NotNull CommandProvider withParent(CommandProvider provider)

Call when command class used current class.

参数:

provider - The parent provider.

返回:

A Provider with parent. Normally it should return a new instance.

hasPermission

boolean hasPermission(Object sender,
                      String permission)

Check sender has permission or not.

参数:

sender - The sender need check

permission - The permission need check.

返回:

The sender has permission or not.

noPermission

void noPermission(Object sender,
                  ICommand command)

Executed when denied for lack of permissions

参数:

sender - The sender.

command - The denied command.

sendMessage

void sendMessage(Level level,
                 Object sender,
                 String message)

Send a message to sender.

参数:

level - The message level.

sender - The sender.

message - The message.

sendMessage

default void sendMessage(Level level,
                         Object sender,
                         Object message)

translate

void translate(Level level,
               Object sender,
               String trans)

Try send a translate message to sender.

参数:

level - The sending level.

sender - The sender.

trans - The translate.

translate

void translate(Level level,
               Object sender,
               String trans,
               Object... params)

Try send a translate message to sender.

参数:

level - The sending level.

sender - The sender.

trans - The translate.

params - The translate parameters.

getHelp

HelpTemplate getHelp()

Get help template.

返回:

The template using.

logger

Logger logger()

Get Provider's Logger

translate

MTranslate translate()

parse_message

default String parse_message(String desc)