com.jetdrone.vertx.yoke.engine

Class StringPlaceholderEngine

java.lang.Object

com.jetdrone.vertx.yoke.Engine<java.lang.String>

com.jetdrone.vertx.yoke.engine.StringPlaceholderEngine

public class StringPlaceholderEngine
extends Engine<java.lang.String>

Field Summary

Fields inherited from class com.jetdrone.vertx.yoke.Engine

vertx

Constructor Summary

Constructors

Constructor and Description
StringPlaceholderEngine()

Method Summary

Methods

Modifier and Type	Method and Description
void	render(java.lang.String file, java.util.Map<java.lang.String,java.lang.Object> context, org.vertx.java.core.Handler<org.vertx.java.core.AsyncResult<java.lang.String>> handler) An interpreter for strings with named placeholders.

Methods inherited from class com.jetdrone.vertx.yoke.Engine

getContentType, getTemplateFromCache, isFresh, putTemplateToCache, read, removeFromCache, setVertx

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

StringPlaceholderEngine

public StringPlaceholderEngine()

Method Detail

render

public void render(java.lang.String file,
          java.util.Map<java.lang.String,java.lang.Object> context,
          org.vertx.java.core.Handler<org.vertx.java.core.AsyncResult<java.lang.String>> handler)

An interpreter for strings with named placeholders. For example given the string "hello ${myName}" and the map

Map map = new HashMap();

map.put("myName", "world");

the call returns "hello world" It replaces every occurrence of a named placeholder with its given value in the map. If there is a named place holder which is not found in the map then the string will retain that placeholder. Likewise, if there is an entry in the map that does not have its respective placeholder, it is ignored.

Specified by:

render in class Engine<java.lang.String>

Parameters:

file - - String representing the file path to the template

context - - Map with key values that might get substituted in the template

handler - - The future result handler with a Buffer in case of success