A C D E G L O P R T U

A

addBundle(TranslationBundle) - Method in interface org.xwiki.localization.TranslationBundleContext

Add a new bundle to the collection.

C

ContextualLocalizationManager - Interface in org.xwiki.localization

A helper for LocalizationManager which get the Locale from LocalizationContext and provide various common use cases methods.

D

DEFAULTPRIORITY - Static variable in interface org.xwiki.localization.TranslationBundle

The default priority of a Bundle.

E

EMPTY - Static variable in interface org.xwiki.localization.message.TranslationMessage

An empty translation message.

G

getBundle() - Method in interface org.xwiki.localization.Translation

getBundle(String) - Method in interface org.xwiki.localization.TranslationBundleFactory

Get the TranslationBundle associated to the passed identifier.

getBundles() - Method in interface org.xwiki.localization.TranslationBundleContext

getCurrentLocale() - Method in interface org.xwiki.localization.LocalizationContext

getId() - Method in interface org.xwiki.localization.TranslationBundle

getKey() - Method in interface org.xwiki.localization.Translation

getLocale() - Method in interface org.xwiki.localization.Translation

getPriority() - Method in interface org.xwiki.localization.TranslationBundle

When searching for a translation, the bundles are searched in order until one of these bundles contains a value for the searched key.

getRawSource() - Method in interface org.xwiki.localization.message.TranslationMessage

getRawSource() - Method in interface org.xwiki.localization.Translation

getTranslation(String) - Method in interface org.xwiki.localization.ContextualLocalizationManager

Find a translation in the current language.

getTranslation(String, Locale) - Method in interface org.xwiki.localization.LocalizationManager

Find a translation in the specified language.

getTranslation(String, Locale) - Method in interface org.xwiki.localization.TranslationBundle

Return the translation for the given key, in the specified Locale.

getTranslationBundle(String, String) - Method in interface org.xwiki.localization.LocalizationManager

Find a bundle.

getTranslationPlain(String, Object...) - Method in interface org.xwiki.localization.ContextualLocalizationManager

Find a translation in the current language.

L

LocalizationContext - Interface in org.xwiki.localization

Provide various localization related contextual informations (current Locale, etc.).

LocalizationException - Exception in org.xwiki.localization

All Localization module API must raise an exception of this type.

LocalizationException(String) - Constructor for exception org.xwiki.localization.LocalizationException

Constructs a new exception with the specified detail message.

LocalizationException(String, Throwable) - Constructor for exception org.xwiki.localization.LocalizationException

Constructs a new exception with the specified detail message and cause.

LocalizationManager - Interface in org.xwiki.localization

Internationalization service based on key/property values.

O

org.xwiki.localization - package org.xwiki.localization

org.xwiki.localization.message - package org.xwiki.localization.message

P

parse(String) - Method in interface org.xwiki.localization.message.TranslationMessageParser

R

render(Locale, Collection<TranslationBundle>, Object...) - Method in interface org.xwiki.localization.message.TranslationMessageElement

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

render(Object...) - Method in interface org.xwiki.localization.Translation

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.

render(Locale, Object...) - Method in interface org.xwiki.localization.Translation

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.

T

Translation - Interface in org.xwiki.localization

A translation is a specific Locale and TranslationBundle.

TranslationBundle - Interface in org.xwiki.localization

A collection of translations in various Locales.

TranslationBundleContext - Interface in org.xwiki.localization

The Bundles applying to the current context ordered by priority.

TranslationBundleDoesNotExistsException - Exception in org.xwiki.localization

Raised when trying to manipulate a bundle that does not exists.

TranslationBundleDoesNotExistsException(String) - Constructor for exception org.xwiki.localization.TranslationBundleDoesNotExistsException

Constructs a new exception with the specified detail message.

TranslationBundleDoesNotExistsException(String, Throwable) - Constructor for exception org.xwiki.localization.TranslationBundleDoesNotExistsException

Constructs a new exception with the specified detail message and cause.

TranslationBundleFactory - Interface in org.xwiki.localization

Creates bundles.

TranslationBundleFactoryDoesNotExistsException - Exception in org.xwiki.localization

Raised when trying to manipulate a bundle that does not exists.

TranslationBundleFactoryDoesNotExistsException(String) - Constructor for exception org.xwiki.localization.TranslationBundleFactoryDoesNotExistsException

Constructs a new exception with the specified detail message.

TranslationBundleFactoryDoesNotExistsException(String, Throwable) - Constructor for exception org.xwiki.localization.TranslationBundleFactoryDoesNotExistsException

Constructs a new exception with the specified detail message and cause.

TranslationMessage - Interface in org.xwiki.localization.message

Generate the final translation based or variables informations (parameters, etc.).

TranslationMessageElement - Interface in org.xwiki.localization.message

An element in a translation message.

TranslationMessageParser - Interface in org.xwiki.localization.message

Transform String into a TranslationMessage.

U

use(String, String) - Method in interface org.xwiki.localization.LocalizationManager

Registers a resource location as a possible localization bundle that should be used in the current execution.

A C D E G L O P R T U