Package com.earth2me.essentials.messaging

Class SimpleMessageRecipient

java.lang.Object

com.earth2me.essentials.messaging.SimpleMessageRecipient

All Implemented Interfaces:

IMessageRecipient, MailSender

public class SimpleMessageRecipient
extends Object
implements IMessageRecipient

Represents a simple reusable implementation of IMessageRecipient. This class provides functionality for the following methods:

• IMessageRecipient.sendMessage(IMessageRecipient, String)
• IMessageRecipient.onReceiveMessage(IMessageRecipient, String)
• IMessageRecipient.getReplyRecipient()
• IMessageRecipient.setReplyRecipient(IMessageRecipient)

The given parent must implement the following methods to prevent overflow:

• IMessageRecipient.sendMessage(String)
• IMessageRecipient.getName()
• IMessageRecipient.getDisplayName()
• IMessageRecipient.isReachable()

The reply-recipient is wrapped in a WeakReference.

Nested Class Summary

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

IMessageRecipient.MessageResponse

Constructor Summary

Constructors

Constructor	Description
SimpleMessageRecipient(IEssentials ess, IMessageRecipient parent)

Method Summary

Modifier and Type	Method	Description
String	getDisplayName()	Returns the display name of this recipient.
String	getName()	Returns the name of this recipient.
IMessageRecipient	getReplyRecipient()	Returns the IMessageRecipient this recipient should send replies to.
protected static User	getUser(IMessageRecipient recipient)
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 replyRecipient)	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

Constructor Details

SimpleMessageRecipient

public SimpleMessageRecipient(IEssentials ess,
 IMessageRecipient parent)

Method Details

getUser

protected static User getUser(IMessageRecipient 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

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 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

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

getReplyRecipient

public IMessageRecipient getReplyRecipient()

Returns the IMessageRecipient this recipient should send replies to.

This SimpleMessageRecipient implementation stores the a weak reference to the recipient.

Specified by:

getReplyRecipient in interface IMessageRecipient

Returns:

message recipient

setReplyRecipient

public void setReplyRecipient(IMessageRecipient replyRecipient)

Sets the IMessageRecipient this recipient should send replies to.

This SimpleMessageRecipient implementation stores the a weak reference to the recipient.

Specified by:

setReplyRecipient in interface IMessageRecipient

Parameters:

replyRecipient - message recipient to set

isHiddenFrom

public boolean isHiddenFrom(Player player)

Specified by:

isHiddenFrom in interface IMessageRecipient