com.elikill58.negativity.universal.translation

Class CachingTranslationProvider

java.lang.Object

com.elikill58.negativity.universal.translation.CachingTranslationProvider

All Implemented Interfaces:

TranslationProvider

public final class CachingTranslationProvider
extends Object
implements TranslationProvider

A TranslationProvider that caches results returned from its wrapped provider if possible.

Messages with placeholders cannot be cached.

Constructor Summary

Constructors

Constructor and Description
CachingTranslationProvider(TranslationProvider backingProvider)

Method Summary

Modifier and Type	Method and Description
String	applyPlaceholders(String raw, Object... placeholders) Applied placeholders to the given raw message.
@Nullable String	get(String key) Returns a message of a single line.
@Nullable String	get(String key, Object... placeholders) Returns a message of a single line.
@Nullable List<String>	getList(String key) Returns a message of one or more lines.
@Nullable List<String>	getList(String key, Object... placeholders) Returns a message of one or more lines.

Methods inherited from class java.lang.Object

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

Constructor Detail

CachingTranslationProvider

public CachingTranslationProvider(TranslationProvider backingProvider)

Method Detail

get

public @Nullable String get(String key)

Description copied from interface: TranslationProvider

Returns a message of a single line.

Specified by:

get in interface TranslationProvider

Parameters:

key - the key of the requested message

get

public @Nullable String get(String key,
                            Object... placeholders)

Description copied from interface: TranslationProvider

Returns a message of a single line.

Specified by:

get in interface TranslationProvider

Parameters:

key - the key of the requested message

placeholders - the placeholders to use in this message

getList

public @Nullable List<String> getList(String key)

Description copied from interface: TranslationProvider

Returns a message of one or more lines.

Specified by:

getList in interface TranslationProvider

Parameters:

key - the key of the requested message

getList

public @Nullable List<String> getList(String key,
                                      Object... placeholders)

Description copied from interface: TranslationProvider

Returns a message of one or more lines.

Specified by:

getList in interface TranslationProvider

Parameters:

key - the key of the requested message

placeholders - the placeholders to use in this message

applyPlaceholders

public String applyPlaceholders(String raw,
                                Object... placeholders)

Description copied from interface: TranslationProvider

Applied placeholders to the given raw message.

Specified by:

applyPlaceholders in interface TranslationProvider

Parameters:

raw - the raw message to process

placeholders - placeholders to use

Returns:

the message with placeholders applied