org.olat.core.util.i18n
Class I18nItem

java.lang.Object
  org.olat.core.util.i18n.I18nItem

public class I18nItem
extends java.lang.Object

Description:

The I18nItem represents a unique identifiable translation item within the system consisting of

• the bundle (org.olat.core)
• the key (my.example.title)
• the locale (de)

To get the translated value for such a string, use the i18nManager.getI18nValue() method

Initial Date: 08.09.2008

Author:

Florian Gnaegi, frentix GmbH, http://www.frentix.com

Constructor Summary

I18nItem(java.lang.String packageName, java.lang.String key, java.util.Locale locale, int bundlePriority, int keyPriority)
Constructor.

Method Summary

java.lang.String	getBundleName()
int	getBundlePriority()
java.lang.String	getKey()
int	getKeyPriority()
java.util.Locale	getLocale()

Methods inherited from class java.lang.Object

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

Constructor Detail

I18nItem

public I18nItem(java.lang.String packageName,
                java.lang.String key,
                java.util.Locale locale,
                int bundlePriority,
                int keyPriority)

Constructor. Use the I18nManager methods to create instances of I18nItems

Parameters:

packageName -

key -

locale -

bundlePriority -

keyPriority -

Method Detail

getBundleName

public java.lang.String getBundleName()

Returns:

the package name of this item

getBundlePriority

public int getBundlePriority()

Returns:

The bundles priority that can be used for sorting between bundles

getKey

public java.lang.String getKey()

Returns:

The key for this item which is valid within the package

getKeyPriority

public int getKeyPriority()

Returns:

The keys priority that can be used for sorting with in a bundle

getLocale

public java.util.Locale getLocale()

Returns:

The locale for this item