org.spongepowered.api.text.translation

Interface Translation

All Known Implementing Classes:

FixedTranslation, ResourceBundleTranslation

public interface Translation

Represents an identifier for text that can be translated into multiple languages. Minecraft-included translations are generally translated clientside. Translations not included in Minecraft are generally expected to be translated server-side, for example using Gettext or a ResourceBundle

Some translations require parameters to be sent together with them, if they're not given they will be filled with empty text.

While the client has multiple locales available, server-side vanilla translations usually support only NamedLocales.AMERICAN_ENGLISH.

Method Summary

Modifier and Type	Method and Description
default String	get() Gets the default translation without extra parameters.
String	get(Locale locale) Gets the translation without any parameters replaced.
String	get(Locale locale, Object... args) Gets the translation format with the specified parameters.
default String	get(Object... args) Gets the default translation format with the specified parameters.
String	getId() Gets the identifier for this Translation.

Method Detail

getId

String getId()

Gets the identifier for this Translation.

Returns:

The translation identifier of this translation

get

default String get()

Gets the default translation without extra parameters.

Returns:

The default translation

get

default String get(Object... args)

Gets the default translation format with the specified parameters.

Parameters:

args - The parameters for this translation

Returns:

The default translation with the specified parameters

get

String get(Locale locale)

Gets the translation without any parameters replaced.

Parameters:

locale - The language to get the translated format string for

Returns:

The translation without any parameters

get

String get(Locale locale,
           Object... args)

Gets the translation format with the specified parameters.

Parameters:

locale - The language to get the translated string for

args - The parameters for this translation

Returns:

The translation with the specified parameters