Package me.remigio07.chatplugin.api.server.util.manager

Class PlaceholderManager

java.lang.Object

me.remigio07.chatplugin.api.server.util.manager.PlaceholderManager

All Implemented Interfaces:

Runnable, ChatPluginManager

public abstract class PlaceholderManager
extends Object
implements ChatPluginManager, Runnable

Manager that handles ChatPlugin's integrated (and its integrations') placeholders.

See Also:

• ChatPlugin wiki/Modules/Placeholders
• PlaceholderType

Constructor Summary

Constructors

Constructor	Description
PlaceholderManager()

Method Summary

Modifier and Type	Method	Description
static PlaceholderManager	getInstance()	Gets this manager's instance.
long	getTimerTaskID()	Gets the update task's ID.
boolean	isEnabled()	Checks if this manager is enabled.
abstract void	run()	Storage's placeholders updater, called once every settings.storage-placeholders-update-timeout in config.yml.
String	translateIntegrationsPlaceholders(String input, ChatPluginServerPlayer player)	Translates an input string with PlaceholderType.INTEGRATIONS placeholders, formatted for the specified player and translated for the player's language.
String	translateIntegrationsPlaceholders(String input, ChatPluginServerPlayer player, Language language)	Translates an input string with PlaceholderType.INTEGRATIONS placeholders, formatted for the specified player and translated for the specified language.
abstract String	translateIntegrationsPlaceholders(String input, ChatPluginServerPlayer player, Language language, boolean translateColors)	Translates an input string with PlaceholderType.INTEGRATIONS placeholders, formatted for the specified player and translated for the specified language.
List<String>	translateIntegrationsPlaceholders(List<String> input, ChatPluginServerPlayer player)	Translates an input string list with PlaceholderType.INTEGRATIONS placeholders, formatted for the specified player and translated for the player's language.
List<String>	translateIntegrationsPlaceholders(List<String> input, ChatPluginServerPlayer player, Language language)	Translates an input string list with PlaceholderType.INTEGRATIONS placeholders, formatted for the specified player and translated for the specified language.
String	translatePlaceholders(String input, ChatPluginServerPlayer player, List<PlaceholderType> placeholderTypes)	Translates an input string with placeholders, formatted for the specified player and translated for the player's language.
String	translatePlaceholders(String input, ChatPluginServerPlayer player, Language language, List<PlaceholderType> placeholderTypes)	Translates an input string with placeholders, formatted for the specified player and translated for the specified language.
abstract String	translatePlaceholders(String input, ChatPluginServerPlayer player, Language language, List<PlaceholderType> placeholderTypes, boolean translateColors)	Translates an input string with placeholders, formatted for the specified player and translated for the specified language.
List<String>	translatePlaceholders(List<String> input, ChatPluginServerPlayer player, List<PlaceholderType> placeholderTypes)	Translates an input string list with placeholders, formatted for the specified player and translated for the player's language.
List<String>	translatePlaceholders(List<String> input, ChatPluginServerPlayer player, Language language, List<PlaceholderType> placeholderTypes)	Translates an input string list with placeholders, formatted for the specified player and translated for the specified language.
String	translatePlayerPlaceholders(String input, ChatPluginServerPlayer player)	Translates an input string with PlaceholderType.PLAYER placeholders, formatted for the specified player and translated for the player's language.
String	translatePlayerPlaceholders(String input, ChatPluginServerPlayer player, Language language)	Translates an input string with PlaceholderType.PLAYER placeholders, specified player and translated for the specified language.
abstract String	translatePlayerPlaceholders(String input, ChatPluginServerPlayer player, Language language, boolean translateColors)	Translates an input string with PlaceholderType.PLAYER placeholders, formatted for the specified player and translated for the specified language.
List<String>	translatePlayerPlaceholders(List<String> input, ChatPluginServerPlayer player)	Translates an input string list with PlaceholderType.PLAYER placeholders, formatted for the specified player and translated for the player's language.
List<String>	translatePlayerPlaceholders(List<String> input, ChatPluginServerPlayer player, Language language)	Translates an input string list with PlaceholderType.PLAYER placeholders, formatted for the specified player and translated for the specified language.
String	translateServerPlaceholders(String input, Language language)	Translates an input string with PlaceholderType.SERVER placeholders, translated for the specified language.
abstract String	translateServerPlaceholders(String input, Language language, boolean translateColors)	Translates an input string with PlaceholderType.SERVER placeholders, translated for the specified language.
List<String>	translateServerPlaceholders(List<String> input, Language language)	Translates an input string list with PlaceholderType.SERVER placeholders, translated for the specified language.

Methods inherited from class java.lang.Object

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

Methods inherited from interface me.remigio07.chatplugin.api.common.util.manager.ChatPluginManager

checkAvailability, isReloadable, load, reload, unload

