Package com.plotsquared.core.configuration.caption

Class StaticCaption

java.lang.Object

com.plotsquared.core.configuration.caption.StaticCaption

All Implemented Interfaces:

Caption

public final class StaticCaption
extends Object
implements Caption

Method Summary

Modifier and Type	Method	Description
@NonNull String	getComponent(@NonNull LocaleHolder localeHolder)	Get the message that should be sent to the recipient
static @NonNull StaticCaption	of(@NonNull String text)	Create a new static caption from the given text
@NonNull Component	toComponent(@NonNull LocaleHolder localeHolder)	Get the Adventure ComponentLike for this caption
@NonNull Component	toComponent(@NonNull LocaleHolder localeHolder, @NonNull TagResolver @NonNull ... tagResolvers)	Get the Adventure ComponentLike for this caption while applying custom TagResolver (apart from the default core.prefix)
@NonNull String	toString()

Methods inherited from class java.lang.Object

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

Method Details

of

public static @NonNull StaticCaption of(@NonNull String text)

Create a new static caption from the given text

Parameters:

text - Text

Returns:

Created caption

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

toComponent

public @NonNull Component toComponent(@NonNull LocaleHolder localeHolder)

Description copied from interface: Caption

Get the Adventure ComponentLike for this caption

Specified by:

toComponent in interface Caption

Parameters:

localeHolder - Locale holder

Returns:

ComponentLike

toComponent

public @NonNull Component toComponent(@NonNull LocaleHolder localeHolder,
 @NonNull TagResolver @NonNull ... tagResolvers)

Description copied from interface: Caption

Get the Adventure ComponentLike for this caption while applying custom TagResolver (apart from the default core.prefix)

Specified by:

toComponent in interface Caption

Parameters:

localeHolder - Local holder

tagResolvers - custom tag resolvers to replace placeholders / parameters

Returns:

ComponentLike

toString

public @NonNull String toString()

Specified by:

toString in interface Caption

Overrides:

toString in class Object