org.sdmxsource.sdmx.api.util.MessageResolver Maven / Gradle / Ivy

Go to download
/*******************************************************************************
 * Copyright (c) 2013 Metadata Technology Ltd.
 *
 * All rights reserved. This program and the accompanying materials are made 
 * available under the terms of the GNU Lesser General Public License v 3.0 
 * which accompanies this distribution, and is available at
 * http://www.gnu.org/licenses/lgpl.html
 *
 * This file is part of the SDMX Component Library.
 *
 * The SDMX Component Library is free software: you can redistribute it and/or 
 * modify it under the terms of the GNU Lesser General Public License as
 * published by the Free Software Foundation, either version 3 of the License,
 * or (at your option) any later version.
 *
 * The SDMX Component Library 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 Lesser 
 * General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public License 
 * along with The SDMX Component Library If not, see 
 * http://www.gnu.org/licenses/lgpl.
 *
 * Contributors:
 * Metadata Technology - initial API and implementation
 ******************************************************************************/
package org.sdmxsource.sdmx.api.util;

import java.util.Locale;

/**
 * Used to resolve message codes to text strings based in the given locale
 *
 * @author Matt Nelson
 */
public interface MessageResolver {

    /**
     * Resolves the message against a resource which contains code to string mappings, inserting any args
     * where there are placeholders.  If there is no resource found, or no mapping could be found
     * for the messageCode, then the original messageCode will be returned.
     *
     * @param messageCode the message code
     * @param locale      - the locale to resolve the message in
     * @param args        the args
     * @return the resolved message, or the original if could not be resolved
     */
    String resolveMessage(String messageCode, Locale locale, Object... args);
}