Package com.plotsquared.core.util.placeholders

Class Placeholder

java.lang.Object

com.plotsquared.core.util.placeholders.Placeholder

Direct Known Subclasses:

PlotSpecificPlaceholder

public abstract class Placeholder
extends Object

A placeholder is a keyed value that gets replaced by a player-specific value at runtime

Constructor Summary

Constructors

Constructor	Description
Placeholder(@NonNull String key)

Method Summary

Modifier and Type	Method	Description
@NonNull String	getKey()	Get the placeholder key
abstract @NonNull String	getValue(@NonNull PlotPlayer<?> player)	Get the value of the placeholder for a particular player

Methods inherited from class java.lang.Object

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

Constructor Details

Placeholder

public Placeholder(@NonNull String key)

Method Details

getValue

public abstract @NonNull String getValue(@NonNull PlotPlayer<?> player)

Get the value of the placeholder for a particular player

Parameters:

player - Player

Returns:

Placeholder value. Return "" if no placeholder value can be returned

getKey

public final @NonNull String getKey()

Get the placeholder key

Returns:

Placeholder key