net.sf.freecol.client.gui.i18n

Class Messages

java.lang.Object

net.sf.freecol.client.gui.i18n.Messages

public class Messages
extends java.lang.Object

Represents a collection of messages in a particular locale. The individual messages are read from property files in the data/strings directory. The property files are called "FreeColMessages[_LANGUAGE[_COUNTRY[_VARIANT]]].properties", where LANGUAGE should be an ISO 639-2 or ISO 639-3 language code, COUNTRY should be an ISO 3166-2 country code, and VARIANT is an arbitrary string. The encoding of the property files is UTF-8. Since the Java Properties class is unable to handle UTF-8 directly, this class uses its own implementation. Te individual messages may include variables, which must be delimited by percent characters (e.g. "%nation%"), and will be replaced when the message is formatted. Furthermore, the messages may include choice formats consisting of a tag followed by a colon (":"), a selector and one or several choices separated from the selector and each other by pipe characters ("|"). The entire choice format must be enclosed in double brackets ("{{" and "}}", respectively). Each choice must consist of a key and a value separated by an equals character ("="), unless it is a variable, in which case the variable must resolve to another choice format. The selector may also be a variable. If the selector is omitted, then one of the choices should use the key "default". Choice formats may be nested.

   key1=%colony% tuottaa tuotetta {{tag:acc|%goods%}}.
   key2={{plural:%amount%|one=ruoka|other=ruokaa|default={{tag:|acc=viljaa|default=Vilja}}}}
   key3={{tag:|acc=viljaa|default={{plural:%amount%|one=ruoka|other=ruokaa|default=Ruoka}}}}
 

This class is NOT thread-safe. (CO: I cannot find any place that really has a problem)

Field Summary

Fields

Modifier and Type	Field and Description
private static java.lang.String[]	DESCRIPTION_KEYS
static java.lang.String	DESCRIPTION_SUFFIX
private static java.util.logging.Logger	logger
private static java.util.List<java.lang.String>	mercenaryLeaders Mercenary leaders.
static java.lang.String	MESSAGE_FILE_PREFIX
static java.lang.String	MESSAGE_FILE_SUFFIX
private static java.util.Map<java.lang.String,java.lang.String>	messageBundle The mapping from language-independent key to localized message for the established locale.
static java.lang.String	NAME_SUFFIX
private static java.util.List<java.lang.String>	otherRivers Extra river names.
static java.lang.String	RULER_SUFFIX
static java.lang.String	SHORT_DESCRIPTION_SUFFIX
private static java.util.Map<java.lang.String,Selector>	tagMap A map with Selector values and the tag keys used in choice formats.

Constructor Summary

Constructors

Constructor and Description
Messages()

Method Summary

Methods

