com.elikill58.negativity.universal.translation

Interface TranslationProvider

All Known Implementing Classes:

CachingTranslationProvider, ResourceBundleTranslationProvider

public interface TranslationProvider

Provides messages, usually from a specific language.

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.
default @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.
default @Nullable List<String>	getList(String key, Object... placeholders) Returns a message of one or more lines.

Method Detail

get

@Nullable String get(String key)

Returns a message of a single line.

Parameters:

key - the key of the requested message

Returns:

get the message according to the key, or null if not found

get

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

Returns a message of a single line.

Parameters:

key - the key of the requested message

placeholders - the placeholders to use in this message

Returns:

get the message according to the key, or null if not found and replace placehodlers

getList

@Nullable List<String> getList(String key)

Returns a message of one or more lines.

Parameters:

key - the key of the requested message

Returns:

get all messages according to the key, or null if not found

getList

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

Returns a message of one or more lines.

Parameters:

key - the key of the requested message

placeholders - the placeholders to use in this message

Returns:

get all messages according to the key, or null if not found

applyPlaceholders

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

Applied placeholders to the given raw message.

Parameters:

raw - the raw message to process

placeholders - placeholders to use

Returns:

the message with placeholders applied