Constructor Details

PlaceholderManager

public PlaceholderManager()

Method Details

isEnabled

public boolean isEnabled()

Description copied from interface: ChatPluginManager

Checks if this manager is enabled.

Specified by:

isEnabled in interface ChatPluginManager

Returns:

Whether this manager is enabled

getTimerTaskID

public long getTimerTaskID()

Gets the update task's ID.

You can interact with it through TaskManager's methods.

Returns:

Update task's ID

translatePlaceholders

public String translatePlaceholders(String input,
 ChatPluginServerPlayer player,
 List<PlaceholderType> placeholderTypes)

Translates an input string with placeholders, formatted for the specified player and translated for the player's language.

You have to indicate what placeholder types you need for the string to be translated. Color and formatting codes are already translated.

Parameters:

input - Input containing placeholders

player - Player whose placeholders need to be translated

placeholderTypes - Placeholder types present in the input

Returns:

Translated placeholders

See Also:

• PlaceholderType

translatePlaceholders

public String translatePlaceholders(String input,
 ChatPluginServerPlayer player,
 Language language,
 List<PlaceholderType> placeholderTypes)

Translates an input string with placeholders, formatted for the specified player and translated for the specified language.

You have to indicate what placeholder types you need for the string to be translated. Color and formatting codes are already translated.

Parameters:

input - Input containing placeholders

player - Player whose placeholders need to be translated

language - Language used to translate the placeholders

placeholderTypes - Placeholder types present in the input

Returns:

Translated placeholders

See Also:

• PlaceholderType

translatePlaceholders

public List<String> translatePlaceholders(List<String> input,
 ChatPluginServerPlayer player,
 List<PlaceholderType> placeholderTypes)

Translates an input string list with placeholders, formatted for the specified player and translated for the player's language.

You have to indicate what placeholder types you need for the string to be translated. Color and formatting codes are already translated.

Parameters:

input - Input containing placeholders

player - Player whose placeholders need to be translated

placeholderTypes - Placeholder types present in the input

Returns:

Translated placeholders

See Also:

• PlaceholderType

translatePlaceholders

public List<String> translatePlaceholders(List<String> input,
 ChatPluginServerPlayer player,
 Language language,
 List<PlaceholderType> placeholderTypes)

Translates an input string list with placeholders, formatted for the specified player and translated for the specified language.

You have to indicate what placeholder types you need for the string to be translated. Color and formatting codes are already translated.

Parameters:

input - Input containing placeholders

player - Player whose placeholders need to be translated

language - Language used to translate the placeholders

placeholderTypes - Placeholder types present in the input

Returns:

Translated placeholders

See Also:

• PlaceholderType

translatePlayerPlaceholders

public String translatePlayerPlaceholders(String input,
 ChatPluginServerPlayer player)

Translates an input string with PlaceholderType.PLAYER placeholders, formatted for the specified player and translated for the player's language.

Color and formatting codes are already translated.

Parameters:

input - Input containing placeholders

player - Player whose placeholders need to be translated

Returns:

Translated placeholders

See Also:

• PlaceholderType.PLAYER

translatePlayerPlaceholders

public String translatePlayerPlaceholders(String input,
 ChatPluginServerPlayer player,
 Language language)

Translates an input string with PlaceholderType.PLAYER placeholders, specified player and translated for the specified language.

Color and formatting codes are already translated.

Parameters:

input - Input containing placeholders

player - Player whose placeholders need to be translated

language - Language used to translate the placeholders

Returns:

Translated placeholders

See Also:

• PlaceholderType.PLAYER

translatePlayerPlaceholders

public List<String> translatePlayerPlaceholders(List<String> input,
 ChatPluginServerPlayer player)

Translates an input string list with PlaceholderType.PLAYER placeholders, formatted for the specified player and translated for the player's language.

Color and formatting codes are already translated.

Parameters:

input - Input containing placeholders

player - Player whose placeholders need to be translated

Returns:

Translated placeholders

See Also:

• PlaceholderType.PLAYER

translatePlayerPlaceholders

public List<String> translatePlayerPlaceholders(List<String> input,
 ChatPluginServerPlayer player,
 Language language)

Translates an input string list with PlaceholderType.PLAYER placeholders, formatted for the specified player and translated for the specified language.

Color and formatting codes are already translated.

Parameters:

input - Input containing placeholders

player - Player whose placeholders need to be translated

language - Language used to translate the placeholders

Returns:

Translated placeholders

See Also:

• PlaceholderType.PLAYER

translateServerPlaceholders

public String translateServerPlaceholders(String input,
 Language language)

Translates an input string with PlaceholderType.SERVER placeholders, translated for the specified language.

Color and formatting codes are already translated.

Parameters:

input - Input containing placeholders

language - Language used to translate the placeholders

Returns:

Translated placeholders