Modifier and Type	Method and Description
private static void	collectNames(java.lang.String prefix, java.util.List<java.lang.String> names) Collects all the names with a given prefix.
static boolean	containsKey(java.lang.String key) Does the message bundle contain the given key?
static java.lang.String	descriptionKey(java.lang.String id)
private static int	findMatchingBracket(java.lang.String input, int start) Return the index of the matching pair of brackets, or -1 if none is found.
static java.lang.String	getBestDescription(ObjectWithId object)
static java.lang.String	getBestDescription(java.lang.String id)
static java.lang.String[]	getBestNameAndDescription(java.lang.String id) Get the name and best description for a given identifier.
static int	getBreakingPoint(java.lang.String string) Breaks a line between two words.
private static java.lang.String	getChoice(java.lang.String input, java.lang.String key) Return the choice tagged with the given key, or null, if the given input string does not contain the key.
static java.lang.String	getDefaultRegionName(Player player, Region.RegionType regionType) Creates a unique region name by fetching a new default name from the list of default names if possible.
static java.lang.String	getDescription(ObjectWithId object)
static java.lang.String	getDescription(java.lang.String id)
static java.lang.String	getKey(java.lang.String preferredKey, java.lang.String defaultKey) Returns the preferred key if it is contained in the message bundle and the default key otherwise.
static java.util.Locale	getLocale(java.lang.String languageID) Get the Locale corresponding to a given language name.
static int	getMercenaryLeaderCount() Get the number of mercenary leaders.
static java.lang.String	getMercenaryLeaderName(int n) Get the name of the nth mercenary leader.
private static java.util.List<java.lang.String>	getMessageFileNames(java.util.Locale locale) Get a list of candidate message file names for a given locale.
static java.lang.String	getName(ObjectWithId object)
static java.lang.String	getName(java.lang.String id)
static java.lang.String	getNewLandName(Player player) Get the new land name for a player.
static java.lang.String	getRulerName(java.lang.String id)
private static Selector	getSelector(java.lang.String tag) Gets the Selector with the given tag.
static java.util.List<java.lang.String>	getSettlementNames(Player player) Gets a list of settlement names and a fallback prefix for a player.
static java.util.List<java.lang.String>	getShipNames(Player player) Gets a list of ship names and a fallback prefix for a player.
static java.lang.String	getShortDescription(ObjectWithId object)
static java.lang.String	getShortDescription(java.lang.String id)
static java.lang.String	getTurnsText(int turns) Gets a string describing the number of turns left for a colony to finish building something.
static StringTemplate	getUnitLabel(java.lang.String name, java.lang.String typeId, int number, java.lang.String nationId, java.lang.String roleId, java.lang.String equipment) Get a label for a collection of units given a name, type, number, nation, role and extra equipment.
static void	loadMessages(java.io.InputStream is) Loads messages from a resource file into the current message bundle.
static java.lang.String	message(java.lang.String messageId) Get the text mapping for a particular identifier in the default locale message bundle.
static java.lang.String	message(StringTemplate template) Localizes a StringTemplate.
static java.lang.String	nameKey(ObjectWithId object)
static java.lang.String	nameKey(java.lang.String id)
private static java.lang.String	replaceChoices(java.lang.String input, StringTemplate template) Replace all choice formats in the given string, using keys and replacement values from the given template, which may be null.
private static void	requireMercenaryLeaders() Initialize the mercenary leaders collection.
static void	requireOtherRivers() Initialize the otherRivers collection.
static java.lang.String	rulerKey(java.lang.String id)
static void	setGrammaticalNumber(Number number) Set the grammatical number rule.
static void	setMessageBundle(java.util.Locale locale) Set the message bundle for the given locale Error messages have to go to System.err as this routine is called before logging is enabled.
static void	setModMessageBundle(java.util.Locale locale) Load localized messages for mods.
static java.lang.String	shortDescriptionKey(java.lang.String id)

Methods inherited from class java.lang.Object

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

Field Detail

logger

private static final java.util.logging.Logger logger

MESSAGE_FILE_PREFIX

public static final java.lang.String MESSAGE_FILE_PREFIX

See Also:

Constant Field Values

MESSAGE_FILE_SUFFIX

public static final java.lang.String MESSAGE_FILE_SUFFIX

See Also:

Constant Field Values

DESCRIPTION_SUFFIX

public static final java.lang.String DESCRIPTION_SUFFIX

See Also:

Constant Field Values

SHORT_DESCRIPTION_SUFFIX

public static final java.lang.String SHORT_DESCRIPTION_SUFFIX

See Also:

Constant Field Values

NAME_SUFFIX

public static final java.lang.String NAME_SUFFIX

See Also:

Constant Field Values

RULER_SUFFIX

public static final java.lang.String RULER_SUFFIX

See Also:

Constant Field Values

DESCRIPTION_KEYS

private static final java.lang.String[] DESCRIPTION_KEYS

messageBundle

private static final java.util.Map<java.lang.String,java.lang.String> messageBundle

The mapping from language-independent key to localized message for the established locale.

tagMap

private static java.util.Map<java.lang.String,Selector> tagMap

A map with Selector values and the tag keys used in choice formats.

