Package com.plotsquared.core.util.placeholders

Class PlotSpecificPlaceholder

java.lang.Object

com.plotsquared.core.util.placeholders.Placeholder

com.plotsquared.core.util.placeholders.PlotSpecificPlaceholder

Direct Known Subclasses:

PlotFlagPlaceholder

public abstract class PlotSpecificPlaceholder
extends Placeholder

A placeholder that requires a plot

Constructor Summary

Constructors

Constructor	Description
PlotSpecificPlaceholder(@NonNull String key)
PlotSpecificPlaceholder(@NonNull String key, boolean requireAbsolute)	Create a functional placeholder

Method Summary

Modifier and Type	Method	Description
final @NonNull String	getValue(@NonNull PlotPlayer<?> player)	Get the value of the placeholder for a particular player
abstract @NonNull String	getValue(@NonNull PlotPlayer<?> player, @NonNull Plot plot)	Get the value of the placeholder for the player in a specific plot

Methods inherited from class com.plotsquared.core.util.placeholders.Placeholder

getKey

Methods inherited from class java.lang.Object

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

Constructor Details

PlotSpecificPlaceholder

public PlotSpecificPlaceholder(@NonNull String key)

PlotSpecificPlaceholder

public PlotSpecificPlaceholder(@NonNull String key,
 boolean requireAbsolute)

Create a functional placeholder

Parameters:

key - Placeholder key

requireAbsolute - If the plot given to the placeholder should be the absolute (not base) plot

Since:

7.5.9

Method Details

getValue

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

Description copied from class: Placeholder

Get the value of the placeholder for a particular player

Specified by:

getValue in class Placeholder

Parameters:

player - Player

Returns:

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

getValue

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

Get the value of the placeholder for the player in a specific plot

Parameters:

player - Player that the placeholder is evaluated for

plot - Plot that the player is in

Returns:

Placeholder value, or "" if the placeholder does not apply