/*
* Copyright 2014 Red Hat, Inc.
*
* All rights reserved. This program and the accompanying materials
* are made available under the terms of the Eclipse Public License v1.0
* and Apache License v2.0 which accompanies this distribution.
*
* The Eclipse Public License is available at
* http://www.eclipse.org/legal/epl-v10.html
*
* The Apache License v2.0 is available at
* http://www.opensource.org/licenses/apache2.0.php
*
* You may elect to redistribute this code under either of these licenses.
*/
package io.vertx.ext.web.common.template;
import io.vertx.codegen.annotations.GenIgnore;
import io.vertx.codegen.annotations.VertxGen;
import io.vertx.core.AsyncResult;
import io.vertx.core.Handler;
import io.vertx.core.buffer.Buffer;
import io.vertx.core.json.JsonObject;
import java.util.Map;
A template template uses a specific template and the data in a routing context to render a resource into a buffer.
Concrete implementations exist for several well-known template engines.
Author: Tim Fox
/**
* A template template uses a specific template and the data in a routing context to render a resource into a buffer.
* <p>
* Concrete implementations exist for several well-known template engines.
*
* @author <a href="http://tfox.org">Tim Fox</a>
*/
@VertxGen
public interface TemplateEngine {
Render the template. Template engines that support partials/fragments should extract the template base path from
the template filename up to the last file separator.
Some engines support localization, for these engines, there is a predefined key "lang" to specify the language to
be used in the localization, the format should follow the standard locale formats e.g.: "en-gb", "pt-br", "en".
Params: - context – the routing context
- templateFileName – the template file name to use
- handler – the handler that will be called with a result containing the buffer or a failure.
/**
* Render the template. Template engines that support partials/fragments should extract the template base path from
* the template filename up to the last file separator.
*
* Some engines support localization, for these engines, there is a predefined key "lang" to specify the language to
* be used in the localization, the format should follow the standard locale formats e.g.: "en-gb", "pt-br", "en".
*
* @param context the routing context
* @param templateFileName the template file name to use
* @param handler the handler that will be called with a result containing the buffer or a failure.
*/
default void render(JsonObject context, String templateFileName, Handler<AsyncResult<Buffer>> handler) {
render(context.getMap(), templateFileName, handler);
}
Render the template. Template engines that support partials/fragments should extract the template base path from
the template filename up to the last file separator.
Some engines support localization, for these engines, there is a predefined key "lang" to specify the language to
be used in the localization, the format should follow the standard locale formats e.g.: "en-gb", "pt-br", "en".
Params: - context – the routing context
- templateFileName – the template file name to use
- handler – the handler that will be called with a result containing the buffer or a failure.
/**
* Render the template. Template engines that support partials/fragments should extract the template base path from
* the template filename up to the last file separator.
*
* Some engines support localization, for these engines, there is a predefined key "lang" to specify the language to
* be used in the localization, the format should follow the standard locale formats e.g.: "en-gb", "pt-br", "en".
*
* @param context the routing context
* @param templateFileName the template file name to use
* @param handler the handler that will be called with a result containing the buffer or a failure.
*/
@GenIgnore(GenIgnore.PERMITTED_TYPE)
void render(Map<String, Object> context, String templateFileName, Handler<AsyncResult<Buffer>> handler);
Returns true if the template template caches template files. If false, then template files are freshly loaded each
time they are used.
Returns: True if template files are cached; otherwise, false.
/**
* Returns true if the template template caches template files. If false, then template files are freshly loaded each
* time they are used.
*
* @return True if template files are cached; otherwise, false.
*/
boolean isCachingEnabled();
}