com.github.jknack.handlebars.internal

Enum JSEngine

java.lang.Object

java.lang.Enum<JSEngine>

com.github.jknack.handlebars.internal.JSEngine

All Implemented Interfaces:

Serializable, Comparable<JSEngine>

public enum JSEngine
extends Enum<JSEngine>

Convert a template to JavaScript template (a.k.a precompiled template). Compilation is done by handlebars.js and a JS Engine. For now, default and unique engine is Rhino.

Author:

edgar

Enum Constant Summary

Enum Constants

Enum Constant and Description
RHINO The default JS Engine.

Method Summary

Methods

Modifier and Type	Method and Description
abstract String	toJavaScript(String hbslocation, String filename, String template) Convert a template text to JavaScript template (a.k.a precompiled template).
abstract String	toJavaScript(String hbslocation, Template template) Convert this template to JavaScript template (a.k.a precompiled template).
static JSEngine	valueOf(String name) Returns the enum constant of this type with the specified name.
static JSEngine[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

RHINO

public static final JSEngine RHINO

The default JS Engine.

Method Detail

values

public static JSEngine[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (JSEngine c : JSEngine.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static JSEngine valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null

toJavaScript

public abstract String toJavaScript(String hbslocation,
                  Template template)

Convert this template to JavaScript template (a.k.a precompiled template). Compilation is done by handlebars.js and a JS Engine (usually Rhino).

Parameters:

hbslocation - Location of the handlebars.js file.

template - The template to convert.

Returns:

A pre-compiled JavaScript version of this template.

toJavaScript

public abstract String toJavaScript(String hbslocation,
                  String filename,
                  String template)

Convert a template text to JavaScript template (a.k.a precompiled template). Compilation is done by handlebars.js and a JS Engine (usually Rhino).

Parameters:

hbslocation - Location of the handlebars.js file.

filename - Template file name.

template - The template to convert.

Returns:

A pre-compiled JavaScript version of this template.