otherRivers

private static java.util.List<java.lang.String> otherRivers

Extra river names.

mercenaryLeaders

private static java.util.List<java.lang.String> mercenaryLeaders

Mercenary leaders.

Constructor Detail

Messages

public Messages()

Method Detail

getSelector

private static Selector getSelector(java.lang.String tag)

Gets the Selector with the given tag.

Parameters:

tag - The tag to check.

Returns:

A suitable Selector.

setGrammaticalNumber

public static void setGrammaticalNumber(Number number)

Set the grammatical number rule.

Parameters:

number - a Number value

getMessageFileNames

private static java.util.List<java.lang.String> getMessageFileNames(java.util.Locale locale)

Get a list of candidate message file names for a given locale.

Parameters:

locale - The Locale to generate file names for.

Returns:

A list of message file names.

setMessageBundle

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

Set the message bundle for the given locale Error messages have to go to System.err as this routine is called before logging is enabled.

Parameters:

locale - The Locale to set resources for.

loadMessages

public static void loadMessages(java.io.InputStream is)
                         throws java.io.IOException

Loads messages from a resource file into the current message bundle. Public for the test suite.

Parameters:

is - The InputStream to read from.

Throws:

java.io.IOException

setModMessageBundle

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

Load localized messages for mods. We can not initially load resources from mods because not all mods can be loaded until the user mod directory is initialized, which depends on the command line processing, which in turn requires at least the basic localized message resources to be loaded. So this routine is called separately when the mods are finally loaded.

Parameters:

locale - The Locale to load resources for.

getLocale

public static java.util.Locale getLocale(java.lang.String languageID)

Get the Locale corresponding to a given language name. Public as this is needed for language option processing and the initial locale setting.

Parameters:

languageID - An underscore separated language/country/variant tuple.

Returns:

The Locale for the specified language.

nameKey

public static java.lang.String nameKey(java.lang.String id)

nameKey

public static java.lang.String nameKey(ObjectWithId object)

getName

public static java.lang.String getName(java.lang.String id)

getName

public static java.lang.String getName(ObjectWithId object)

descriptionKey

public static java.lang.String descriptionKey(java.lang.String id)

getDescription

public static java.lang.String getDescription(java.lang.String id)

getDescription

public static java.lang.String getDescription(ObjectWithId object)

shortDescriptionKey

public static java.lang.String shortDescriptionKey(java.lang.String id)

getShortDescription

public static java.lang.String getShortDescription(java.lang.String id)

getShortDescription

public static java.lang.String getShortDescription(ObjectWithId object)

rulerKey

public static java.lang.String rulerKey(java.lang.String id)

getRulerName

public static java.lang.String getRulerName(java.lang.String id)

containsKey

public static boolean containsKey(java.lang.String key)

Does the message bundle contain the given key?

Parameters:

key - The key String to check.

Returns:

True if there is a message present with the given key.

getKey

public static java.lang.String getKey(java.lang.String preferredKey,
                      java.lang.String defaultKey)

Returns the preferred key if it is contained in the message bundle and the default key otherwise. This should be used to select the most specific message key available.

Parameters:

preferredKey - a String value

defaultKey - a String value

Returns:

a String value

getBestDescription

public static java.lang.String getBestDescription(ObjectWithId object)

getBestDescription

public static java.lang.String getBestDescription(java.lang.String id)

getBestNameAndDescription

public static java.lang.String[] getBestNameAndDescription(java.lang.String id)

Get the name and best description for a given identifier. Favour the .name form, but degrade gracefully if it is not present. If .name is present, also look for a description.

Parameters:

id - The identifier to look up.

Returns:

A 2-element array of name and description found.

getUnitLabel

public static StringTemplate getUnitLabel(java.lang.String name,
                          java.lang.String typeId,
                          int number,
                          java.lang.String nationId,
                          java.lang.String roleId,
                          java.lang.String equipment)

