Package org.opensearch.script.mustache

Class MustacheScriptEngine

java.lang.Object

org.opensearch.script.mustache.MustacheScriptEngine

All Implemented Interfaces:

Closeable, AutoCloseable, ScriptEngine

public final class MustacheScriptEngine
extends Object
implements ScriptEngine

Main entry point handling template registration, compilation and execution. Template handling is based on Mustache. Template handling is a two step process: First compile the string representing the template, the resulting Mustache object can then be re-used for subsequent executions.

Field Summary

Fields

Modifier and Type	Field	Description
static final String	NAME

Constructor Summary

Constructors

Constructor	Description
MustacheScriptEngine()

Method Summary

Modifier and Type	Method	Description
<T> T	compile(String templateName, String templateSource, ScriptContext<T> context, Map<String,String> options)	Compile a template string to (in this case) a Mustache object than can later be re-used for execution to fill in missing parameter values.
Set<ScriptContext<?>>	getSupportedContexts()
String	getType()

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.opensearch.script.ScriptEngine

close

Field Details

NAME

public static final String NAME

See Also:

• Constant Field Values

Constructor Details

MustacheScriptEngine

public MustacheScriptEngine()

Method Details

compile

public <T> T compile(String templateName,
 String templateSource,
 ScriptContext<T> context,
 Map<String,String> options)

Compile a template string to (in this case) a Mustache object than can later be re-used for execution to fill in missing parameter values.

Specified by:

compile in interface ScriptEngine

Parameters:

templateSource - a string representing the template to compile.

Returns:

a compiled template object for later execution.

getSupportedContexts

public Set<ScriptContext<?>> getSupportedContexts()

Specified by:

getSupportedContexts in interface ScriptEngine

getType

public String getType()

Specified by:

getType in interface ScriptEngine