com.djrapitops.plan.placeholder

Class PlanPlaceholders

java.lang.Object

com.djrapitops.plan.placeholder.PlanPlaceholders

@Singleton
public final class PlanPlaceholders
extends java.lang.Object

Registry for all placeholders.

See Also:

Placeholders about the current server, Placeholders about operators of the current server, Placeholders about the current player on the whole network, Placeholders about the player on the current server, Placeholders about the world times of current player on the current server

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	PlanPlaceholders.PlayerPlaceholderLoader
static interface	PlanPlaceholders.StaticPlaceholderLoader

Constructor Summary

Constructors

Constructor and Description
PlanPlaceholders(PlanConfig config, DBSystem dbSystem, ServerInfo serverInfo, Formatters formatters, java.util.Set<Placeholders> placeholderRegistries)

Method Summary

Modifier and Type	Method and Description
java.util.Map<java.lang.String,PlanPlaceholders.PlayerPlaceholderLoader>	getPlaceholders()
java.util.Map<java.lang.String,PlanPlaceholders.StaticPlaceholderLoader>	getStaticPlaceholders()
java.lang.String	onPlaceholderRequest(PlayerContainer player, java.lang.String placeholder, java.util.List<java.lang.String> parameters) Look up the placeholder and check if it is registered.
java.lang.String	onPlaceholderRequest(java.util.UUID uuid, java.lang.String placeholder, java.util.List<java.lang.String> parameters)
void	register(java.lang.String name, java.util.function.Function<PlayerContainer,java.io.Serializable> loader)
void	register(java.lang.String name, PlanPlaceholders.PlayerPlaceholderLoader loader)
void	registerRaw(java.lang.String name, java.util.function.BiFunction<java.lang.String,PlayerContainer,java.io.Serializable> loader)
void	registerStatic(java.lang.String name, PlanPlaceholders.StaticPlaceholderLoader loader)
void	registerStatic(java.lang.String name, java.util.function.Supplier<java.io.Serializable> loader)

Methods inherited from class java.lang.Object

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

Constructor Detail

PlanPlaceholders

@Inject
public PlanPlaceholders(PlanConfig config,
                                DBSystem dbSystem,
                                ServerInfo serverInfo,
                                Formatters formatters,
                                java.util.Set<Placeholders> placeholderRegistries)

Method Detail

registerStatic

public void registerStatic(java.lang.String name,
                           java.util.function.Supplier<java.io.Serializable> loader)

registerStatic

public void registerStatic(java.lang.String name,
                           PlanPlaceholders.StaticPlaceholderLoader loader)

register

public void register(java.lang.String name,
                     java.util.function.Function<PlayerContainer,java.io.Serializable> loader)

register

public void register(java.lang.String name,
                     PlanPlaceholders.PlayerPlaceholderLoader loader)

registerRaw

public void registerRaw(java.lang.String name,
                        java.util.function.BiFunction<java.lang.String,PlayerContainer,java.io.Serializable> loader)

getPlaceholders

public java.util.Map<java.lang.String,PlanPlaceholders.PlayerPlaceholderLoader> getPlaceholders()

getStaticPlaceholders

public java.util.Map<java.lang.String,PlanPlaceholders.StaticPlaceholderLoader> getStaticPlaceholders()

onPlaceholderRequest

public java.lang.String onPlaceholderRequest(java.util.UUID uuid,
                                             java.lang.String placeholder,
                                             java.util.List<java.lang.String> parameters)

onPlaceholderRequest

public java.lang.String onPlaceholderRequest(PlayerContainer player,
                                             java.lang.String placeholder,
                                             java.util.List<java.lang.String> parameters)

Look up the placeholder and check if it is registered.

Parameters:

player - the player who is viewing the placeholder

placeholder - the placeholder to look up to.

parameters - additional placeholder parameters

Returns:

the value of the placeholder if found, or empty String if no value found but the placeholder is registered, otherwise null