Package io.vertx.mutiny.ext.web.common.template

Class TemplateEngine

java.lang.Object
io.vertx.mutiny.ext.web.common.template.TemplateEngine
All Implemented Interfaces:
MutinyDelegate
Direct Known Subclasses:
FreeMarkerTemplateEngine, HandlebarsTemplateEngine, HTTLTemplateEngine, JadeTemplateEngine, MVELTemplateEngine, PebbleTemplateEngine, PugTemplateEngine, RockerTemplateEngine, ThymeleafTemplateEngine
public class TemplateEngine extends Object implements MutinyDelegate
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.

NOTE: This class has been automatically generated from the original non Mutiny-ified interface using Vert.x codegen.

  • Field Details

  • Constructor Details

    • TemplateEngine

      public TemplateEngine(io.vertx.ext.web.common.template.TemplateEngine delegate)

    • TemplateEngine

      public TemplateEngine(Object delegate)

  • Method Details

    • getDelegate

      public io.vertx.ext.web.common.template.TemplateEngine getDelegate()
      Specified by:
      getDelegate in interface MutinyDelegate
      Returns:
      the delegate used by this Mutiny object of generated type

    • toString

      public String toString()
      Overrides:
      toString in class Object

    • equals

      public boolean equals(Object o)
      Overrides:
      equals in class Object

    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class Object

    • render

      @CheckReturnValue public io.smallrye.mutiny.Uni<Buffer> render(io.vertx.core.json.JsonObject context, String templateFileName)
      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".

      Unlike the bare Vert.x variant, this method returns a Uni. Don't forget to subscribe on it to trigger the operation.

      Parameters:
      context - the routing context
      templateFileName - the template file name to use
      Returns:
      the uni firing the result of the operation when completed, or a failure if the operation failed.

    • renderAndAwait

      public Buffer renderAndAwait(io.vertx.core.json.JsonObject context, String templateFileName)
      Blocking variant of render(JsonObject,String).

      This method waits for the completion of the underlying asynchronous operation. If the operation completes successfully, the result is returned, otherwise the failure is thrown (potentially wrapped in a RuntimeException).

      Parameters:
      context - the routing context
      templateFileName - the template file name to use
      Returns:
      the Buffer instance produced by the operation.

    • renderAndForget

      public void renderAndForget(io.vertx.core.json.JsonObject context, String templateFileName)
      Variant of render(JsonObject,String) that ignores the result of the operation.

      This method subscribes on the result of render(JsonObject,String), but discards the outcome (item or failure). This method is useful to trigger the asynchronous operation from render(JsonObject,String) but you don't need to compose it with other operations.

      Parameters:
      context - the routing context
      templateFileName - the template file name to use

    • clearCache

      public void clearCache()

    • render

      @CheckReturnValue public io.smallrye.mutiny.Uni<Buffer> render(Map<String,Object> context, String templateFileName)
      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".

      Unlike the bare Vert.x variant, this method returns a Uni. Don't forget to subscribe on it to trigger the operation.

      Parameters:
      context - the routing context
      templateFileName - the template file name to use
      Returns:
      the uni firing the result of the operation when completed, or a failure if the operation failed.

    • renderAndAwait

      public Buffer renderAndAwait(Map<String,Object> context, String templateFileName)
      Blocking variant of render(Map,String).

      This method waits for the completion of the underlying asynchronous operation. If the operation completes successfully, the result is returned, otherwise the failure is thrown (potentially wrapped in a RuntimeException).

      Parameters:
      context - the routing context
      templateFileName - the template file name to use
      Returns:
      the Buffer instance produced by the operation.

    • renderAndForget

      public void renderAndForget(Map<String,Object> context, String templateFileName)
      Variant of render(Map,String) that ignores the result of the operation.

      This method subscribes on the result of render(Map,String), but discards the outcome (item or failure). This method is useful to trigger the asynchronous operation from render(Map,String) but you don't need to compose it with other operations.

      Parameters:
      context - the routing context
      templateFileName - the template file name to use

    • unwrap

      public <T> T unwrap()
      Returns:
      the engine instance.

    • newInstance

      public static TemplateEngine newInstance(io.vertx.ext.web.common.template.TemplateEngine arg)