TranslationManager.java

/*
 * See the NOTICE file distributed with this work for additional
 * information regarding copyright ownership.
 *
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Affero General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU Affero General Public License for more details.
 *
 * You should have received a copy of the GNU Affero General Public License
 * along with this program.  If not, see http://www.gnu.org/licenses/
 */
package org.phenotips.translation;

import org.xwiki.component.annotation.Role;
import org.xwiki.stability.Unstable;

/**
 * @version $Id$
 */
@Unstable("New API introduced in 1.2")
@Role
public interface TranslationManager
{
    /**
     * Get the translation corresponding to the given key, using the current locale.
     *
     * @param key the identifier of the message to retrieve
     * @param parameters optional parameters to be used in the translation
     * @return the message in the current locale, as plain text (all markup is stripped)
     */
    String translate(String key, Object... parameters);
}