mirror of
https://github.com/IntellectualSites/PlotSquared.git
synced 2024-06-23 09:55:04 +02:00
58 lines
2.0 KiB
Java
58 lines
2.0 KiB
Java
/*
|
|
* PlotSquared, a land and world management plugin for Minecraft.
|
|
* Copyright (C) IntellectualSites <https://intellectualsites.com>
|
|
* Copyright (C) IntellectualSites team and contributors
|
|
*
|
|
* This program is free software: you can redistribute it and/or modify
|
|
* it under the terms of the GNU General Public License as published by
|
|
* the Free Software Foundation, either version 3 of the License, or
|
|
* (at your option) any later version.
|
|
*
|
|
* This program is distributed in the hope that it will be useful,
|
|
* but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
|
* GNU General Public License for more details.
|
|
*
|
|
* You should have received a copy of the GNU General Public License
|
|
* along with this program. If not, see <https://www.gnu.org/licenses/>.
|
|
*/
|
|
package com.plotsquared.core.util.placeholders;
|
|
|
|
import com.plotsquared.core.player.PlotPlayer;
|
|
import com.plotsquared.core.plot.Plot;
|
|
import org.checkerframework.checker.nullness.qual.NonNull;
|
|
|
|
/**
|
|
* A {@link Placeholder placeholder} that requires a {@link com.plotsquared.core.plot.Plot plot}
|
|
*/
|
|
public abstract class PlotSpecificPlaceholder extends Placeholder {
|
|
|
|
public PlotSpecificPlaceholder(final @NonNull String key) {
|
|
super(key);
|
|
}
|
|
|
|
@Override
|
|
public @NonNull
|
|
final String getValue(final @NonNull PlotPlayer<?> player) {
|
|
final Plot plot = player.getCurrentPlot();
|
|
if (plot == null) {
|
|
return "";
|
|
}
|
|
return this.getValue(player, plot);
|
|
}
|
|
|
|
/**
|
|
* Get the value of the placeholder for the {@link PlotPlayer player} in a specific {@link Plot plot}
|
|
*
|
|
* @param player Player that the placeholder is evaluated for
|
|
* @param plot Plot that the player is in
|
|
* @return Placeholder value, or {@code ""} if the placeholder does not apply
|
|
*/
|
|
public @NonNull
|
|
abstract String getValue(
|
|
final @NonNull PlotPlayer<?> player,
|
|
final @NonNull Plot plot
|
|
);
|
|
|
|
}
|