org.mini2Dx.gettext

Class GetText

java.lang.Object

org.mini2Dx.gettext.GetText

public class GetText
extends java.lang.Object

Main class for using gettext. Most developer should just need this class and calling add(PoFile) to add translations.

By default, the Locale is set to Locale.ENGLISH. This can be changed via setLocale(Locale)

Constructor Summary

Constructors

Constructor and Description
GetText()

Method Summary

Modifier and Type	Method and Description
static void	add(PoFile poFile) Loads a PoFile for translation usage.
static TranslationEntry	getTranslationEntry(java.util.Locale locale, java.lang.String context, java.lang.String sourceText) Returns the underlying TranslationEntry for a specific msgid
static void	setLocale(java.util.Locale locale) Sets the default Locale
static java.lang.String	tr(java.util.Locale locale, java.lang.String sourceText) Same as tr(String) using a specific Locale
static java.lang.String	tr(java.util.Locale locale, java.lang.String sourceText, java.lang.Object... values) Same as tr(String, Object...) using a specific Locale
static java.lang.String	tr(java.lang.String sourceText) Translates source based on currently set Locale
static java.lang.String	tr(java.lang.String sourceText, java.lang.Object... values) Translates source based on currently set Locale and injects values into the text
static java.lang.String	trc(java.util.Locale locale, java.lang.String context, java.lang.String sourceText) Same as trc(String, String) using a specific Locale
static java.lang.String	trc(java.util.Locale locale, java.lang.String context, java.lang.String sourceText, java.lang.Object... values) Same as trc(String, String, Object...) using a specific Locale
static java.lang.String	trc(java.lang.String context, java.lang.String sourceText) Translates source based on currently set Locale based on a specified context
static java.lang.String	trc(java.lang.String context, java.lang.String sourceText, java.lang.Object... values) Translates source based on currently set Locale based on a specified context and injects values into the text
static java.lang.String	trn(java.util.Locale locale, java.lang.String sourceText, java.lang.String sourcePluralText, int n) Same as trn(String, String, int) using a specific Locale
static java.lang.String	trn(java.util.Locale locale, java.lang.String sourceText, java.lang.String sourcePluralText, int n, java.lang.Object... values) Same as trn(String, String, int, Object...) using a specific Locale
static java.lang.String	trn(java.lang.String sourceText, java.lang.String sourcePluralText, int n) Translates the plural form of a source based on currently set Locale
static java.lang.String	trn(java.lang.String sourceText, java.lang.String sourcePluralText, int n, java.lang.Object... values) Translates the plural form of a source based on currently set Locale and injects values into the text
static java.lang.String	trnc(java.util.Locale locale, java.lang.String context, java.lang.String sourceText, java.lang.String sourcePluralText, int n) Same as trnc(String, String, String, int) using a specific Locale
static java.lang.String	trnc(java.util.Locale locale, java.lang.String context, java.lang.String sourceText, java.lang.String sourcePluralText, int n, java.lang.Object... values) Same as trnc(String, String, String, int, Object...) using a specific Locale
static java.lang.String	trnc(java.lang.String context, java.lang.String sourceText, java.lang.String sourcePluralText, int n) Translates the plural form of a source based on currently set Locale based on a specified context
static java.lang.String	trnc(java.lang.String context, java.lang.String sourceText, java.lang.String sourcePluralText, int n, java.lang.Object... values) Translates the plural form of a source based on currently set Locale based on a specified context and injects values into the text

Methods inherited from class java.lang.Object

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

Constructor Detail

GetText

public GetText()

Method Detail

tr

public static java.lang.String tr(java.lang.String sourceText)

Translates source based on currently set Locale

Parameters:

sourceText - The source text to translate (msgid)

Returns:

The source text if no translation can be found, else returns msgstr

tr

public static java.lang.String tr(java.lang.String sourceText,
                                  java.lang.Object... values)

Translates source based on currently set Locale and injects values into the text

Parameters:

sourceText - The source text to translate (msgid)

values - The values to be injected using MessageFormat

Returns:

The source text if no translation can be found, else returns msgstr

trc

public static java.lang.String trc(java.lang.String context,
                                   java.lang.String sourceText)

Translates source based on currently set Locale based on a specified context

Parameters:

context - The translation context (msgctxt)

sourceText - The source text to translate (msgid)

Returns:

The source text if no translation can be found, else returns msgstr

trc

public static java.lang.String trc(java.lang.String context,
                                   java.lang.String sourceText,
                                   java.lang.Object... values)

Translates source based on currently set Locale based on a specified context and injects values into the text

Parameters:

