mirror of
https://github.com/PlaceholderAPI/PlaceholderAPI
synced 2024-11-18 00:46:55 +01:00
updated to use new char replacer, deprecated all older functions, defined null contracts, and immutability.
This commit is contained in:
parent
3b3892e7d6
commit
45b3ebfbc2
@ -31,28 +31,70 @@ import me.clip.placeholderapi.replacer.CharsReplacer;
|
|||||||
import me.clip.placeholderapi.replacer.Replacer;
|
import me.clip.placeholderapi.replacer.Replacer;
|
||||||
import me.clip.placeholderapi.replacer.Replacer.Closure;
|
import me.clip.placeholderapi.replacer.Replacer.Closure;
|
||||||
import me.clip.placeholderapi.util.Msg;
|
import me.clip.placeholderapi.util.Msg;
|
||||||
import org.apache.commons.lang.Validate;
|
|
||||||
import org.bukkit.Bukkit;
|
import org.bukkit.Bukkit;
|
||||||
import org.bukkit.OfflinePlayer;
|
import org.bukkit.OfflinePlayer;
|
||||||
import org.bukkit.entity.Player;
|
import org.bukkit.entity.Player;
|
||||||
import org.bukkit.plugin.Plugin;
|
import org.bukkit.plugin.Plugin;
|
||||||
|
import org.jetbrains.annotations.NotNull;
|
||||||
|
import org.jetbrains.annotations.Nullable;
|
||||||
|
|
||||||
import java.util.*;
|
import java.util.HashMap;
|
||||||
|
import java.util.HashSet;
|
||||||
|
import java.util.List;
|
||||||
|
import java.util.Map;
|
||||||
|
import java.util.Set;
|
||||||
import java.util.regex.Matcher;
|
import java.util.regex.Matcher;
|
||||||
import java.util.regex.Pattern;
|
import java.util.regex.Pattern;
|
||||||
import java.util.stream.Collectors;
|
import java.util.stream.Collectors;
|
||||||
|
|
||||||
import static me.clip.placeholderapi.util.Msg.color;
|
public final class PlaceholderAPI
|
||||||
|
{
|
||||||
|
|
||||||
public class PlaceholderAPI {
|
|
||||||
|
|
||||||
private static final Pattern PLACEHOLDER_PATTERN = Pattern.compile("[%]([^%]+)[%]");
|
|
||||||
private static final Pattern BRACKET_PLACEHOLDER_PATTERN = Pattern.compile("[{]([^{}]+)[}]");
|
|
||||||
private static final Pattern RELATIONAL_PLACEHOLDER_PATTERN = Pattern.compile("[%](rel_)([^%]+)[%]");
|
|
||||||
private static final Map<String, PlaceholderHook> placeholders = new HashMap<>();
|
|
||||||
private static final Replacer REPLACER = new CharsReplacer(Closure.PERCENT);
|
private static final Replacer REPLACER = new CharsReplacer(Closure.PERCENT);
|
||||||
|
private static final Map<String, PlaceholderHook> PLACEHOLDERS = new HashMap<>();
|
||||||
|
|
||||||
private PlaceholderAPI() {
|
|
||||||
|
@Deprecated
|
||||||
|
private static final Pattern PLACEHOLDER_PATTERN = Pattern.compile("[%]([^%]+)[%]");
|
||||||
|
@Deprecated
|
||||||
|
private static final Pattern BRACKET_PLACEHOLDER_PATTERN = Pattern.compile("[{]([^{}]+)[}]");
|
||||||
|
@Deprecated
|
||||||
|
private static final Pattern RELATIONAL_PLACEHOLDER_PATTERN = Pattern.compile("[%](rel_)([^%]+)[%]");
|
||||||
|
|
||||||
|
|
||||||
|
private PlaceholderAPI()
|
||||||
|
{
|
||||||
|
}
|
||||||
|
|
||||||
|
|
||||||
|
// === Current API ===
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Translates all placeholders into their corresponding values.
|
||||||
|
* <br>The pattern of a valid placeholder is {@literal %<identifier>_<params>%}.
|
||||||
|
*
|
||||||
|
* @param player Player to parse the placeholders against
|
||||||
|
* @param text Text to set the placeholder values in
|
||||||
|
* @return String containing all translated placeholders
|
||||||
|
*/
|
||||||
|
@NotNull
|
||||||
|
public static String setPlaceholders(@Nullable final OfflinePlayer player, @NotNull final String text)
|
||||||
|
{
|
||||||
|
return REPLACER.apply(text, player, PLACEHOLDERS::get);
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Translates all placeholders into their corresponding values.
|
||||||
|
* <br>The pattern of a valid placeholder is {@literal %<identifier>_<params>%}.
|
||||||
|
*
|
||||||
|
* @param player Player to parse the placeholders against
|
||||||
|
* @param text List of Strings to set the placeholder values in
|
||||||
|
* @return String containing all translated placeholders
|
||||||
|
*/
|
||||||
|
@NotNull
|
||||||
|
public static List<String> setPlaceholders(@Nullable final OfflinePlayer player, @NotNull List<@NotNull String> text)
|
||||||
|
{
|
||||||
|
return text.stream().map(line -> setPlaceholders(player, line)).collect(Collectors.toList());
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
@ -61,10 +103,9 @@ public class PlaceholderAPI {
|
|||||||
* @param identifier The identifier to check
|
* @param identifier The identifier to check
|
||||||
* @return true if identifier is already registered
|
* @return true if identifier is already registered
|
||||||
*/
|
*/
|
||||||
public static boolean isRegistered(String identifier) {
|
public static boolean isRegistered(@NotNull final String identifier)
|
||||||
return getRegisteredIdentifiers().stream()
|
{
|
||||||
.filter(id -> id.equalsIgnoreCase(identifier))
|
return PLACEHOLDERS.containsKey(identifier.toLowerCase());
|
||||||
.findFirst().orElse(null) != null;
|
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
@ -76,17 +117,14 @@ public class PlaceholderAPI {
|
|||||||
* @return true if the hook was successfully registered, false if there is already a hook
|
* @return true if the hook was successfully registered, false if there is already a hook
|
||||||
* registered for the specified identifier
|
* registered for the specified identifier
|
||||||
*/
|
*/
|
||||||
public static boolean registerPlaceholderHook(String identifier, PlaceholderHook placeholderHook) {
|
public static boolean registerPlaceholderHook(@NotNull final String identifier, @NotNull final PlaceholderHook placeholderHook)
|
||||||
Validate.notNull(identifier, "Identifier can not be null");
|
{
|
||||||
Validate.notNull(placeholderHook, "Placeholderhook can not be null");
|
return PLACEHOLDERS.putIfAbsent(identifier.toLowerCase(), placeholderHook) == null;
|
||||||
|
|
||||||
if (isRegistered(identifier)) {
|
|
||||||
return false;
|
|
||||||
}
|
}
|
||||||
|
|
||||||
placeholders.put(identifier.toLowerCase(), placeholderHook);
|
public static boolean registerPlaceholderHook(@NotNull final Plugin plugin, @NotNull final PlaceholderHook placeholderHook)
|
||||||
|
{
|
||||||
return true;
|
return registerPlaceholderHook(plugin.getName(), placeholderHook);
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
@ -96,18 +134,26 @@ public class PlaceholderAPI {
|
|||||||
* @return true if the placeholder hook was successfully unregistered, false if there was no
|
* @return true if the placeholder hook was successfully unregistered, false if there was no
|
||||||
* placeholder hook registered for the identifier specified
|
* placeholder hook registered for the identifier specified
|
||||||
*/
|
*/
|
||||||
public static boolean unregisterPlaceholderHook(String identifier) {
|
public static boolean unregisterPlaceholderHook(@NotNull final String identifier)
|
||||||
Validate.notNull(identifier, "Identifier can not be null");
|
{
|
||||||
return placeholders.remove(identifier.toLowerCase()) != null;
|
return PLACEHOLDERS.remove(identifier.toLowerCase()) != null;
|
||||||
}
|
}
|
||||||
|
|
||||||
|
public static boolean unregisterPlaceholderHook(@NotNull final Plugin plugin)
|
||||||
|
{
|
||||||
|
return unregisterPlaceholderHook(plugin.getName());
|
||||||
|
}
|
||||||
|
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Get all registered placeholder identifiers
|
* Get all registered placeholder identifiers
|
||||||
*
|
*
|
||||||
* @return All registered placeholder identifiers
|
* @return All registered placeholder identifiers
|
||||||
*/
|
*/
|
||||||
public static Set<String> getRegisteredIdentifiers() {
|
@NotNull
|
||||||
return ImmutableSet.copyOf(placeholders.keySet());
|
public static Set<String> getRegisteredIdentifiers()
|
||||||
|
{
|
||||||
|
return ImmutableSet.copyOf(PLACEHOLDERS.keySet());
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
@ -115,11 +161,115 @@ public class PlaceholderAPI {
|
|||||||
*
|
*
|
||||||
* @return Copy of the internal placeholder map
|
* @return Copy of the internal placeholder map
|
||||||
*/
|
*/
|
||||||
public static Map<String, PlaceholderHook> getPlaceholders() {
|
@NotNull
|
||||||
return ImmutableMap.copyOf(placeholders);
|
public static Map<String, PlaceholderHook> getPlaceholders()
|
||||||
|
{
|
||||||
|
return ImmutableMap.copyOf(PLACEHOLDERS);
|
||||||
}
|
}
|
||||||
|
|
||||||
public static Set<PlaceholderExpansion> getExpansions() {
|
|
||||||
|
/**
|
||||||
|
* Unregister ALL placeholder hooks that are currently registered
|
||||||
|
*/
|
||||||
|
protected static void unregisterAll()
|
||||||
|
{
|
||||||
|
unregisterAllProvidedExpansions();
|
||||||
|
PLACEHOLDERS.clear();
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Unregister all expansions provided by PlaceholderAPI
|
||||||
|
*/
|
||||||
|
public static void unregisterAllProvidedExpansions()
|
||||||
|
{
|
||||||
|
final Set<PlaceholderHook> set = new HashSet<>(PLACEHOLDERS.values());
|
||||||
|
|
||||||
|
for (PlaceholderHook hook : set)
|
||||||
|
{
|
||||||
|
if (hook instanceof PlaceholderExpansion)
|
||||||
|
{
|
||||||
|
final PlaceholderExpansion expansion = (PlaceholderExpansion) hook;
|
||||||
|
|
||||||
|
if (!expansion.persist())
|
||||||
|
{
|
||||||
|
unregisterExpansion(expansion);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
if (hook instanceof Cacheable)
|
||||||
|
{
|
||||||
|
((Cacheable) hook).clear();
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
public static boolean registerExpansion(@NotNull final PlaceholderExpansion expansion)
|
||||||
|
{
|
||||||
|
final ExpansionRegisterEvent event = new ExpansionRegisterEvent(expansion);
|
||||||
|
Bukkit.getPluginManager().callEvent(event);
|
||||||
|
|
||||||
|
if (event.isCancelled())
|
||||||
|
{
|
||||||
|
return false;
|
||||||
|
}
|
||||||
|
|
||||||
|
return registerPlaceholderHook(expansion.getIdentifier(), expansion);
|
||||||
|
}
|
||||||
|
|
||||||
|
public static boolean unregisterExpansion(@NotNull final PlaceholderExpansion expansion)
|
||||||
|
{
|
||||||
|
if (unregisterPlaceholderHook(expansion.getIdentifier()))
|
||||||
|
{
|
||||||
|
Bukkit.getPluginManager().callEvent(new ExpansionUnregisterEvent(expansion));
|
||||||
|
return true;
|
||||||
|
}
|
||||||
|
|
||||||
|
return false;
|
||||||
|
}
|
||||||
|
|
||||||
|
|
||||||
|
// === Deprecated API === (please don't use this, thank you - Sxtanna :P)
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Translates all placeholders into their corresponding values.
|
||||||
|
* <br>You set the pattern yourself through this method.
|
||||||
|
*
|
||||||
|
* @param player Player to parse the placeholders against
|
||||||
|
* @param text Text to set the placeholder values in
|
||||||
|
* @param pattern The pattern to match placeholders to. Capture group 1 must contain an underscore separating the
|
||||||
|
* identifier from the params
|
||||||
|
* @param colorize If color codes (&[0-1a-fk-o]) should be translated
|
||||||
|
* @return The text containing the parsed placeholders
|
||||||
|
* @deprecated this will do absolutely nothing different
|
||||||
|
*/
|
||||||
|
@NotNull
|
||||||
|
@Deprecated
|
||||||
|
public static String setPlaceholders(@Nullable final OfflinePlayer player, @NotNull final String text, @NotNull final Pattern pattern, final boolean colorize)
|
||||||
|
{
|
||||||
|
return setPlaceholders(player, text);
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Translates all placeholders into their corresponding values.
|
||||||
|
* <br>You set the pattern yourself through this method.
|
||||||
|
*
|
||||||
|
* @param player Player to parse the placeholders against
|
||||||
|
* @param text List of Strings to set the placeholder values in
|
||||||
|
* @param pattern The pattern to match placeholders to. Capture group 1 must contain an underscore separating the
|
||||||
|
* identifier from the params
|
||||||
|
* @param colorize If color codes (&[0-1a-fk-o]) should be translated
|
||||||
|
* @return String containing all translated placeholders
|
||||||
|
*/
|
||||||
|
@NotNull
|
||||||
|
@Deprecated
|
||||||
|
public static List<String> setPlaceholders(@Nullable final OfflinePlayer player, @NotNull final List<String> text, @NotNull final Pattern pattern, final boolean colorize)
|
||||||
|
{
|
||||||
|
return setPlaceholders(player, text);
|
||||||
|
}
|
||||||
|
|
||||||
|
@Deprecated
|
||||||
|
public static Set<PlaceholderExpansion> getExpansions()
|
||||||
|
{
|
||||||
Set<PlaceholderExpansion> set = getPlaceholders().values().stream()
|
Set<PlaceholderExpansion> set = getPlaceholders().values().stream()
|
||||||
.filter(PlaceholderExpansion.class::isInstance).map(PlaceholderExpansion.class::cast)
|
.filter(PlaceholderExpansion.class::isInstance).map(PlaceholderExpansion.class::cast)
|
||||||
.collect(Collectors.toCollection(HashSet::new));
|
.collect(Collectors.toCollection(HashSet::new));
|
||||||
@ -133,7 +283,9 @@ public class PlaceholderAPI {
|
|||||||
* @param text String to check
|
* @param text String to check
|
||||||
* @return true if String contains any registered placeholder identifiers, false otherwise
|
* @return true if String contains any registered placeholder identifiers, false otherwise
|
||||||
*/
|
*/
|
||||||
public static boolean containsPlaceholders(String text) {
|
@Deprecated
|
||||||
|
public static boolean containsPlaceholders(String text)
|
||||||
|
{
|
||||||
return text != null && PLACEHOLDER_PATTERN.matcher(text).find();
|
return text != null && PLACEHOLDER_PATTERN.matcher(text).find();
|
||||||
}
|
}
|
||||||
|
|
||||||
@ -143,7 +295,9 @@ public class PlaceholderAPI {
|
|||||||
* @param text String to check
|
* @param text String to check
|
||||||
* @return true if String contains any registered placeholder identifiers, false otherwise
|
* @return true if String contains any registered placeholder identifiers, false otherwise
|
||||||
*/
|
*/
|
||||||
public static boolean containsBracketPlaceholders(String text) {
|
@Deprecated
|
||||||
|
public static boolean containsBracketPlaceholders(String text)
|
||||||
|
{
|
||||||
return text != null && BRACKET_PLACEHOLDER_PATTERN.matcher(text).find();
|
return text != null && BRACKET_PLACEHOLDER_PATTERN.matcher(text).find();
|
||||||
}
|
}
|
||||||
|
|
||||||
@ -155,7 +309,9 @@ public class PlaceholderAPI {
|
|||||||
* @param text List of Strings to set the placeholder values in
|
* @param text List of Strings to set the placeholder values in
|
||||||
* @return String containing all translated placeholders
|
* @return String containing all translated placeholders
|
||||||
*/
|
*/
|
||||||
public static List<String> setBracketPlaceholders(OfflinePlayer player, List<String> text) {
|
@Deprecated
|
||||||
|
public static List<String> setBracketPlaceholders(OfflinePlayer player, List<String> text)
|
||||||
|
{
|
||||||
return setPlaceholders(player, text, BRACKET_PLACEHOLDER_PATTERN, true);
|
return setPlaceholders(player, text, BRACKET_PLACEHOLDER_PATTERN, true);
|
||||||
}
|
}
|
||||||
|
|
||||||
@ -168,22 +324,12 @@ public class PlaceholderAPI {
|
|||||||
* @param colorize If color codes (&[0-1a-fk-o]) should be translated
|
* @param colorize If color codes (&[0-1a-fk-o]) should be translated
|
||||||
* @return String containing all translated placeholders
|
* @return String containing all translated placeholders
|
||||||
*/
|
*/
|
||||||
public static List<String> setBracketPlaceholders(OfflinePlayer player, List<String> text, boolean colorize) {
|
@Deprecated
|
||||||
|
public static List<String> setBracketPlaceholders(OfflinePlayer player, List<String> text, boolean colorize)
|
||||||
|
{
|
||||||
return setPlaceholders(player, text, BRACKET_PLACEHOLDER_PATTERN, colorize);
|
return setPlaceholders(player, text, BRACKET_PLACEHOLDER_PATTERN, colorize);
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
|
||||||
* Translates all placeholders into their corresponding values.
|
|
||||||
* <br>The pattern of a valid placeholder is {@literal %<identifier>_<params>%}.
|
|
||||||
*
|
|
||||||
* @param player Player to parse the placeholders against
|
|
||||||
* @param text List of Strings to set the placeholder values in
|
|
||||||
* @return String containing all translated placeholders
|
|
||||||
*/
|
|
||||||
public static List<String> setPlaceholders(OfflinePlayer player, List<String> text) {
|
|
||||||
return setPlaceholders(player, text, PLACEHOLDER_PATTERN, true);
|
|
||||||
}
|
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Translates all placeholders into their corresponding values.
|
* Translates all placeholders into their corresponding values.
|
||||||
* <br>The pattern of a valid placeholder is {@literal %<identifier>_<params>%}.
|
* <br>The pattern of a valid placeholder is {@literal %<identifier>_<params>%}.
|
||||||
@ -193,7 +339,9 @@ public class PlaceholderAPI {
|
|||||||
* @param colorize If color codes (&[0-1a-fk-o]) should be translated
|
* @param colorize If color codes (&[0-1a-fk-o]) should be translated
|
||||||
* @return String containing all translated placeholders
|
* @return String containing all translated placeholders
|
||||||
*/
|
*/
|
||||||
public static List<String> setPlaceholders(OfflinePlayer player, List<String> text, boolean colorize) {
|
@Deprecated
|
||||||
|
public static List<String> setPlaceholders(OfflinePlayer player, List<String> text, boolean colorize)
|
||||||
|
{
|
||||||
return setPlaceholders(player, text, PLACEHOLDER_PATTERN, colorize);
|
return setPlaceholders(player, text, PLACEHOLDER_PATTERN, colorize);
|
||||||
}
|
}
|
||||||
|
|
||||||
@ -207,31 +355,12 @@ public class PlaceholderAPI {
|
|||||||
* identifier from the params
|
* identifier from the params
|
||||||
* @return String containing all translated placeholders
|
* @return String containing all translated placeholders
|
||||||
*/
|
*/
|
||||||
public static List<String> setPlaceholders(OfflinePlayer player, List<String> text, Pattern pattern) {
|
@Deprecated
|
||||||
|
public static List<String> setPlaceholders(OfflinePlayer player, List<String> text, Pattern pattern)
|
||||||
|
{
|
||||||
return setPlaceholders(player, text, pattern, true);
|
return setPlaceholders(player, text, pattern, true);
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
|
||||||
* Translates all placeholders into their corresponding values.
|
|
||||||
* <br>You set the pattern yourself through this method.
|
|
||||||
*
|
|
||||||
* @param player Player to parse the placeholders against
|
|
||||||
* @param text List of Strings to set the placeholder values in
|
|
||||||
* @param pattern The pattern to match placeholders to. Capture group 1 must contain an underscore separating the
|
|
||||||
* identifier from the params
|
|
||||||
* @param colorize If color codes (&[0-1a-fk-o]) should be translated
|
|
||||||
* @return String containing all translated placeholders
|
|
||||||
*/
|
|
||||||
public static List<String> setPlaceholders(OfflinePlayer player, List<String> text, Pattern pattern, boolean colorize) {
|
|
||||||
if (text == null) {
|
|
||||||
return null;
|
|
||||||
}
|
|
||||||
|
|
||||||
return text.stream()
|
|
||||||
.map(line -> setPlaceholders(player, line, pattern, colorize))
|
|
||||||
.collect(Collectors.toList());
|
|
||||||
}
|
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Translates all placeholders into their corresponding values.
|
* Translates all placeholders into their corresponding values.
|
||||||
* <br>The pattern of a valid placeholder is {@literal {<identifier>_<params>}}.
|
* <br>The pattern of a valid placeholder is {@literal {<identifier>_<params>}}.
|
||||||
@ -240,7 +369,9 @@ public class PlaceholderAPI {
|
|||||||
* @param text Text to set the placeholder values in
|
* @param text Text to set the placeholder values in
|
||||||
* @return String containing all translated placeholders
|
* @return String containing all translated placeholders
|
||||||
*/
|
*/
|
||||||
public static String setBracketPlaceholders(OfflinePlayer player, String text) {
|
@Deprecated
|
||||||
|
public static String setBracketPlaceholders(OfflinePlayer player, String text)
|
||||||
|
{
|
||||||
return setPlaceholders(player, text, BRACKET_PLACEHOLDER_PATTERN, true);
|
return setPlaceholders(player, text, BRACKET_PLACEHOLDER_PATTERN, true);
|
||||||
}
|
}
|
||||||
|
|
||||||
@ -253,22 +384,12 @@ public class PlaceholderAPI {
|
|||||||
* @param colorize If color codes (&[0-1a-fk-o]) should be translated
|
* @param colorize If color codes (&[0-1a-fk-o]) should be translated
|
||||||
* @return String containing all translated placeholders
|
* @return String containing all translated placeholders
|
||||||
*/
|
*/
|
||||||
public static String setBracketPlaceholders(OfflinePlayer player, String text, boolean colorize) {
|
@Deprecated
|
||||||
|
public static String setBracketPlaceholders(OfflinePlayer player, String text, boolean colorize)
|
||||||
|
{
|
||||||
return setPlaceholders(player, text, BRACKET_PLACEHOLDER_PATTERN, colorize);
|
return setPlaceholders(player, text, BRACKET_PLACEHOLDER_PATTERN, colorize);
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
|
||||||
* Translates all placeholders into their corresponding values.
|
|
||||||
* <br>The pattern of a valid placeholder is {@literal %<identifier>_<params>%}.
|
|
||||||
*
|
|
||||||
* @param player Player to parse the placeholders against
|
|
||||||
* @param text Text to set the placeholder values in
|
|
||||||
* @return String containing all translated placeholders
|
|
||||||
*/
|
|
||||||
public static String setPlaceholders(OfflinePlayer player, String text) {
|
|
||||||
return setPlaceholders(player, text, PLACEHOLDER_PATTERN);
|
|
||||||
}
|
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Translates all placeholders into their corresponding values.
|
* Translates all placeholders into their corresponding values.
|
||||||
* <br>The pattern of a valid placeholder is {@literal %<identifier>_<params>%}.
|
* <br>The pattern of a valid placeholder is {@literal %<identifier>_<params>%}.
|
||||||
@ -278,7 +399,9 @@ public class PlaceholderAPI {
|
|||||||
* @param colorize If color codes (&[0-1a-fk-o]) should be translated
|
* @param colorize If color codes (&[0-1a-fk-o]) should be translated
|
||||||
* @return The text containing the parsed placeholders
|
* @return The text containing the parsed placeholders
|
||||||
*/
|
*/
|
||||||
public static String setPlaceholders(OfflinePlayer player, String text, boolean colorize) {
|
@Deprecated
|
||||||
|
public static String setPlaceholders(OfflinePlayer player, String text, boolean colorize)
|
||||||
|
{
|
||||||
return setPlaceholders(player, text, PLACEHOLDER_PATTERN, colorize);
|
return setPlaceholders(player, text, PLACEHOLDER_PATTERN, colorize);
|
||||||
}
|
}
|
||||||
|
|
||||||
@ -292,25 +415,12 @@ public class PlaceholderAPI {
|
|||||||
* identifier from the params
|
* identifier from the params
|
||||||
* @return The text containing the parsed placeholders
|
* @return The text containing the parsed placeholders
|
||||||
*/
|
*/
|
||||||
public static String setPlaceholders(OfflinePlayer player, String text, Pattern pattern) {
|
@Deprecated
|
||||||
|
public static String setPlaceholders(OfflinePlayer player, String text, Pattern pattern)
|
||||||
|
{
|
||||||
return setPlaceholders(player, text, pattern, true);
|
return setPlaceholders(player, text, pattern, true);
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
|
||||||
* Translates all placeholders into their corresponding values.
|
|
||||||
* <br>You set the pattern yourself through this method.
|
|
||||||
*
|
|
||||||
* @param player Player to parse the placeholders against
|
|
||||||
* @param text Text to set the placeholder values in
|
|
||||||
* @param pattern The pattern to match placeholders to. Capture group 1 must contain an underscore separating the
|
|
||||||
* identifier from the params
|
|
||||||
* @param colorize If color codes (&[0-1a-fk-o]) should be translated
|
|
||||||
* @return The text containing the parsed placeholders
|
|
||||||
*/
|
|
||||||
public static String setPlaceholders(OfflinePlayer player, String text, Pattern pattern, boolean colorize) {
|
|
||||||
return REPLACER.apply(text, player, placeholders::get);
|
|
||||||
}
|
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Translate placeholders in the provided List based on the relation of the two provided players.
|
* Translate placeholders in the provided List based on the relation of the two provided players.
|
||||||
* <br>The pattern of a valid placeholder is {@literal %rel_<identifier>_<param>%}.
|
* <br>The pattern of a valid placeholder is {@literal %rel_<identifier>_<param>%}.
|
||||||
@ -320,7 +430,9 @@ public class PlaceholderAPI {
|
|||||||
* @param text text to parse the placeholder values to
|
* @param text text to parse the placeholder values to
|
||||||
* @return The text containing the parsed relational placeholders
|
* @return The text containing the parsed relational placeholders
|
||||||
*/
|
*/
|
||||||
public static List<String> setRelationalPlaceholders(Player one, Player two, List<String> text) {
|
@Deprecated
|
||||||
|
public static List<String> setRelationalPlaceholders(Player one, Player two, List<String> text)
|
||||||
|
{
|
||||||
return setRelationalPlaceholders(one, two, text, true);
|
return setRelationalPlaceholders(one, two, text, true);
|
||||||
}
|
}
|
||||||
|
|
||||||
@ -334,8 +446,11 @@ public class PlaceholderAPI {
|
|||||||
* @param colorize If color codes (&[0-1a-fk-o]) should be translated
|
* @param colorize If color codes (&[0-1a-fk-o]) should be translated
|
||||||
* @return The text containing the parsed relational placeholders
|
* @return The text containing the parsed relational placeholders
|
||||||
*/
|
*/
|
||||||
public static List<String> setRelationalPlaceholders(Player one, Player two, List<String> text, boolean colorize) {
|
@Deprecated
|
||||||
if (text == null) {
|
public static List<String> setRelationalPlaceholders(Player one, Player two, List<String> text, boolean colorize)
|
||||||
|
{
|
||||||
|
if (text == null)
|
||||||
|
{
|
||||||
return null;
|
return null;
|
||||||
}
|
}
|
||||||
|
|
||||||
@ -353,7 +468,9 @@ public class PlaceholderAPI {
|
|||||||
* @param text Text to parse the placeholders in
|
* @param text Text to parse the placeholders in
|
||||||
* @return The text containing the parsed relational placeholders
|
* @return The text containing the parsed relational placeholders
|
||||||
*/
|
*/
|
||||||
public static String setRelationalPlaceholders(Player one, Player two, String text) {
|
@Deprecated
|
||||||
|
public static String setRelationalPlaceholders(Player one, Player two, String text)
|
||||||
|
{
|
||||||
return setRelationalPlaceholders(one, two, text, true);
|
return setRelationalPlaceholders(one, two, text, true);
|
||||||
}
|
}
|
||||||
|
|
||||||
@ -367,24 +484,30 @@ public class PlaceholderAPI {
|
|||||||
* @param colorize If color codes (&[0-1a-fk-o]) should be translated
|
* @param colorize If color codes (&[0-1a-fk-o]) should be translated
|
||||||
* @return The text containing the parsed relational placeholders
|
* @return The text containing the parsed relational placeholders
|
||||||
*/
|
*/
|
||||||
|
@Deprecated
|
||||||
@SuppressWarnings("DuplicatedCode")
|
@SuppressWarnings("DuplicatedCode")
|
||||||
public static String setRelationalPlaceholders(Player one, Player two, String text, boolean colorize) {
|
public static String setRelationalPlaceholders(Player one, Player two, String text, boolean colorize)
|
||||||
if (text == null) {
|
{
|
||||||
|
if (text == null)
|
||||||
|
{
|
||||||
return null;
|
return null;
|
||||||
}
|
}
|
||||||
|
|
||||||
if (placeholders.isEmpty()) {
|
if (PLACEHOLDERS.isEmpty())
|
||||||
|
{
|
||||||
return colorize ? Msg.color(text) : text;
|
return colorize ? Msg.color(text) : text;
|
||||||
}
|
}
|
||||||
|
|
||||||
final Matcher matcher = RELATIONAL_PLACEHOLDER_PATTERN.matcher(text);
|
final Matcher matcher = RELATIONAL_PLACEHOLDER_PATTERN.matcher(text);
|
||||||
final Map<String, PlaceholderHook> hooks = getPlaceholders();
|
final Map<String, PlaceholderHook> hooks = getPlaceholders();
|
||||||
|
|
||||||
while (matcher.find()) {
|
while (matcher.find())
|
||||||
|
{
|
||||||
final String format = matcher.group(2);
|
final String format = matcher.group(2);
|
||||||
final int index = format.indexOf("_");
|
final int index = format.indexOf("_");
|
||||||
|
|
||||||
if (index <= 0 || index >= format.length()) {
|
if (index <= 0 || index >= format.length())
|
||||||
|
{
|
||||||
continue;
|
continue;
|
||||||
}
|
}
|
||||||
|
|
||||||
@ -392,13 +515,15 @@ public class PlaceholderAPI {
|
|||||||
String params = format.substring(index + 1);
|
String params = format.substring(index + 1);
|
||||||
final PlaceholderHook hook = hooks.get(identifier);
|
final PlaceholderHook hook = hooks.get(identifier);
|
||||||
|
|
||||||
if (!(hook instanceof Relational)) {
|
if (!(hook instanceof Relational))
|
||||||
|
{
|
||||||
continue;
|
continue;
|
||||||
}
|
}
|
||||||
|
|
||||||
final String value = ((Relational) hook).onPlaceholderRequest(one, two, params);
|
final String value = ((Relational) hook).onPlaceholderRequest(one, two, params);
|
||||||
|
|
||||||
if (value != null) {
|
if (value != null)
|
||||||
|
{
|
||||||
text = text.replaceAll(Pattern.quote(matcher.group()), Matcher.quoteReplacement(value));
|
text = text.replaceAll(Pattern.quote(matcher.group()), Matcher.quoteReplacement(value));
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
@ -406,60 +531,14 @@ public class PlaceholderAPI {
|
|||||||
return colorize ? Msg.color(text) : text;
|
return colorize ? Msg.color(text) : text;
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
|
||||||
* Unregister ALL placeholder hooks that are currently registered
|
|
||||||
*/
|
|
||||||
protected static void unregisterAll() {
|
|
||||||
unregisterAllProvidedExpansions();
|
|
||||||
placeholders.clear();
|
|
||||||
}
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Unregister all expansions provided by PlaceholderAPI
|
|
||||||
*/
|
|
||||||
public static void unregisterAllProvidedExpansions() {
|
|
||||||
final Set<PlaceholderHook> set = new HashSet<>(placeholders.values());
|
|
||||||
|
|
||||||
for (PlaceholderHook hook : set) {
|
|
||||||
if (hook instanceof PlaceholderExpansion) {
|
|
||||||
final PlaceholderExpansion expansion = (PlaceholderExpansion) hook;
|
|
||||||
|
|
||||||
if (!expansion.persist()) {
|
|
||||||
unregisterExpansion(expansion);
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
if (hook instanceof Cacheable) {
|
|
||||||
((Cacheable) hook).clear();
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
public static boolean registerExpansion(PlaceholderExpansion ex) {
|
|
||||||
ExpansionRegisterEvent ev = new ExpansionRegisterEvent(ex);
|
|
||||||
Bukkit.getPluginManager().callEvent(ev);
|
|
||||||
if (ev.isCancelled()) {
|
|
||||||
return false;
|
|
||||||
}
|
|
||||||
|
|
||||||
return registerPlaceholderHook(ex.getIdentifier(), ex);
|
|
||||||
}
|
|
||||||
|
|
||||||
public static boolean unregisterExpansion(PlaceholderExpansion ex) {
|
|
||||||
if (unregisterPlaceholderHook(ex.getIdentifier())) {
|
|
||||||
Bukkit.getPluginManager().callEvent(new ExpansionUnregisterEvent(ex));
|
|
||||||
return true;
|
|
||||||
}
|
|
||||||
|
|
||||||
return false;
|
|
||||||
}
|
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Gets the placeholder pattern for the default placeholders.
|
* Gets the placeholder pattern for the default placeholders.
|
||||||
*
|
*
|
||||||
* @return The pattern for {@literal %<identifier>_<params>%}
|
* @return The pattern for {@literal %<identifier>_<params>%}
|
||||||
*/
|
*/
|
||||||
public static Pattern getPlaceholderPattern() {
|
@Deprecated
|
||||||
|
public static Pattern getPlaceholderPattern()
|
||||||
|
{
|
||||||
return PLACEHOLDER_PATTERN;
|
return PLACEHOLDER_PATTERN;
|
||||||
}
|
}
|
||||||
|
|
||||||
@ -468,7 +547,9 @@ public class PlaceholderAPI {
|
|||||||
*
|
*
|
||||||
* @return The pattern for {@literal {<identifier>_<params>}}
|
* @return The pattern for {@literal {<identifier>_<params>}}
|
||||||
*/
|
*/
|
||||||
public static Pattern getBracketPlaceholderPattern() {
|
@Deprecated
|
||||||
|
public static Pattern getBracketPlaceholderPattern()
|
||||||
|
{
|
||||||
return BRACKET_PLACEHOLDER_PATTERN;
|
return BRACKET_PLACEHOLDER_PATTERN;
|
||||||
}
|
}
|
||||||
|
|
||||||
@ -477,59 +558,66 @@ public class PlaceholderAPI {
|
|||||||
*
|
*
|
||||||
* @return The pattern for {@literal %rel_<identifier>_<params>%}
|
* @return The pattern for {@literal %rel_<identifier>_<params>%}
|
||||||
*/
|
*/
|
||||||
public static Pattern getRelationalPlaceholderPattern() {
|
@Deprecated
|
||||||
|
public static Pattern getRelationalPlaceholderPattern()
|
||||||
|
{
|
||||||
return RELATIONAL_PLACEHOLDER_PATTERN;
|
return RELATIONAL_PLACEHOLDER_PATTERN;
|
||||||
}
|
}
|
||||||
|
|
||||||
|
|
||||||
@Deprecated
|
@Deprecated
|
||||||
public static Set<String> getRegisteredPlaceholderPlugins() {
|
public static Set<String> getRegisteredPlaceholderPlugins()
|
||||||
|
{
|
||||||
return getRegisteredIdentifiers();
|
return getRegisteredIdentifiers();
|
||||||
}
|
}
|
||||||
|
|
||||||
@Deprecated
|
@Deprecated
|
||||||
public static Set<String> getExternalPlaceholderPlugins() {
|
public static Set<String> getExternalPlaceholderPlugins()
|
||||||
|
{
|
||||||
return null;
|
return null;
|
||||||
}
|
}
|
||||||
|
|
||||||
@Deprecated
|
|
||||||
public static boolean registerPlaceholderHook(Plugin plugin, PlaceholderHook placeholderHook) {
|
|
||||||
return plugin != null && registerPlaceholderHook(plugin.getName(), placeholderHook);
|
|
||||||
}
|
|
||||||
|
|
||||||
@Deprecated
|
@Deprecated
|
||||||
public static boolean unregisterPlaceholderHook(Plugin plugin) {
|
public static String setPlaceholders(Player player, String text, boolean colorize)
|
||||||
return plugin != null && unregisterPlaceholderHook(plugin.getName());
|
{
|
||||||
}
|
|
||||||
|
|
||||||
public static String setPlaceholders(Player player, String text) {
|
|
||||||
return setPlaceholders(player, text, PLACEHOLDER_PATTERN, true);
|
|
||||||
}
|
|
||||||
|
|
||||||
public static String setPlaceholders(Player player, String text, boolean colorize) {
|
|
||||||
return setPlaceholders(player, text, PLACEHOLDER_PATTERN, colorize);
|
return setPlaceholders(player, text, PLACEHOLDER_PATTERN, colorize);
|
||||||
}
|
}
|
||||||
|
|
||||||
public static List<String> setPlaceholders(Player player, List<String> text) {
|
@Deprecated
|
||||||
|
public static List<String> setPlaceholders(Player player, List<String> text)
|
||||||
|
{
|
||||||
return setPlaceholders(player, text, PLACEHOLDER_PATTERN, true);
|
return setPlaceholders(player, text, PLACEHOLDER_PATTERN, true);
|
||||||
}
|
}
|
||||||
|
|
||||||
public static List<String> setPlaceholders(Player player, List<String> text, boolean colorize) {
|
@Deprecated
|
||||||
|
public static List<String> setPlaceholders(Player player, List<String> text, boolean colorize)
|
||||||
|
{
|
||||||
return setPlaceholders(player, text, PLACEHOLDER_PATTERN, colorize);
|
return setPlaceholders(player, text, PLACEHOLDER_PATTERN, colorize);
|
||||||
}
|
}
|
||||||
|
|
||||||
public static String setBracketPlaceholders(Player player, String text) {
|
@Deprecated
|
||||||
|
public static String setBracketPlaceholders(Player player, String text)
|
||||||
|
{
|
||||||
return setPlaceholders(player, text, BRACKET_PLACEHOLDER_PATTERN, true);
|
return setPlaceholders(player, text, BRACKET_PLACEHOLDER_PATTERN, true);
|
||||||
}
|
}
|
||||||
|
|
||||||
public static String setBracketPlaceholders(Player player, String text, boolean colorize) {
|
@Deprecated
|
||||||
|
public static String setBracketPlaceholders(Player player, String text, boolean colorize)
|
||||||
|
{
|
||||||
return setPlaceholders(player, text, BRACKET_PLACEHOLDER_PATTERN, colorize);
|
return setPlaceholders(player, text, BRACKET_PLACEHOLDER_PATTERN, colorize);
|
||||||
}
|
}
|
||||||
|
|
||||||
public static List<String> setBracketPlaceholders(Player player, List<String> text) {
|
@Deprecated
|
||||||
|
public static List<String> setBracketPlaceholders(Player player, List<String> text)
|
||||||
|
{
|
||||||
return setPlaceholders(player, text, BRACKET_PLACEHOLDER_PATTERN, true);
|
return setPlaceholders(player, text, BRACKET_PLACEHOLDER_PATTERN, true);
|
||||||
}
|
}
|
||||||
|
|
||||||
public static List<String> setBracketPlaceholders(Player player, List<String> text, boolean colorize) {
|
@Deprecated
|
||||||
|
public static List<String> setBracketPlaceholders(Player player, List<String> text, boolean colorize)
|
||||||
|
{
|
||||||
return setPlaceholders(player, text, BRACKET_PLACEHOLDER_PATTERN, colorize);
|
return setPlaceholders(player, text, BRACKET_PLACEHOLDER_PATTERN, colorize);
|
||||||
}
|
}
|
||||||
|
|
||||||
}
|
}
|
Loading…
Reference in New Issue
Block a user