Class TemplateEngine
- java.lang.Object
-
- io.vertx.rxjava3.ext.web.common.template.TemplateEngine
-
- All Implemented Interfaces:
io.vertx.lang.rx.RxDelegate
- Direct Known Subclasses:
FreeMarkerTemplateEngine,HandlebarsTemplateEngine,MVELTemplateEngine,PebbleTemplateEngine,PugTemplateEngine,RockerTemplateEngine,ThymeleafTemplateEngine
public class TemplateEngine extends Object implements io.vertx.lang.rx.RxDelegate
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
originalnon RX-ified interface using Vert.x codegen.
-
-
Field Summary
Fields Modifier and Type Field Description static io.vertx.lang.rx.TypeArg<TemplateEngine>__TYPE_ARG
-
Constructor Summary
Constructors Constructor Description TemplateEngine(TemplateEngine delegate)TemplateEngine(Object delegate)
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description voidclearCache()Clears any internal caches used by this engine.booleanequals(Object o)TemplateEnginegetDelegate()inthashCode()static TemplateEnginenewInstance(TemplateEngine arg)Single<Buffer>render(JsonObject context, String templateFileName)Render the template.Single<Buffer>render(Map<String,Object> context, String templateFileName)Render the template.Single<Buffer>rxRender(JsonObject context, String templateFileName)Render the template.Single<Buffer>rxRender(Map<String,Object> context, String templateFileName)Render the template.StringtoString()Objectunwrap()Returns the underlying engine, so further configurations or customizations may be applied ornullwhen the engine cannot unwrap it.
-
-
-
Field Detail
-
__TYPE_ARG
public static final io.vertx.lang.rx.TypeArg<TemplateEngine> __TYPE_ARG
-
-
Constructor Detail
-
TemplateEngine
public TemplateEngine(TemplateEngine delegate)
-
TemplateEngine
public TemplateEngine(Object delegate)
-
-
Method Detail
-
getDelegate
public TemplateEngine getDelegate()
- Specified by:
getDelegatein interfaceio.vertx.lang.rx.RxDelegate
-
render
public Single<Buffer> render(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".- Parameters:
context- the routing contexttemplateFileName- the template file name to use- Returns:
- a future notified with a result containing the buffer or a failure
-
rxRender
public Single<Buffer> rxRender(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".- Parameters:
context- the routing contexttemplateFileName- the template file name to use- Returns:
- a future notified with a result containing the buffer or a failure
-
clearCache
public void clearCache()
Clears any internal caches used by this engine. For most engines this means clearing the vert.x cache, implementations that do not use vert.x as a cache should clear their own cache.
-
render
public Single<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".- Parameters:
context- the routing contexttemplateFileName- the template file name to use- Returns:
- a future notified with a result containing the buffer or a failure
-
rxRender
public Single<Buffer> rxRender(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".- Parameters:
context- the routing contexttemplateFileName- the template file name to use- Returns:
- a future notified with a result containing the buffer or a failure
-
unwrap
public Object unwrap()
Returns the underlying engine, so further configurations or customizations may be applied ornullwhen the engine cannot unwrap it.- Returns:
- the engine instance.
-
newInstance
public static TemplateEngine newInstance(TemplateEngine arg)
-
-