Package com.plotsquared.core.configuration.caption

Class ChatFormatter.ChatContext

java.lang.Object

com.plotsquared.core.configuration.caption.ChatFormatter.ChatContext

Enclosing interface:

ChatFormatter

public static final class ChatFormatter.ChatContext
extends Object

Constructor Summary

Constructors

Constructor	Description
ChatContext(@Nullable PlotPlayer<?> recipient, @NonNull String message, boolean rawOutput)	Create a new chat context

Method Summary

Modifier and Type	Method	Description
@NonNull String	getMessage()	Get the message stored in the context
@Nullable PlotPlayer<?>	getRecipient()	Get the message recipient
boolean	isRawOutput()	Whether or not the output should escape any formatting keys
void	setMessage(@NonNull String message)	Set the new message

Methods inherited from class java.lang.Object

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

Constructor Details

ChatContext

public ChatContext(@Nullable PlotPlayer<?> recipient,
 @NonNull String message,
 boolean rawOutput)

Create a new chat context

Parameters:

recipient - Message recipient

message - Message

rawOutput - Whether or not formatting keys should be included in the final message

Method Details

getRecipient

public @Nullable PlotPlayer<?> getRecipient()

Get the message recipient

Returns:

Recipient

getMessage

public @NonNull String getMessage()

Get the message stored in the context

Returns:

Stored message

setMessage

public void setMessage(@NonNull String message)

Set the new message

Parameters:

message - Message

isRawOutput

public boolean isRawOutput()

Whether or not the output should escape any formatting keys

Returns:

true if raw output is to be used