StringLocalizer.java

/**
 * Licensed to the Austrian Association for Software Tool Integration (AASTI)
 * under one or more contributor license agreements. See the NOTICE file
 * distributed with this work for additional information regarding copyright
 * ownership. The AASTI licenses this file to you 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.openengsb.core.api.l10n;

import java.io.Serializable;
import java.util.Locale;

public interface StringLocalizer extends Serializable {

    /**
     * Localize a string identified by the given {@code key} to the given {@code locale}.
     */
    String getString(String key, Locale locale, String... parameters);

    /**
     * Returs a {@code LocalizableString} where the actual localization is done in a later step by calling
     * {@link org.openengsb.core.api.l10n.LocalizableString#getString(Locale) }.
     */
    LocalizableString getString(String key, String... parameters);
}