org.vaadin.spring.stuff.i18n.MessageProvider Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of spring-vaadin-stuff Show documentation

There is a newer version: 0.0.3.2

/*
 * Copyright 2014 The original authors
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *   http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package org.vaadin.spring.stuff.i18n;

import java.text.MessageFormat;
import java.util.Locale;

/**
 * A {@code MessageProvider} provides messages for a {@link org.vaadin.spring.stuff.i18n.CompositeMessageSource}.
 * There can be multiple message provider beans in the same application context.
 *
 * @author Petter Holmström ([email protected])
 */
public interface MessageProvider {

    /**
     * Attempts to resolve the specified code for the specified locale.
     *
     * @param s      the code of the message, must not be {@code null}.
     * @param locale the locale, must not be {@code null}.
     * @return a {@code MessageFormat} for the message, or {@code null} if not found.
     */
    MessageFormat resolveCode(String s, Locale locale);
}