All Downloads are FREE. Search and download functionalities are using the official Maven repository.

io.vertx.ext.web.templ.jte.JteTemplateEngine Maven / Gradle / Ivy

There is a newer version: 5.0.0.CR2
Show newest version
/*
 * 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.templ.jte;

import io.vertx.codegen.annotations.GenIgnore;
import io.vertx.codegen.annotations.VertxGen;
import io.vertx.core.Vertx;
import io.vertx.ext.web.common.WebEnvironment;
import io.vertx.ext.web.common.template.TemplateEngine;
import io.vertx.ext.web.templ.jte.impl.JteTemplateEngineImpl;

/**
 * A template engine for jte templates.
 *
 * @author Andreas Hager
 */
@VertxGen
public interface JteTemplateEngine extends TemplateEngine {

  /**
   * Creates a vert.x template engine for jte HTML templates with sane defaults.
   * 

* Hot reloading is active, when {@link WebEnvironment#development()} is true. * * @param vertx the vert.x instance * @param templateRootDirectory the directory where jte templates are located * @return the created vert.x template engine */ static JteTemplateEngine create(Vertx vertx, String templateRootDirectory) { return new JteTemplateEngineImpl(vertx, templateRootDirectory); } /** * Creates a vert.x template engine for precompiled HTML jte templates with sane defaults. *

* Hot reloading is never active. * * @return the created vert.x template engine */ static JteTemplateEngine create() { return new JteTemplateEngineImpl(); } /** * Creates a vert.x template engine for jte templates with a user custom engine. * * @return the created vert.x template engine */ @GenIgnore static JteTemplateEngine create(gg.jte.TemplateEngine engine) { return new JteTemplateEngineImpl(engine); } }





© 2015 - 2024 Weber Informatics LLC | Privacy Policy