org.xwiki.localization
Interface Translation

@Unstable
public interface Translation

A translation is a specific Locale and TranslationBundle.

Since:

4.3M2

Version:

$Id: 5b6559bf1743c7b3300238e8aad5b42277dbdf2a $

Method Summary

TranslationBundle	getBundle()
String	getKey()
Locale	getLocale()
Object	getRawSource()
org.xwiki.rendering.block.Block	render(Locale locale, Object... parameters) Execute the transformation (resolve any variable or parameter in its content) and produce a Block to insert in an XDOM or to render as it is.
org.xwiki.rendering.block.Block	render(Object... parameters) Execute the transformation (resolve any variable or parameter in its content) and produce a Block to insert in an XDOM or to render as it is.

Method Detail

getBundle

TranslationBundle getBundle()

Returns:

the bundle from which this translation comes

getLocale

Locale getLocale()

Returns:

the locale of the translation

getKey

String getKey()

Returns:

the key of the translation

getRawSource

Object getRawSource()

Returns:

the raw source of the translation as it is stored

Since:

5.0M1

render

org.xwiki.rendering.block.Block render(Object... parameters)

Execute the transformation (resolve any variable or parameter in its content) and produce a Block to insert in an XDOM or to render as it is.

The variables are resolved using the current TranslationBundleContext bundles.

Parameters:

parameters - the parameters

Returns:

the result translation

render

org.xwiki.rendering.block.Block render(Locale locale,
                                       Object... parameters)

Execute the transformation (resolve any variable or parameter in its content) and produce a Block to insert in an XDOM or to render as it is.

The variables are resolved using the current TranslationBundleContext bundles.

Parameters:

locale - the locale for which this translation is rendered

parameters - the parameters

Returns:

the result translation