com.xpn.xwiki.plugin.applicationmanager.core.plugin
Class XWikiPluginMessageTool

java.lang.Object
  com.xpn.xwiki.web.XWikiMessageTool
      com.xpn.xwiki.plugin.applicationmanager.core.plugin.XWikiPluginMessageTool

Direct Known Subclasses:

ApplicationManagerMessageTool

public class XWikiPluginMessageTool
extends XWikiMessageTool

Plugin internationalization service based XWikiMessageTool.

Version:

$Id: 8a8ecb1020ef91df8ceff73568654667cae3bab3 $

Field Summary

Fields inherited from class com.xpn.xwiki.web.XWikiMessageTool

bundle, context

Constructor Summary

XWikiPluginMessageTool(Locale locale, XWikiPluginInterface plugin, XWikiContext context)

XWikiPluginMessageTool(ResourceBundle bundle)

XWikiPluginMessageTool(ResourceBundle bundle, XWikiContext context)

Method Summary

String	get(String key, String param) Find a translation and then replace any parameters found in the translation by the passed param parameter.
String	get(String key, String[] params) Find a translation and then replace any parameters found in the translation by the passed params parameters.
protected String	getTranslation(String key)

Methods inherited from class com.xpn.xwiki.web.XWikiMessageTool

get, get, get, getDocumentBundle, getDocumentBundleNames, getDocumentBundleProperties, getDocumentBundles, getDocumentBundles

Methods inherited from class java.lang.Object

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

Constructor Detail

XWikiPluginMessageTool

public XWikiPluginMessageTool(Locale locale,
                              XWikiPluginInterface plugin,
                              XWikiContext context)

Parameters:

locale - the locale.

plugin - the plugin.

context - the XWikiContext object, used to get access to XWiki primitives for loading documents

XWikiPluginMessageTool

public XWikiPluginMessageTool(ResourceBundle bundle)

Parameters:

bundle - the default Resource Bundle to fall back to if no document bundle is found when trying to get a key

XWikiPluginMessageTool

public XWikiPluginMessageTool(ResourceBundle bundle,
                              XWikiContext context)

Parameters:

bundle - the default Resource Bundle to fall back to if no document bundle is found when trying to get a key

context - the XWikiContext object, used to get access to XWiki primitives for loading documents

Method Detail

getTranslation

protected String getTranslation(String key)

Start calling context's XWikiMessageTool.get(String) then if nothing is found use plugin's ResourceBundle.

Overrides:

getTranslation in class XWikiMessageTool

See Also:

XWikiMessageTool.getTranslation(java.lang.String)

get

public String get(String key,
                  String[] params)

Find a translation and then replace any parameters found in the translation by the passed params parameters. The format is the one used by MessageFormat.

Parameters:

key - the key of the string to find

params - the array of parameters to use for replacing "{N}" elements in the string. See MessageFormat for the full syntax

Returns:

the translated string with parameters resolved

See Also:

XWikiMessageTool.get(String, List)

get

public String get(String key,
                  String param)

Find a translation and then replace any parameters found in the translation by the passed param parameter. The format is the one used by MessageFormat.

Parameters:

key - the key of the string to find

param - the parameter to use for replacing "{0}" element in the string. See MessageFormat for the full syntax

Returns:

the translated string with parameters resolved

See Also:

XWikiMessageTool.get(String, List)