com.izforge.izpack.api.data

Class LocaleDatabase

java.lang.Object

java.util.AbstractMap<K,V>

java.util.TreeMap<String,String>

com.izforge.izpack.api.data.LocaleDatabase

All Implemented Interfaces:

Messages, Serializable, Cloneable, Map<String,String>, NavigableMap<String,String>, SortedMap<String,String>

public class LocaleDatabase
extends TreeMap<String,String>
implements Messages

Represents a database of a locale.

Author:

Julien Ponge, J. Chris Folsom

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class java.util.AbstractMap

AbstractMap.SimpleEntry<K,V>, AbstractMap.SimpleImmutableEntry<K,V>

Constructor Summary

Constructors

Constructor and Description
LocaleDatabase(InputStream in, Locales locales) Constructs a LocaleDatabase.
LocaleDatabase(InputStream in, Messages parent, Locales locales) Constructs a LocaleDatabase.
LocaleDatabase(Messages parent, Locales locales) Constructs a LocaleDatabase.

Method Summary

Modifier and Type	Method and Description
void	add(InputStream in) Adds the contents of the given stream to the data base.
void	add(Messages messages) Adds messages.
String	get(Object id) Returns the message with the specified identifier.
String	get(String id, Object... args) Formats the message with the specified identifier, replacing placeholders with the supplied arguments.
Map<String,String>	getMessages() Returns the messages.
String	getString(String key, String[] variables) Convenience method to retrieve an element and simultaneously insert variables into the string.
Messages	newMessages(String name) Creates a new messages instance from the named resource that inherits the current messages.

Methods inherited from class java.util.TreeMap

ceilingEntry, ceilingKey, clear, clone, comparator, containsKey, containsValue, descendingKeySet, descendingMap, entrySet, firstEntry, firstKey, floorEntry, floorKey, forEach, headMap, headMap, higherEntry, higherKey, keySet, lastEntry, lastKey, lowerEntry, lowerKey, navigableKeySet, pollFirstEntry, pollLastEntry, put, putAll, remove, replace, replace, replaceAll, size, subMap, subMap, tailMap, tailMap, values

Methods inherited from class java.util.AbstractMap

equals, hashCode, isEmpty, toString

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.util.Map

compute, computeIfAbsent, computeIfPresent, equals, getOrDefault, hashCode, isEmpty, merge, putIfAbsent, remove

Constructor Detail

LocaleDatabase

public LocaleDatabase(InputStream in,
                      Locales locales)

Constructs a LocaleDatabase.

Parameters:

in - the stream to read the translation from

locales - the supported locales

Throws:

ResourceException - if the stream is not an IzPack langpack file

LocaleDatabase

public LocaleDatabase(Messages parent,
                      Locales locales)

Constructs a LocaleDatabase.

Parameters:

parent - the parent messages. May be null

locales - the supported locales

LocaleDatabase

public LocaleDatabase(InputStream in,
                      Messages parent,
                      Locales locales)

Constructs a LocaleDatabase.

Parameters:

in - the stream to read the translation from. May be null

parent - the parent messages. May be null

locales - the supported locales

Throws:

ResourceException - if the stream is not an IzPack langpack file

Method Detail

add

public void add(InputStream in)

Adds the contents of the given stream to the data base. The stream have to contain key value pairs as declared by the DTD langpack.dtd.

Parameters:

in - an InputStream to read the translation from.

Throws:

ResourceException - if the stream is not an IzPack langpack file or cannot be read

get

public String get(Object id)

Returns the message with the specified identifier.

Specified by:

get in interface Map<String,String>

Overrides:

get in class TreeMap<String,String>

Parameters:

id - the message identifier

Returns:

the corresponding message, or id if the message does not exist

get

public String get(String id,
                  Object... args)

Formats the message with the specified identifier, replacing placeholders with the supplied arguments.

This uses MessageFormat to format the message.

Specified by:

get in interface Messages

Parameters:

id - the message identifier

args - message arguments to replace placeholders in the message with

Returns:

the corresponding message, or id if the message does not exist

add

public void add(Messages messages)

Adds messages.

This merges the supplied messages with the current messages. If an existing message exists with the same identifier as that supplied, it will be replaced.

Specified by:

add in interface Messages

Parameters:

messages - the messages to add

getMessages

public Map<String,String> getMessages()

Returns the messages.

Specified by:

getMessages in interface Messages

Returns:

the message identifiers, and their corresponding formats

newMessages

public Messages newMessages(String name)

Creates a new messages instance from the named resource that inherits the current messages.

Specified by:

newMessages in interface Messages

Parameters:

name - the messages resource name

Returns:

the messages

getString

public String getString(String key,
                        String[] variables)

Convenience method to retrieve an element and simultaneously insert variables into the string. A place holder has to be build with the substring {n} where n is the parameter argument beginning with 0. The first argument is therefore {0}. If a parameter starts with a dollar sign the value will be used as key into the LocalDatabase. The key can be written as $MYKEY or ${MYKEY}. For all place holders an argument should be exist and vis a versa.

Parameters:

key - The key of the element to retrieve.

variables - the variables to insert

Returns:

The element value with the variables inserted or the key if not found.