001    /*
002     * SonarQube, open source software quality management tool.
003     * Copyright (C) 2008-2013 SonarSource
004     * mailto:contact AT sonarsource DOT com
005     *
006     * SonarQube 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     * SonarQube 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 License
017     * along with this program; if not, write to the Free Software Foundation,
018     * Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
019     */
020    package org.sonar.api.i18n;
021    
022    import org.sonar.api.BatchComponent;
023    import org.sonar.api.ServerComponent;
024    
025    import javax.annotation.Nullable;
026    
027    import java.util.Locale;
028    
029    /**
030     * Main component that provides translation facilities.
031     * 
032     * @since 2.10
033     */
034    public interface I18n extends ServerComponent, BatchComponent {
035    
036      /**
037       * Searches the message of the <code>key</code> for the <code>locale</code> in the list of available bundles.
038       * <br>
039       * If not found in any bundle, <code>defaultValue</code> is returned.
040       * <p/>
041       * If additional parameters are given (in the objects list), the result is used as a message pattern
042       * to use in a MessageFormat object along with the given parameters.
043       *
044       * @param locale the locale to translate into
045       * @param key the key of the pattern to translate
046       * @param defaultValue the default pattern returned when the key is not found in any bundle
047       * @param parameters the parameters used to format the message from the translated pattern.
048       * @return the message formatted with the translated pattern and the given parameters
049       */
050      String message(final Locale locale, final String key, @Nullable final String defaultValue, final Object... parameters);
051    
052    }