context - The translation context (msgctxt)

sourceText - The source text to translate (msgid)

values - The values to be injected using MessageFormat

Returns:

The source text if no translation can be found, else returns msgstr

trn

public static java.lang.String trn(java.lang.String sourceText,
                                   java.lang.String sourcePluralText,
                                   int n)

Translates the plural form of a source based on currently set Locale

Parameters:

sourceText - The source text to translate (msgid)

sourcePluralText - The plural source text to translate (msgid_plural)

n - The plural index (msgstr[n])

Returns:

The source text if no translation can be found, else returns msgstr[n]

trn

public static java.lang.String trn(java.lang.String sourceText,
                                   java.lang.String sourcePluralText,
                                   int n,
                                   java.lang.Object... values)

Translates the plural form of a source based on currently set Locale and injects values into the text

Parameters:

sourceText - The source text to translate (msgid)

sourcePluralText - The plural source text to translate (msgid_plural)

n - The plural index (msgstr[n])

values - The values to be injected using MessageFormat

Returns:

The source text if no translation can be found, else returns msgstr[n]

trnc

public static java.lang.String trnc(java.lang.String context,
                                    java.lang.String sourceText,
                                    java.lang.String sourcePluralText,
                                    int n)

Translates the plural form of a source based on currently set Locale based on a specified context

Parameters:

context - The translation context (msgctxt)

sourceText - The source text to translate (msgid)

sourcePluralText - The plural source text to translate (msgid_plural)

n - The plural index (msgstr[n])

Returns:

The source text if no translation can be found, else returns msgstr[n]

trnc

public static java.lang.String trnc(java.lang.String context,
                                    java.lang.String sourceText,
                                    java.lang.String sourcePluralText,
                                    int n,
                                    java.lang.Object... values)

Translates the plural form of a source based on currently set Locale based on a specified context and injects values into the text

Parameters:

context - The translation context (msgctxt)

sourceText - The source text to translate (msgid)

sourcePluralText - The plural source text to translate (msgid_plural)

n - The plural index (msgstr[n])

values - The values to be injected using MessageFormat

Returns:

The source text if no translation can be found, else returns msgstr[n]

tr

public static java.lang.String tr(java.util.Locale locale,
                                  java.lang.String sourceText)

Same as tr(String) using a specific Locale

tr

public static java.lang.String tr(java.util.Locale locale,
                                  java.lang.String sourceText,
                                  java.lang.Object... values)

Same as tr(String, Object...) using a specific Locale

trc

public static java.lang.String trc(java.util.Locale locale,
                                   java.lang.String context,
                                   java.lang.String sourceText)

Same as trc(String, String) using a specific Locale

trc

public static java.lang.String trc(java.util.Locale locale,
                                   java.lang.String context,
                                   java.lang.String sourceText,
                                   java.lang.Object... values)

Same as trc(String, String, Object...) using a specific Locale

trn

public static java.lang.String trn(java.util.Locale locale,
                                   java.lang.String sourceText,
                                   java.lang.String sourcePluralText,
                                   int n)

Same as trn(String, String, int) using a specific Locale

trn

public static java.lang.String trn(java.util.Locale locale,
                                   java.lang.String sourceText,
                                   java.lang.String sourcePluralText,
                                   int n,
                                   java.lang.Object... values)

Same as trn(String, String, int, Object...) using a specific Locale

trnc

public static java.lang.String trnc(java.util.Locale locale,
                                    java.lang.String context,
                                    java.lang.String sourceText,
                                    java.lang.String sourcePluralText,
                                    int n)

Same as trnc(String, String, String, int) using a specific Locale

trnc

public static java.lang.String trnc(java.util.Locale locale,
                                    java.lang.String context,
                                    java.lang.String sourceText,
                                    java.lang.String sourcePluralText,
                                    int n,
                                    java.lang.Object... values)

Same as trnc(String, String, String, int, Object...) using a specific Locale

getTranslationEntry

public static TranslationEntry getTranslationEntry(java.util.Locale locale,
                                                   java.lang.String context,
                                                   java.lang.String sourceText)

Returns the underlying TranslationEntry for a specific msgid

Parameters:

locale - The Locale to look up

context - Null if default context should be used, or, msgctxt

sourceText - The source text to translate (msgid)

Returns:

Null if no such entry exists

add

public static void add(PoFile poFile)

Loads a PoFile for translation usage. Note: This does not need to match the current Locale

Parameters:

poFile - A PoFile instance

setLocale

public static void setLocale(java.util.Locale locale)

Sets the default Locale

Parameters:

locale - The Locale to use