mirror of
https://github.com/TotalFreedomMC/TF-EssentialsX.git
synced 2025-02-12 20:29:20 +00:00
447b9db397
This commit adds a new boolean-configurable feature called last-message-reply-recipient, defaults to true for new installs and false for old installs, which states whether to use the new messaging functionality or not. This commit deprecates Console#getCommandSender(Server) and provides Console#getInstance()#getCommandSender() for future usability.
96 lines
3.4 KiB
Java
96 lines
3.4 KiB
Java
package com.earth2me.essentials.messaging;
|
|
|
|
/**
|
|
* Represents an interface for message recipients.
|
|
*/
|
|
public interface IMessageRecipient {
|
|
|
|
/**
|
|
* Sends (prints) a message to this recipient.
|
|
*
|
|
* @param message message
|
|
*/
|
|
void sendMessage(String message);
|
|
|
|
/**
|
|
* This method is called when this {@link IMessageRecipient} is sending a message to another {@link IMessageRecipient}.
|
|
* <br />
|
|
* The {@link MessageResponse} that is returned is used to determine what exactly should happen in the {@link #sendMessage(IMessageRecipient,
|
|
* String)} implementation by the {@code sender}.
|
|
*
|
|
* @param recipient recipient to receive the {@code message}
|
|
* @param message message to send
|
|
*
|
|
* @return the response of the message
|
|
*/
|
|
MessageResponse sendMessage(IMessageRecipient recipient, String message);
|
|
|
|
/**
|
|
* This method is called when this recipient is receiving a message from another {@link IMessageRecipient}.
|
|
* <br />
|
|
* The {@link MessageResponse} that is returned is used to determine what exactly should happen in the {@link #sendMessage(IMessageRecipient,
|
|
* String)} implementation by the {@code sender}.
|
|
* <p />
|
|
* <b>This method should only be called by {@link #sendMessage(IMessageRecipient, String)}.</b>
|
|
*
|
|
* @param sender sender of the {@code message}
|
|
* @param message message being received
|
|
*
|
|
* @return the response of the message
|
|
*/
|
|
MessageResponse onReceiveMessage(IMessageRecipient sender, String message);
|
|
|
|
/**
|
|
* Returns the name of this recipient. This name is typically used internally to identify this recipient.
|
|
*
|
|
* @return name of this recipient
|
|
*
|
|
* @see #getDisplayName()
|
|
*/
|
|
String getName();
|
|
|
|
/**
|
|
* Returns the display name of this recipient. This name is typically used when formatting messages.
|
|
*
|
|
* @return display name of this recipient
|
|
*/
|
|
String getDisplayName();
|
|
|
|
/**
|
|
* Returns the {@link IMessageRecipient} this recipient should send replies to.
|
|
*
|
|
* @return message recipient
|
|
*/
|
|
IMessageRecipient getReplyRecipient();
|
|
|
|
/**
|
|
* Sets the {@link IMessageRecipient} this recipient should send replies to.
|
|
*
|
|
* @param recipient message recipient to set
|
|
*/
|
|
void setReplyRecipient(IMessageRecipient recipient);
|
|
|
|
/**
|
|
* Represents a response for sending or receiving a message when using {@link IMessageRecipient#sendMessage(IMessageRecipient, String)} or
|
|
* {@link IMessageRecipient#onReceiveMessage(IMessageRecipient, String)}.
|
|
*/
|
|
enum MessageResponse {
|
|
/** States that the message was received and assumed readable by the receiver. */
|
|
SUCCESS,
|
|
/** States that the message was received, but the receiver was away, assuming the message was not read. */
|
|
SUCCESS_BUT_AFK,
|
|
/** States that the message was <b>NOT</b> received as a result of the receiver ignoring all messages. */
|
|
MESSAGES_IGNORED,
|
|
/** States that the message was <b>NOT</b> received as a result of the sender being ignored by the recipient. */
|
|
SENDER_IGNORED;
|
|
|
|
/**
|
|
* Returns whether this response is a success. In other words equal to {@link #SUCCESS} or {@link #SUCCESS_BUT_AFK}
|
|
*
|
|
* @return whether the response is a success
|
|
*/
|
|
public boolean isSuccess() {
|
|
return this == SUCCESS || this == SUCCESS_BUT_AFK;
|
|
}
|
|
}
|
|
}
|