Get a label for a collection of units given a name, type, number, nation, role and extra equipment.

Parameters:

name - An optional unit name.

typeId - The unit type identifier.

number - The number of units.

nationId - An optional nation identifier.

roleId - The unit role identifier.

equipment - An optional equipment annotation.

Returns:

A StringTemplate to describe the given unit.

getTurnsText

public static java.lang.String getTurnsText(int turns)

Gets a string describing the number of turns left for a colony to finish building something.

Parameters:

turns - the number of turns left

Returns:

A descriptive string.

getNewLandName

public static java.lang.String getNewLandName(Player player)

Get the new land name for a player.

Parameters:

player - The Player to query.

Returns:

The new land name of a player.

requireOtherRivers

public static void requireOtherRivers()

Initialize the otherRivers collection.

getDefaultRegionName

public static java.lang.String getDefaultRegionName(Player player,
                                    Region.RegionType regionType)

Creates a unique region name by fetching a new default name from the list of default names if possible.

Parameters:

player - Player

regionType - a RegionType value

Returns:

a String value

requireMercenaryLeaders

private static void requireMercenaryLeaders()

Initialize the mercenary leaders collection.

getMercenaryLeaderCount

public static int getMercenaryLeaderCount()

Get the number of mercenary leaders.

Returns:

The number of mercenary leaders.

getMercenaryLeaderName

public static java.lang.String getMercenaryLeaderName(int n)

Get the name of the nth mercenary leader.

Parameters:

n - The index of the leader required.

Returns:

The mercenary leader name.

collectNames

private static void collectNames(java.lang.String prefix,
                java.util.List<java.lang.String> names)

Collects all the names with a given prefix.

Parameters:

prefix - The prefix to check.

names - A list to fill with the names found.

getSettlementNames

public static java.util.List<java.lang.String> getSettlementNames(Player player)

Gets a list of settlement names and a fallback prefix for a player.

Parameters:

player - The Player to get names for.

Returns:

A list of settlement names, with the first being the fallback prefix.

getShipNames

public static java.util.List<java.lang.String> getShipNames(Player player)

Gets a list of ship names and a fallback prefix for a player.

Parameters:

player - The Player to get names for.

Returns:

A list of ship names, with the first being the fallback prefix.

getBreakingPoint

public static int getBreakingPoint(java.lang.String string)

Breaks a line between two words. The breaking point is as close to the center as possible.

Parameters:

string - The line for which we should determine a breaking point.

Returns:

The best breaking point or -1 if there are none.

message

public static java.lang.String message(java.lang.String messageId)

Get the text mapping for a particular identifier in the default locale message bundle. Returns the key as the value if there is no mapping found!

Parameters:

messageId - The key of the message to find.

Returns:

String text mapping or the key

message

public static java.lang.String message(StringTemplate template)

Localizes a StringTemplate.

Parameters:

template - a StringTemplate value

Returns:

a String value

replaceChoices

private static java.lang.String replaceChoices(java.lang.String input,
                              StringTemplate template)

Replace all choice formats in the given string, using keys and replacement values from the given template, which may be null. A choice format is enclosed in double brackets and consists of a tag, followed by a colon, followed by an optional selector, followed by a pipe character, followed by one or several choices separated by pipe characters. If there is only one choice, it must be a message identifier or a variable. Otherwise, each choice consists of a key and a value separated by an assignment character. Example: "{{tag:selector|key1=val1|key2=val2}}".

Parameters:

input - a String value

template - a StringTemplate value

Returns:

a String value

getChoice

private static java.lang.String getChoice(java.lang.String input,
                         java.lang.String key)

Return the choice tagged with the given key, or null, if the given input string does not contain the key.

Parameters:

input - a String value

key - a String value

Returns:

a String value

findMatchingBracket

private static int findMatchingBracket(java.lang.String input,
                      int start)

Return the index of the matching pair of brackets, or -1 if none is found.

Parameters:

input - a String value

start - an int value

Returns:

an int value