updated placeholder hook to define immutability and null contracts, deprecated online player function

This commit is contained in:
Sxtanna 2020-07-20 18:14:13 -04:00
parent 9060ea6bd3
commit 3b3892e7d6

View File

@ -22,8 +22,11 @@ package me.clip.placeholderapi;
import org.bukkit.OfflinePlayer;
import org.bukkit.entity.Player;
import org.jetbrains.annotations.NotNull;
import org.jetbrains.annotations.Nullable;
public abstract class PlaceholderHook {
public abstract class PlaceholderHook
{
/**
* called when a placeholder value is requested from this hook
@ -33,8 +36,11 @@ public abstract class PlaceholderHook {
* @param params String passed to the hook to determine what value to return
* @return value for the requested player and params
*/
public String onRequest(OfflinePlayer player, String params) {
if (player != null && player.isOnline()) {
@Nullable
public String onRequest(@Nullable final OfflinePlayer player, @NotNull final String params)
{
if (player != null && player.isOnline())
{
return onPlaceholderRequest((Player) player, params);
}
@ -48,7 +54,11 @@ public abstract class PlaceholderHook {
* @param params String passed to the hook to determine what value to return
* @return value for the requested player and params
*/
public String onPlaceholderRequest(Player player, String params) {
@Nullable
@Deprecated
public String onPlaceholderRequest(@Nullable final Player player, @NotNull final String params)
{
return null;
}
}