freenet.l10n

Class BaseL10n

java.lang.Object

freenet.l10n.BaseL10n

public class BaseL10n
extends java.lang.Object

This is the core of all the localization stuff. This method can get localized strings from any SimpleFieldSet file, and can, if necessary, use a custom ClassLoader. The language can be changed at anytime. Note : do not use this class *as is*, use NodeL10n.getBase() or PluginL10n.getBase(). Note : this class also supports using/saving/editing overriden translations.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	BaseL10n.LANGUAGE Central list of languages and the codes to identify them.

Constructor Summary

Constructors

Constructor and Description
BaseL10n(java.lang.String l10nFilesBasePath, java.lang.String l10nFilesMask, java.lang.String l10nOverrideFilesMask)
BaseL10n(java.lang.String l10nFilesBasePath, java.lang.String l10nFilesMask, java.lang.String l10nOverrideFilesMask, BaseL10n.LANGUAGE lang)
BaseL10n(java.lang.String l10nFilesBasePath, java.lang.String l10nFilesMask, java.lang.String l10nOverrideFilesMask, BaseL10n.LANGUAGE lang, java.lang.ClassLoader cl) Create a new BaseL10n object.

Method Summary

Modifier and Type	Method and Description
void	addL10nSubstitution(HTMLNode node, java.lang.String key, java.lang.String[] patterns, HTMLNode[] values) Loads an L10n string, replaces variables such as ${link} or ${bold} in it with HTMLNodes and adds the result to the given HTMLNode.
void	addL10nSubstitution(HTMLNode node, java.lang.String key, java.lang.String[] patterns, java.lang.String[] values) Deprecated. Use addL10nSubstitution(HTMLNode, String, String[], HTMLNode[]) instead.
java.lang.String[]	getAllNamesWithPrefix(java.lang.String prefix)
SimpleFieldSet	getCurrentLanguageTranslation() Get a copy of the currently used SimpleFieldSet.
SimpleFieldSet	getDefaultLanguageTranslation() Get the SimpleFieldSet of the default language (should be english).
java.lang.String	getDefaultString(java.lang.String key) Get the default value for a key.
java.lang.String	getDefaultString(java.lang.String key, java.lang.String[] patterns, java.lang.String[] values) Get the default value for a key.
HTMLNode	getHTMLNode(java.lang.String key) Get a localized string and put it in a HTMLNode for the translation page.
HTMLNode	getHTMLNode(java.lang.String key, java.lang.String[] patterns, java.lang.String[] values) Get a localized string and put it in a HTMLNode for the translation page.
java.lang.String	getL10nFileName(BaseL10n.LANGUAGE lang) Get the full base name of the L10n file used by the current language.
java.lang.String	getL10nOverrideFileName(BaseL10n.LANGUAGE lang) Get the full base name of the L10n override file used by the current language.
SimpleFieldSet	getOverrideForCurrentLanguageTranslation() Get a copy of the currently used SimpleFieldSet (overriden messages).
BaseL10n.LANGUAGE	getSelectedLanguage() Get the language currently used by this BaseL10n.
java.lang.String	getString(java.lang.String key) Get a localized string.
java.lang.String	getString(java.lang.String key, boolean returnNullIfNotFound) Get a localized string.
java.lang.String	getString(java.lang.String key, java.lang.String[] patterns, java.lang.String[] values) Get a localized string, and replace on-the-fly some values.
java.lang.String	getString(java.lang.String key, java.lang.String pattern, java.lang.String value) Get a localized string, and replace on-the-fly a value.
boolean	isOverridden(java.lang.String key) Returns true if a key is overriden.
void	setLanguage(BaseL10n.LANGUAGE selectedLanguage) Use a new language, and load the SimpleFieldSets accordingly.
void	setOverride(java.lang.String key, java.lang.String value) Override a custom key with a new value.

Methods inherited from class java.lang.Object

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

Constructor Detail

BaseL10n

public BaseL10n(java.lang.String l10nFilesBasePath,
                java.lang.String l10nFilesMask,
                java.lang.String l10nOverrideFilesMask)

BaseL10n

public BaseL10n(java.lang.String l10nFilesBasePath,
                java.lang.String l10nFilesMask,
                java.lang.String l10nOverrideFilesMask,
                BaseL10n.LANGUAGE lang)

BaseL10n

public BaseL10n(java.lang.String l10nFilesBasePath,
                java.lang.String l10nFilesMask,
                java.lang.String l10nOverrideFilesMask,
                BaseL10n.LANGUAGE lang,
                java.lang.ClassLoader cl)

Create a new BaseL10n object. Note : you shouldn't have to run this yourself. Use PluginL10n or NodeL10n.

Parameters:

l10nFilesBasePath - Base path of the l10n files, ex. "com/mycorp/myproject/l10n"

l10nFilesMask - Mask of the l10n files, ex. "messages_${lang}.l10n"

l10nOverrideFilesMask - Same as l10nFilesMask, but for overriden messages.

lang - Language to use.

cl - ClassLoader to use.

Method Detail

getL10nFileName

public java.lang.String getL10nFileName(BaseL10n.LANGUAGE lang)

Get the full base name of the L10n file used by the current language.

Returns:

String

getL10nOverrideFileName

public java.lang.String getL10nOverrideFileName(BaseL10n.LANGUAGE lang)

Get the full base name of the L10n override file used by the current language.

Returns:

String

setLanguage

public void setLanguage(BaseL10n.LANGUAGE selectedLanguage)
                 throws java.util.MissingResourceException

Use a new language, and load the SimpleFieldSets accordingly.

