org.thymeleaf.dialect.IExpressionEnhancingDialect 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.dialect;

import java.util.Map;

import org.thymeleaf.context.IProcessingContext;

/**
 * 
 *   Feature-specifier interface for {@link IDialect} implementations.
 * 
 * 
 *   Implementing this interface allows dialects to specify a series of objects that will be added
 *   to the context as utility objects during expression evaluations.
 * 
 * 
 *   This means, for example, that a dialect could add a util object so that it could be
 *   used in OGNL or SpringEL expression evaluations like ${#util.doThis(obj)}. 
 * 
 * 
 * @author Daniel Fernández
 * 
 * @since 2.0.12
 *
 */
public interface IExpressionEnhancingDialect extends IDialect {


    /**
     * 
     *   Returns the objects that should be added to expression evaluation contexts.
     * 
     * 
     *   This means, for example, that a dialect could add a util object so that it could be
     *   used in OGNL or SpringEL expression evaluations like ${#util.doThis(obj)}. 
     * 
     * 
     * @param processingContext the processing context on which the expression evaluation will be performed.
     * @return the Map of objects to be added to the expression evaluation context.
     */
    public Map getAdditionalExpressionObjects(final IProcessingContext processingContext);

}