See Also:

• PlaceholderType.SERVER

translateServerPlaceholders

public List<String> translateServerPlaceholders(List<String> input,
 Language language)

Translates an input string list with PlaceholderType.SERVER placeholders, translated for the specified language.

Color and formatting codes are already translated.

Parameters:

input - Input containing placeholders

language - Language used to translate the placeholders

Returns:

Translated placeholders

See Also:

• PlaceholderType.SERVER

translateIntegrationsPlaceholders

public String translateIntegrationsPlaceholders(String input,
 ChatPluginServerPlayer player)

Translates an input string with PlaceholderType.INTEGRATIONS placeholders, formatted for the specified player and translated for the player's language.

Color and formatting codes are already translated.

Parameters:

input - Input containing placeholders

player - Player whose placeholders need to be translated

Returns:

Translated placeholders

See Also:

• PlaceholderType.INTEGRATIONS

translateIntegrationsPlaceholders

public String translateIntegrationsPlaceholders(String input,
 ChatPluginServerPlayer player,
 Language language)

Translates an input string with PlaceholderType.INTEGRATIONS placeholders, formatted for the specified player and translated for the specified language.

Color and formatting codes are already translated.

Parameters:

input - Input containing placeholders

player - Player whose placeholders need to be translated

language - Language used to translate the placeholders

Returns:

Translated placeholders

See Also:

• PlaceholderType.INTEGRATIONS

translateIntegrationsPlaceholders

public List<String> translateIntegrationsPlaceholders(List<String> input,
 ChatPluginServerPlayer player)

Translates an input string list with PlaceholderType.INTEGRATIONS placeholders, formatted for the specified player and translated for the player's language.

Color and formatting codes are already translated.

Parameters:

input - Input containing placeholders

player - Player whose placeholders need to be translated

Returns:

Translated placeholders

See Also:

• PlaceholderType.INTEGRATIONS

translateIntegrationsPlaceholders

public List<String> translateIntegrationsPlaceholders(List<String> input,
 ChatPluginServerPlayer player,
 Language language)

Translates an input string list with PlaceholderType.INTEGRATIONS placeholders, formatted for the specified player and translated for the specified language.

Color and formatting codes are already translated.

Parameters:

input - Input containing placeholders

player - Player whose placeholders need to be translated

language - Language used to translate the placeholders

Returns:

Translated placeholders

See Also:

• PlaceholderType.INTEGRATIONS

getInstance

public static PlaceholderManager getInstance()

Gets this manager's instance.

Returns:

Manager's instance

run

public abstract void run()

Storage's placeholders updater, called once every settings.storage-placeholders-update-timeout in config.yml.

Specified by:

run in interface Runnable

translatePlaceholders

public abstract String translatePlaceholders(String input,
 ChatPluginServerPlayer player,
 Language language,
 List<PlaceholderType> placeholderTypes,
 boolean translateColors)

Translates an input string with placeholders, formatted for the specified player and translated for the specified language.

You have to indicate what placeholder types you need for the string to be translated.

Parameters:

input - Input containing placeholders

player - Player whose placeholders need to be translated

language - Language used to translate the placeholders

placeholderTypes - Placeholder types present in the input

translateColors - Whether to ChatColor.translate(String) the output

Returns:

Translated placeholders

See Also:

• PlaceholderType

translatePlayerPlaceholders

public abstract String translatePlayerPlaceholders(String input,
 ChatPluginServerPlayer player,
 Language language,
 boolean translateColors)

Translates an input string with PlaceholderType.PLAYER placeholders, formatted for the specified player and translated for the specified language.

Parameters:

input - Input containing placeholders

player - Player whose placeholders need to be translated

language - Language used to translate the placeholders

translateColors - Whether to ChatColor.translate(String) the output

Returns:

Translated placeholders

See Also:

• PlaceholderType.PLAYER

translateServerPlaceholders

public abstract String translateServerPlaceholders(String input,
 Language language,
 boolean translateColors)

Translates an input string with PlaceholderType.SERVER placeholders, translated for the specified language.

Parameters:

input - Input containing placeholders

language - Language used to translate the placeholders

translateColors - Whether to ChatColor.translate(String) the output

Returns:

Translated placeholders

See Also:

• PlaceholderType.SERVER

translateIntegrationsPlaceholders

public abstract String translateIntegrationsPlaceholders(String input,
 ChatPluginServerPlayer player,
 Language language,
 boolean translateColors)

Translates an input string with PlaceholderType.INTEGRATIONS placeholders, formatted for the specified player and translated for the specified language.

Parameters:

input - Input containing placeholders

player - Player whose placeholders need to be translated

language - Language used to translate the placeholders

translateColors - Whether to ChatColor.translate(String) the output

Returns:

Translated placeholders

See Also:

• PlaceholderType.INTEGRATIONS