Package top.focess.qq.api.command

Class CommandSender

java.lang.Object

top.focess.qq.api.command.CommandSender

public class CommandSender
extends Object

This class present an executor to execute command. We can use it to distinguish different permissions.

Field Summary

Fields

Modifier and Type	Field	Description
static CommandSender	CONSOLE	Present CONSOLE or we call it Terminate

Constructor Summary

Constructors

Constructor	Description
CommandSender(@NonNull Friend friend)	Deprecated.
CommandSender(@NonNull Member member)	Deprecated.
CommandSender(@NonNull Stranger stranger)	Deprecated.

Method Summary

Modifier and Type	Method	Description
static void	clear(Plugin plugin)
boolean	equals(Object o)
void	exec(String command)	Execute command with this CommandSender
@Nullable Bot	getBot()	Get the bot
@Nullable Friend	getFriend()	Get the friend, or null if this CommandSender does not present a friend
IOHandler	getIOHandler()	Get the receiver by this CommandSender
@Nullable Member	getMember()	Get the member, or null if this CommandSender does not present a member
@NonNull CommandPermission	getPermission()	Get permission
Session	getSession()	Get Session of the CommandSender.
@Nullable Stranger	getStranger()	Get the stranger, or null if this CommandSender does not present a stranger
int	hashCode()
boolean	hasPermission(CommandPermission permission)	Indicate this CommandSender owns the permission
boolean	isAdministrator()	Indicate this is an Administrator
boolean	isConsole()	Indicate whether it is CONSOLE
boolean	isFriend()	Indicate this is a friend
boolean	isMember()	Indicate this is a member
boolean	isStranger()	Indicate whether this is a stranger
static CommandSender	of(CommandExecutor executor)	Get the CommandSender by CommandExecutor
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

CONSOLE

public static final CommandSender CONSOLE

Present CONSOLE or we call it Terminate

Constructor Detail

CommandSender

@Deprecated
public CommandSender(@NonNull Friend friend)

Deprecated.

Present Friend

Parameters:

friend - the friend

CommandSender

@Deprecated
public CommandSender(@NonNull Member member)

Deprecated.

Present Member in Group

Parameters:

member - the member

CommandSender

@Deprecated
public CommandSender(@NonNull Stranger stranger)

Deprecated.

Present Stranger

Parameters:

stranger - the stranger

Method Detail

clear

public static void clear(Plugin plugin)

getFriend

public @Nullable Friend getFriend()

Get the friend, or null if this CommandSender does not present a friend

Returns:

the friend

isFriend

@EnsuresNonNullIf(expression="getFriend()",
                  result=true)
public boolean isFriend()

Indicate this is a friend

Returns:

true if this CommandSender presents a friend, false otherwise

hasPermission

public boolean hasPermission(CommandPermission permission)

Indicate this CommandSender owns the permission

Parameters:

permission - the compared permission

Returns:

true if the permission of this CommandSender is higher or equivalent to the compared permission, false otherwise

getMember

public @Nullable Member getMember()

Get the member, or null if this CommandSender does not present a member

Returns:

the member

isMember

@EnsuresNonNullIf(expression="getMember()",
                  result=true)
public boolean isMember()

Indicate this is a member

Returns:

true if this CommandSender presents a member, false otherwise

isAdministrator

public boolean isAdministrator()

Indicate this is an Administrator

Returns:

true if this CommandSender presents its id is equal to the id of the Administrator, false otherwise

getPermission

public @NonNull CommandPermission getPermission()

Get permission

Returns:

permission of this sender

toString

public String toString()

Overrides:

toString in class Object

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

isConsole

public boolean isConsole()

Indicate whether it is CONSOLE

Returns:

true if it is CONSOLE, false otherwise

getIOHandler

public IOHandler getIOHandler()

Get the receiver by this CommandSender

Returns:

the receiver by this CommandSender

exec

public void exec(String command)

Execute command with this CommandSender

Parameters:

command - the command CommandSender execute

See Also:

CommandLine.exec(CommandSender, String)

getSession

public Session getSession()

Get Session of the CommandSender. It can be used to store some data for future using. But the data it stored will be lost after Bot exiting.

Returns:

Session of sender

getBot

public @Nullable Bot getBot()

Get the bot

Returns:

the bot

isStranger

@EnsuresNonNullIf(expression="getStranger()",
                  result=true)
public boolean isStranger()

Indicate whether this is a stranger

Returns:

true if this CommandSender presents a stranger, false otherwise

getStranger

public @Nullable Stranger getStranger()

Get the stranger, or null if this CommandSender does not present a stranger

Returns:

the stranger

of

public static CommandSender of(CommandExecutor executor)

Get the CommandSender by CommandExecutor

Parameters:

executor - the executor

Returns:

the CommandSender