Package com.hypherionmc.simplerpc.api.variables

Class PlaceholderEngine

java.lang.Object

com.hypherionmc.simplerpc.api.variables.PlaceholderEngine

public final class PlaceholderEngine
extends Object

Field Summary

Fields

Modifier and Type	Field	Description
static final PlaceholderEngine	INSTANCE

Constructor Summary

Constructors

Constructor	Description
PlaceholderEngine()

Method Summary

Modifier and Type	Method	Description
void	clear()	Clear all registered placeholders
void	registerPlaceholder(String holder, Validator validator, String defaultValue, UnsafeSupplier<String> resolver)	Register a new placeholder, that is only active when certain checks are met
void	registerPlaceholder(String holder, String defaultValue, UnsafeSupplier<String> resolver)	Register a new placeholder that is always active, and will always return a value
String	resolvePlaceholders(String inputString)	Resolve all valid placeholders in a string

Methods inherited from class java.lang.Object

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

Field Details

INSTANCE

public static final PlaceholderEngine INSTANCE

Constructor Details

PlaceholderEngine

public PlaceholderEngine()

Method Details

registerPlaceholder

public void registerPlaceholder(String holder,
 String defaultValue,
 UnsafeSupplier<String> resolver)

Register a new placeholder that is always active, and will always return a value

Parameters:

holder - The placeholder name. Will resolve to {{placeholdername}}

defaultValue - The default value to return, if the intended value cannot be resolved

resolver - The UnsafeSupplier that will resolve the final value

registerPlaceholder

public void registerPlaceholder(String holder,
 Validator validator,
 String defaultValue,
 UnsafeSupplier<String> resolver)

Register a new placeholder, that is only active when certain checks are met

Parameters:

holder - The placeholder name. Will resolve to {{placeholdername}}

validator - A Validator to use to determine if the placeholder can be used

defaultValue - The default value to return, if the intended value cannot be resolved

resolver - The UnsafeSupplier that will resolve the final value

resolvePlaceholders

public String resolvePlaceholders(String inputString)

Resolve all valid placeholders in a string

Parameters:

inputString - The string to process

Returns:

The fully resolved string, with placeholders removed

clear

public void clear()

Clear all registered placeholders