me.croabeast.beanslib.key

Class PlayerKey<T>

java.lang.Object

me.croabeast.beanslib.key.PlayerKey<T>

public final class PlayerKey<T>
extends Object

A class that represents a key-function pair for a player, the function will return a value of type T.

The class provides static methods to load, remove, edit, and replace keys with their corresponding values.

The class also maintains a map of default keys that can be restored at any time.

Method Summary

Modifier and Type	Method and Description
static boolean	editKey(String oldKey, String newKey) Edits a key-function pair by changing the key string.
boolean	equals(Object o)
static <T> boolean	loadKey(String key, java.util.function.Function<org.bukkit.entity.Player,T> function) Loads a new key-function pair and stores it in the loaded keys.
static boolean	removeKey(String key) Removes a key-function pair from the loaded keys using its key.
static String	replaceKeys(org.bukkit.entity.Player player, String string) Replaces all the occurrences of the keys in a given string with their corresponding value functions for a given player.
static String	replaceKeys(org.bukkit.entity.Player player, String string, boolean isSensitive) Replaces all the occurrences of the keys in a given string with their corresponding value functions for a given player.
static void	setDefaults() Restores the loaded keys to its default configuration.
String	toString()

Methods inherited from class java.lang.Object

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

Method Detail

equals

public boolean equals(Object o)

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class Object

loadKey

public static <T> boolean loadKey(String key,
                                  java.util.function.Function<org.bukkit.entity.Player,T> function)

Loads a new key-function pair and stores it in the loaded keys.

Type Parameters:

T - The result of the function.

Parameters:

key - The key string

function - The function that returns a value of type T for a given player

Returns:

true if the key was successfully loaded, false otherwise

removeKey

public static boolean removeKey(String key)

Removes a key-function pair from the loaded keys using its key.

Parameters:

key - The key string

Returns:

True if the key was successfully removed, false otherwise

editKey

public static boolean editKey(String oldKey,
                              String newKey)

Edits a key-function pair by changing the key string.

Parameters:

oldKey - The old key string

newKey - The new key string

Returns:

True if the key was successfully edited, false otherwise

replaceKeys

public static String replaceKeys(org.bukkit.entity.Player player,
                                 String string,
                                 boolean isSensitive)

Replaces all the occurrences of the keys in a given string with their corresponding value functions for a given player.

Parameters:

player - The player to apply the function to

string - The string to replace the keys in

isSensitive - A boolean flag that indicates whether the replacement is case-sensitive or not

Returns:

The modified string after replacing the keys with their values

replaceKeys

public static String replaceKeys(org.bukkit.entity.Player player,
                                 String string)

Replaces all the occurrences of the keys in a given string with their corresponding value functions for a given player. The replacement is case-insensitive by default.

Parameters:

player - The player to apply the function to

string - The string to replace the keys in

Returns:

The modified string after replacing the keys with their values

setDefaults

public static void setDefaults()

Restores the loaded keys to its default configuration.