org.thymeleaf.context.IContext Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of org.everit.osgi.bundles.org.thymeleaf.thymeleaf Show documentation
XML/XHTML/HTML5 template engine for Java
The newest version!
/*
 * =============================================================================
 * 
 *   Copyright (c) 2011-2013, The THYMELEAF team (http://www.thymeleaf.org)
 * 
 *   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.thymeleaf.context;

import java.util.Locale;

/**
 * 
 *   Interface for all context implementations.
 * 
 * 
 *   A context object will be used for each template execution, and every context
 *   implementation must offer at least:
 * 
 * 
 *   The map of variables, in the form of a {@link VariablesMap} object.
 *   The locale that will be used for template execution.
 *   A way to (optionally) add an "execution info" object to the map of variables, containing
 *       execution info like template name, timestamp, etc. 
 * 
 * 
 * @author Daniel Fernández
 * 
 * @since 1.0
 *
 */
public interface IContext {
    
    /**
     * 
     *   Returns the {@link VariablesMap} object containing the variables that will be
     *   available for the execution of expressions inside templates.
     * 
     * 
     * @return the variables map.
     */
    public VariablesMap getVariables();

    /**
     * 
     *   Returns the locale that will be used for template execution. This locale will
     *   determine the language of the externalized messages resolved by the message
     *   resolvers. 
     * 
     * 
     * @return the locale to be used for template execution.
     */
    public Locale getLocale();

    
    /**
     * 
     *   Initializes the IContext object with the (optional) addition
     *   of an "execution info" variable (usually called execInfo)
     *   to the variables map.
     * 
     * 
     *   Each implementation of IContext will be responsible for the addition
     *   of a specialized object of the class it prefers (implementation of the
     *   {@link IContextExecutionInfo} interface is recommended but not required).
     * 
     * 
     * @param templateName the name of the template being executed
     */
    public void addContextExecutionInfo(final String templateName);
    
    
}