org.sonar.api.i18n
Interface I18n

All Superinterfaces:
BatchComponent, ServerComponent

public interface I18n
extends ServerComponent, BatchComponent

Main component that provides translation facilities.

Since:
2.10

Method Summary
 String message(Locale locale, String key, String defaultValue, Object... parameters)
          Searches the message of the key for the locale in the list of available bundles.
 

Method Detail

message

String message(Locale locale,
               String key,
               @Nullable
               String defaultValue,
               Object... parameters)
Searches the message of the key for the locale in the list of available bundles.
If not found in any bundle, defaultValue is returned.

If additional parameters are given (in the objects list), the result is used as a message pattern to use in a MessageFormat object along with the given parameters.

Parameters:
locale - the locale to translate into
key - the key of the pattern to translate
defaultValue - the default pattern returned when the key is not found in any bundle
parameters - the parameters used to format the message from the translated pattern.
Returns:
the message formatted with the translated pattern and the given parameters


Copyright © 2009-2013 SonarSource. All Rights Reserved.