001/*
002 * ModeShape (http://www.modeshape.org)
003 *
004 * Licensed under the Apache License, Version 2.0 (the "License");
005 * you may not use this file except in compliance with the License.
006 * You may obtain a copy of the License at
007 *
008 *       http://www.apache.org/licenses/LICENSE-2.0
009 *
010 * Unless required by applicable law or agreed to in writing, software
011 * distributed under the License is distributed on an "AS IS" BASIS,
012 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
013 * See the License for the specific language governing permissions and
014 * limitations under the License.
015 */
016package org.modeshape.common.i18n;
017
018import java.util.Locale;
019
020/**
021 * Interface which should be implemented by any i18n compliant resource.
022 *
023 * @author Horia Chiorean
024 */
025public interface I18nResource {
026
027    /**
028     * Get the localized text for the {@link Locale#getDefault() current (default) locale}, replacing the parameters in the text
029     * with those supplied.
030     *
031     * @param arguments the arguments for the parameter replacement; may be <code>null</code> or empty
032     * @return the localized text
033     */
034    public String text(Object...arguments);
035
036    /**
037     * Get the localized text for the supplied locale, replacing the parameters in the text with those supplied.
038     *
039     * @param locale the locale, or <code>null</code> if the {@link Locale#getDefault() current (default) locale} should be used
040     * @param arguments the arguments for the parameter replacement; may be <code>null</code> or empty
041     * @return the localized text
042     */
043    public String text(Locale locale, Object...arguments);
044}