Parameters:

selectedLanguage - New language to use.

Throws:

java.util.MissingResourceException - If the l10n file could not be found.

getSelectedLanguage

public BaseL10n.LANGUAGE getSelectedLanguage()

Get the language currently used by this BaseL10n.

Returns:

LANGUAGE

isOverridden

public boolean isOverridden(java.lang.String key)

Returns true if a key is overriden.

Parameters:

key - Key to check override status

Returns:

boolean

setOverride

public void setOverride(java.lang.String key,
                        java.lang.String value)

Override a custom key with a new value.

Parameters:

key - Key to override.

value - New value of that key.

getCurrentLanguageTranslation

public SimpleFieldSet getCurrentLanguageTranslation()

Get a copy of the currently used SimpleFieldSet.

Returns:

SimpleFieldSet

getOverrideForCurrentLanguageTranslation

public SimpleFieldSet getOverrideForCurrentLanguageTranslation()

Get a copy of the currently used SimpleFieldSet (overriden messages).

Returns:

SimpleFieldSet

getDefaultLanguageTranslation

public SimpleFieldSet getDefaultLanguageTranslation()

Get the SimpleFieldSet of the default language (should be english).

Returns:

SimpleFieldSet

getString

public java.lang.String getString(java.lang.String key)

Get a localized string. Return "" (empty string) if it doesn't exist.

Parameters:

key - Key to search for.

Returns:

String

getString

public java.lang.String getString(java.lang.String key,
                                  boolean returnNullIfNotFound)

Get a localized string.

Parameters:

key - Key to search for.

returnNullIfNotFound - If this is true, will return null if the key is not found.

Returns:

String

getHTMLNode

public HTMLNode getHTMLNode(java.lang.String key)

Get a localized string and put it in a HTMLNode for the translation page.

Parameters:

key - Key to search for.

Returns:

HTMLNode

getHTMLNode

public HTMLNode getHTMLNode(java.lang.String key,
                            java.lang.String[] patterns,
                            java.lang.String[] values)

Get a localized string and put it in a HTMLNode for the translation page.

Parameters:

key - Key to search for.

patterns - Patterns to replace. May be null, if so values must also be null.

values - Values to replace patterns with.

Returns:

HTMLNode

getDefaultString

public java.lang.String getDefaultString(java.lang.String key)

Get the default value for a key.

Parameters:

key - Key to search for.

Returns:

String

getDefaultString

public java.lang.String getDefaultString(java.lang.String key,
                                         java.lang.String[] patterns,
                                         java.lang.String[] values)

Get the default value for a key.

Parameters:

key - Key to search for.

Returns:

String

getString

public java.lang.String getString(java.lang.String key,
                                  java.lang.String[] patterns,
                                  java.lang.String[] values)

Get a localized string, and replace on-the-fly some values.

Parameters:

key - Key to search for.

patterns - Patterns to replace, ${ and } are not included.

values - Replacement values.

Returns:

String

getString

public java.lang.String getString(java.lang.String key,
                                  java.lang.String pattern,
                                  java.lang.String value)

Get a localized string, and replace on-the-fly a value.

Parameters:

key - Key to search for.

pattern - Pattern to replace, ${ and } not included.

value - Replacement value.

Returns:

String

addL10nSubstitution

@Deprecated
public void addL10nSubstitution(HTMLNode node,
                                            java.lang.String key,
                                            java.lang.String[] patterns,
                                            java.lang.String[] values)

Deprecated. Use addL10nSubstitution(HTMLNode, String, String[], HTMLNode[]) instead.

Parse a localized string and put the result in a HTMLNode.

Parameters:

node - The result will be put in this HTMLNode.

key - Key to search for.

patterns - Patterns to replace, ${ and } are not included.

values - Replacement values.

addL10nSubstitution

public void addL10nSubstitution(HTMLNode node,
                                java.lang.String key,
                                java.lang.String[] patterns,
                                HTMLNode[] values)

Loads an L10n string, replaces variables such as ${link} or ${bold} in it with HTMLNodes and adds the result to the given HTMLNode. This is *much* safer than the deprecated addL10nSubstitution(HTMLNode, String, String[], String[]). Callers won't accidentally pass in unencoded strings and cause vulnerabilities. Callers should try to reuse parameters if possible. We automatically close each tag: When a pattern ${name} is matched, we search for ${/name}. If we find it, we make the tag enclose everything between the two; if we can't find it, we just add it with no children. It is not possible to create an HTMLNode representing a tag closure, so callers will need to change their code to not pass in /link or similar, and in some cases will need to change the l10n strings themselves to always close the tag properly, rather than using a generic /link for multiple links as we use in some places.

Examples:

TranslationLookup.string=This is a ${link}link${/link} about ${text}.

addL10nSubstitution(html, "TranslationLookup.string", new String[] { "link", "text" }, new HTMLNode[] { HTMLNode.link("/KSK@gpl.txt"), HTMLNode.text("blah") });

TranslationLookup.string=${bold}This${/bold} is a bold text.

addL10nSubstitution(html, "TranslationLookup.string", new String[] { "bold" }, new HTMLNode[] { HTMLNode.STRONG });

Parameters:

node - The HTMLNode to which the L10n should be added after substitution was done.

key - The key of the L10n string which shall be used.

patterns - Specifies things such as ${link} which shall be replaced in the L10n string with HTMLNodes.

values - For each entry in the previous array parameter, this array specifies the HTMLNode with which it shall be replaced.

getAllNamesWithPrefix

public java.lang.String[] getAllNamesWithPrefix(java.lang.String prefix)