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

Go to download
/*
 * Copyright 2016 Erwin Müller 
 *
 * 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.io.Serializable;
import java.util.Map;
import java.util.Properties;

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

/**
 * Template resource.
 *
 * @author Erwin Mueller, [email protected]
 * @since 1.0
 * @see TemplateResourceFactory
 */
public interface TemplateResource extends Resource {

    /**
     * Process the template and returns the text.
     * 
     * The processed text is cached and is returned for the same data.
     *
     * @param data
     *            the data for the template.
     *
     * @throws ResourcesException
     *             if there was an error loading the text.
     */
    String getText(Object... data) throws ResourcesException;

    /**
     * Process the template and returns the text.
     * 

     * The processed text is cached and is returned for the same data.
     *
     * @param invalidate
     *            set to {@code true} to invalidate the cache before processing
     *            the text.
     *
     * @param data
     *            the data for the template.
     *
     * @throws ResourcesException
     *             if there was an error loading the text.
     *
     * @since 1.1
     */
    String getText(boolean invalidate, Object... data)
            throws ResourcesException;

    /**
     * Invalidate the template resource. Delete the cached resource so a
     * subsequent call of {@link #getText(Object...)} will process the template.
     * 
     * Use this if the data for the template have changed.
     */
    void invalidate();

    /**
     * Returns the properties of the template resource.
     *
     * @return the {@link Properties}.
     */
    Properties getProperties();

    /**
     * Returns the attributes for the template engine.
     *
     * @return the attributes {@link Map}.
     *
     * @since 1.4
     */
    Map getAttributes();

    /**
     * Returns the template engine of the resource.
     *
     * @return the template engine of the resource.
     *
     * @since 2.1
     */
     T getTemplate();
}