play.templates.Template Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of framework Show documentation

RePlay is a fork of the Play1 framework, created by Codeborne.

There is a newer version: 2.6.3

package play.templates;

import java.util.HashMap;
import java.util.Map;

public abstract class Template {

    public final String name;

    protected Template(String name) {
        this.name = name;
    }

    public abstract void compile();

    /**
     * Starts the rendering process without modifying the args-map
     * 
     * @param args
     *            map containing data binding info
     * @return the result of the complete rendering
     */
    public String render(Map args) {
        // starts the internal recursive rendering process with
        // a copy of the passed args-map. This is done
        // to prevent us from pollution the users map with
        // template-rendering-specific internal data
        //
        // Since the original args is not polluted it can be used as input
        // to another rendering operation later
        return internalRender(new HashMap<>(args));
    }

    /**
     * The internal rendering method - When one template calls another template, this method is used. The input args-map
     * is constantly being modified, as different templates "communicate" with each other by storing info in the map
     * 
     * @param args
     *            List of arguments use in render
     * @return The template result as string
     */
    protected abstract String internalRender(Map args);

    public String render() {
        return internalRender(new HashMap<>());
    }

    public String getName() {
        return name;
    }

}