com.anrisoftware.resources.templates.external.Templates Maven / Gradle / Ivy

Go to download
/**
 * Copyright © 2012 Erwin Müller ([email protected])
 *
 * 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 com.anrisoftware.resources.templates.external;

import java.util.Locale;
import java.util.ResourceBundle;

import com.anrisoftware.resources.api.external.ResourcesException;

public interface Templates {

    /**
     * Returns the used resource bundle base name.
     * 
     * @return the used base name {@link String}.
     */
    String getBaseName();

    /**
     * Returns the used resource bundle class loader.
     * 
     * @return the used {@link ClassLoader}.
     */
    ClassLoader getClassLoader();

    /**
     * Returns the used resource bundle control.
     * 
     * @return the used {@link ResourceBundle.Control}.
     */
    ResourceBundle.Control getControl();

    /**
     * Returns the template resource with the given name and the default locale as
     * in {@link Locale#getDefault()}.
     * 
     * @param name the name of the resource.
     * 
     * @return the {@link TemplateResource}.
     * 
     * @throws ResourcesException if the resource is not available.
     */
    TemplateResource getResource(String name);

    /**
     * Returns the template resource with the given name and language.
     * 
     * @param name   the name of the resource.
     * 
     * @param locale the {@link Locale} of the resource.
     * 
     * @return the {@link TemplateResource}.
     * 
     * @throws ResourcesException if the resource is not available.
     */
    TemplateResource getResource(String name, Locale locale) throws ResourcesException;

}