net.lenni0451.mcstructs.text.translation

Interface Translator

All Known Implementing Classes:

BasicTranslator

Functional Interface:

This is a functional interface and can therefore be used as the assignment target for a lambda expression or method reference.

@FunctionalInterface
public interface Translator

Field Summary

Fields

Modifier and Type	Field	Description
static BasicTranslator	GLOBAL	The global translator that is used by default.

Method Summary

Modifier and Type	Method	Description
java.lang.String	translate(java.lang.String key)	Translate the given key.
default java.lang.String	translateOrKey(java.lang.String key)	Translate the given key.

Field Detail

GLOBAL

static final BasicTranslator GLOBAL

The global translator that is used by default.

Method Detail

translate

@Nullable
java.lang.String translate(java.lang.String key)

Translate the given key.
Return null if the key is not found.

Parameters:

key - The key to translate

Returns:

The translated key or null

translateOrKey

default java.lang.String translateOrKey(java.lang.String key)

Translate the given key.
If the key is not found return the key itself.

Parameters:

key - The key to translate

Returns:

The translated key or the key itself