LocalizationProvider.java

/**
 * Copyright 2013 Tommi S.E. Laukkanen
 *
 * 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.bubblecloud.ilves.site;

import java.util.Locale;

/**
 * Provider interface for localizing strings.
 *
 * @author Tommi S.E. Laukkanen
 */
public interface LocalizationProvider {
    /**
     * Gets localized value corresponding to given localization key.
     * @param key The localization key.
     * @param locale The locale.
     * @return The localized value.
     */
    String localize(final String key, final Locale locale);
}