Package com.earth2me.essentials

Class Console

java.lang.Object

com.earth2me.essentials.Console

All Implemented Interfaces:

IMessageRecipient, MailSender

public final class Console
extends Object
implements IMessageRecipient

Nested Class Summary

Nested classes/interfaces inherited from interface com.earth2me.essentials.messaging.IMessageRecipient

IMessageRecipient.MessageResponse

Field Summary

Fields

Modifier and Type	Field	Description
static final String	DISPLAY_NAME
static final String	NAME

Method Summary

Modifier and Type	Method	Description
CommandSender	getCommandSender()
static CommandSender	getCommandSender(Server server)	Deprecated. Use getCommandSender()
String	getDisplayName()	Returns the display name of this recipient.
static Console	getInstance()
String	getName()	Returns the name of this recipient.
IMessageRecipient	getReplyRecipient()	Returns the IMessageRecipient this recipient should send replies to.
UUID	getUUID()	Gets the UUID of this MailSender or null if this sender doesn't have a UUID.
boolean	isHiddenFrom(Player player)
boolean	isReachable()	Returns whether this recipient is reachable.
IMessageRecipient.MessageResponse	onReceiveMessage(IMessageRecipient sender, String message)	This method is called when this recipient is receiving a message from another IMessageRecipient.
IMessageRecipient.MessageResponse	sendMessage(IMessageRecipient recipient, String message)	This method is called when this IMessageRecipient is sending a message to another IMessageRecipient.
void	sendMessage(String message)	Sends (prints) a message to this recipient.
void	sendTl(String tlKey, Object... args)	Sends a translated message to this recipient.
void	setReplyRecipient(IMessageRecipient recipient)	Sets the IMessageRecipient this recipient should send replies to.
String	tlSender(String tlKey, Object... args)	Translates a message.

Methods inherited from class java.lang.Object

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

Field Details

NAME

public static final String NAME

See Also:

• Constant Field Values

DISPLAY_NAME

public static final String DISPLAY_NAME

Method Details

getInstance

public static Console getInstance()

getCommandSender

@Deprecated
public static CommandSender getCommandSender(Server server)
                                      throws Exception

Deprecated.

Use getCommandSender()

Throws:

Exception

getCommandSender

public CommandSender getCommandSender()

getName

public String getName()

Description copied from interface: IMessageRecipient

Returns the name of this recipient. This name is typically used internally to identify this recipient.

Specified by:

getName in interface IMessageRecipient

Specified by:

getName in interface MailSender

Returns:

name of this recipient

See Also:

• IMessageRecipient.getDisplayName()

getUUID

public UUID getUUID()

Description copied from interface: MailSender

Gets the UUID of this MailSender or null if this sender doesn't have a UUID.

Specified by:

getUUID in interface MailSender

Returns:

The sender's UUID or null if N/A.

getDisplayName

public String getDisplayName()

Description copied from interface: IMessageRecipient

Returns the display name of this recipient. This name is typically used when formatting messages.

Specified by:

getDisplayName in interface IMessageRecipient

Returns:

display name of this recipient

sendMessage

public void sendMessage(String message)

Description copied from interface: IMessageRecipient

Sends (prints) a message to this recipient.

Specified by:

sendMessage in interface IMessageRecipient

Parameters:

message - message

sendTl

public void sendTl(String tlKey,
 Object... args)

Description copied from interface: IMessageRecipient

Sends a translated message to this recipient.

Specified by:

sendTl in interface IMessageRecipient

Parameters:

tlKey - key

args - arguments

tlSender

public String tlSender(String tlKey,
 Object... args)

Description copied from interface: IMessageRecipient

Translates a message.

Specified by:

tlSender in interface IMessageRecipient

Parameters:

tlKey - key

args - arguments

Returns:

translated message

isReachable

public boolean isReachable()

Description copied from interface: IMessageRecipient

Returns whether this recipient is reachable. A case where the recipient is not reachable is if they are offline.

Specified by:

isReachable in interface IMessageRecipient

Returns:

whether this recipient is reachable

sendMessage

public IMessageRecipient.MessageResponse sendMessage(IMessageRecipient recipient,
 String message)

Description copied from interface: IMessageRecipient

This method is called when this IMessageRecipient is sending a message to another IMessageRecipient.

The IMessageRecipient.MessageResponse that is returned is used to determine what exactly should happen in the IMessageRecipient.sendMessage(IMessageRecipient, String) implementation by the sender.

Specified by:

sendMessage in interface IMessageRecipient

Parameters:

recipient - recipient to receive the message

message - message to send

Returns:

the response of the message

onReceiveMessage

public IMessageRecipient.MessageResponse onReceiveMessage(IMessageRecipient sender,
 String message)

Description copied from interface: IMessageRecipient

This method is called when this recipient is receiving a message from another IMessageRecipient.

The IMessageRecipient.MessageResponse that is returned is used to determine what exactly should happen in the IMessageRecipient.sendMessage(IMessageRecipient, String) implementation by the sender.

This method should only be called by IMessageRecipient.sendMessage(IMessageRecipient, String).

Specified by:

onReceiveMessage in interface IMessageRecipient

Parameters:

sender - sender of the message

message - message being received

Returns:

the response of the message

getReplyRecipient

public IMessageRecipient getReplyRecipient()

Description copied from interface: IMessageRecipient

Returns the IMessageRecipient this recipient should send replies to.

Specified by:

getReplyRecipient in interface IMessageRecipient

Returns:

message recipient

setReplyRecipient

public void setReplyRecipient(IMessageRecipient recipient)

Description copied from interface: IMessageRecipient

Sets the IMessageRecipient this recipient should send replies to.

Specified by:

setReplyRecipient in interface IMessageRecipient

Parameters:

recipient - message recipient to set

isHiddenFrom

public boolean isHiddenFrom(Player player)

Specified by:

isHiddenFrom in interface IMessageRecipient