freemarker.template.TemplateHashModel Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of freemarker-gae Show documentation

Google App Engine compliant variation of FreeMarker. FreeMarker is a "template engine"; a generic tool to generate text output based on templates.

There is a newer version: 2.3.34

Show newest version

/*
 * Copyright 2014 Attila Szegedi, Daniel Dekany, Jonathan Revusky
 * 
 * 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 freemarker.template;

/**
 * "hash" template language data type: an object that contains other objects accessible through string keys
 * (sub-variable names).
 * 
 * In templates they are used like {@code myHash.myKey} or {@code myHash[myDynamicKey]}. 
 */
public interface TemplateHashModel extends TemplateModel {
    
    /**
     * Gets a TemplateModel from the hash.
     *
     * @param key the name by which the TemplateModel
     * is identified in the template.
     * @return the TemplateModel referred to by the key,
     * or null if not found.
     */
    TemplateModel get(String key) throws TemplateModelException;

    boolean isEmpty() throws TemplateModelException;
}