Package com.plotsquared.core.configuration.caption

Class TranslatableCaption

java.lang.Object

com.plotsquared.core.configuration.caption.TranslatableCaption

All Implemented Interfaces:

Caption, NamespacedCaption

public final class TranslatableCaption
extends Object
implements NamespacedCaption

Caption that is user modifiable

Field Summary

Fields

Modifier and Type	Field	Description
static String	DEFAULT_NAMESPACE	Default caption namespace

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object o)
@NonNull String	getComponent(@NonNull LocaleHolder localeHolder)	Get the message that should be sent to the recipient
@NonNull String	getKey()	Get the key that identifies this caption
@NonNull String	getNamespace()	Get the namespace that this caption belongs to
int	hashCode()
static @NonNull TranslatableCaption	of(@NonNull String rawKey)	Get a new TranslatableCaption instance
static @NonNull TranslatableCaption	of(@NonNull String namespace, @NonNull String key)	Get a new TranslatableCaption instance

Methods inherited from class java.lang.Object

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

Field Details

DEFAULT_NAMESPACE

public static final String DEFAULT_NAMESPACE

Default caption namespace

See Also:

Constant Field Values

Method Details

of

public static @NonNull TranslatableCaption of(@NonNull String rawKey)

Get a new TranslatableCaption instance

Parameters:

rawKey - Caption key in the format namespace:key. If no namespace is included, DEFAULT_NAMESPACE will be used.

Returns:

Caption instance

of

public static @NonNull TranslatableCaption of(@NonNull String namespace,
 @NonNull String key)

Get a new TranslatableCaption instance

Parameters:

namespace - Caption namespace

key - Caption key

Returns:

Caption instance

getComponent

public @NonNull String getComponent(@NonNull LocaleHolder localeHolder)

Description copied from interface: Caption

Get the message that should be sent to the recipient

Specified by:

getComponent in interface Caption

Parameters:

localeHolder - Locale holder

Returns:

Message

getKey

public @NonNull String getKey()

Description copied from interface: NamespacedCaption

Get the key that identifies this caption

Specified by:

getKey in interface NamespacedCaption

Returns:

Caption key

getNamespace

public @NonNull String getNamespace()

Description copied from interface: NamespacedCaption

Get the namespace that this caption belongs to

Specified by:

getNamespace in interface NamespacedCaption

Returns:

Namespace

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object