Translator (ArgoUML Javadoc for internal use)

Overview

Package

Class

Use

Tree

Deprecated

Index

Help

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

org.argouml.i18n
Class Translator

java.lang.Object
  org.argouml.i18n.Translator

The API class to the localization. All localization calls goes through this class.

Method Summary
`static void`	`addClassLoader(ClassLoader cl)` Add another class loader that the resource bundle could be located through.
`static Locale[]`	`getLocales()` For Locale selection.
`static void`	`init()` Default Locale is set and resources Bundles are loaded.
`static String`	`localize(String key)` The main function of this class that localizes strings.
`static String`	`localize(String key, Object[] args)` Synonym for messageFormat to encourage developers to convert existing uses of localize() + string concatentation to use this method instead.
`static String`	`messageFormat(String key, Object[] args)` Generates an localized String with arguments.
`static void`	`setLocale(Locale locale)` Change the current Locale.
`static void`	`setLocale(String name)` Change the current Locale.

Methods inherited from class java.lang.Object

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

Method Detail

public static void init()

Default Locale is set and resources Bundles are loaded.

public static Locale[] getLocales()

For Locale selection.

TODO: Detect the available locales from the available files.

public static void setLocale(String name)

Change the current Locale. The string with the name follows this BNF format:

language [ "_" country ]

public static void setLocale(Locale locale)

Change the current Locale.

public static void addClassLoader(ClassLoader cl)

Add another class loader that the resource bundle could be located through.

public static String localize(String key,
                              Object[] args)

Synonym for messageFormat to encourage developers to convert existing uses of localize() + string concatentation to use this method instead.

public static String localize(String key)

The main function of this class that localizes strings.

public static String messageFormat(String key,
                                   Object[] args)

Generates an localized String with arguments.

The localized string is a pattern to be processed by MessageFormat.

Parameters:: key - the key to localize; args - the args as Objects, inserted in the localized String
Returns:: the localized String with inserted arguments