001 /* 002 * Sonar, open source software quality management tool. 003 * Copyright (C) 2008-2011 SonarSource 004 * mailto:contact AT sonarsource DOT com 005 * 006 * Sonar is free software; you can redistribute it and/or 007 * modify it under the terms of the GNU Lesser General Public 008 * License as published by the Free Software Foundation; either 009 * version 3 of the License, or (at your option) any later version. 010 * 011 * Sonar is distributed in the hope that it will be useful, 012 * but WITHOUT ANY WARRANTY; without even the implied warranty of 013 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU 014 * Lesser General Public License for more details. 015 * 016 * You should have received a copy of the GNU Lesser General Public 017 * License along with Sonar; if not, write to the Free Software 018 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02 019 */ 020 package org.sonar.api.i18n; 021 022 import org.sonar.api.BatchComponent; 023 import org.sonar.api.ServerComponent; 024 025 import java.util.Locale; 026 027 /** 028 * 029 * 030 * 031 * EXPERIMENTAL - this feature will be fully implemented in version 2.10 032 * 033 * 034 * 035 * The <code>I18n</code> Interface is the entry point for the internationalization of the Sonar application and plugins.<br>The corresponding implementation is located in the core plugin. 036 * <p/> 037 * I18n is managed in Sonar through the use of key-based resource bundles. 038 * <br> 039 * Though any key can be used, the following key-naming conventions, which are applied in the Sonar application and core plugins, are given as guidelines: 040 * 041 * @since 2.9 042 */ 043 public interface I18n extends ServerComponent, BatchComponent { 044 045 /** 046 * Searches the message of the <code>key</code> for the <code>locale</code> in the list of available bundles. 047 * <br> 048 * If not found in any bundle, <code>defaultText</code> is returned. 049 * 050 * If additional parameters are given (in the objects list), the result is used as a message pattern 051 * to use in a MessageFormat object along with the given parameters. 052 * 053 * @param locale the locale to translate into 054 * @param key the key of the pattern to translate 055 * @param defaultValue the default pattern returned when the key is not found in any bundle 056 * @param parameters the parameters used to format the message from the translated pattern. 057 * @return the message formatted with the translated pattern and the given parameters 058 */ 059 public abstract String message(final Locale locale, final String key, final String defaultValue, final Object... parameters); 060 }