com.github.jknack.handlebars

Enum TagType

java.lang.Object

java.lang.Enum<TagType>

com.github.jknack.handlebars.TagType

All Implemented Interfaces:

Serializable, Comparable<TagType>

public enum TagType
extends Enum<TagType>

Tags are indicated by the double mustaches.

Since:

0.12.0

Author:

edgar.espina

Enum Constant Summary

Enum Constants

Enum Constant and Description
AMP_VAR All variables are HTML escaped by default.
SECTION Sections render blocks of text one or more times, depending on the value of the key in the current context.
SUB_EXPRESSION Same as VAR but can be invoked from inside a helper: {{helper (subexpression)}}.
TRIPLE_VAR All variables are HTML escaped by default.
VAR The most basic tag type is the variable.

Method Summary

Methods

Modifier and Type	Method and Description
boolean	inline() True for inline tags.
static TagType	valueOf(String name) Returns the enum constant of this type with the specified name.
static TagType[]	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

VAR

public static final TagType VAR

The most basic tag type is the variable. A {{name}} tag in a basic template will try to find the name key in the current context. If there is no name key, nothing will be rendered.

AMP_VAR

public static final TagType AMP_VAR

All variables are HTML escaped by default. If you want to return unescaped HTML, use the triple mustache: {{&name}}.

TRIPLE_VAR

public static final TagType TRIPLE_VAR

All variables are HTML escaped by default. If you want to return unescaped HTML, use the triple mustache: {{{name}}}.

SUB_EXPRESSION

public static final TagType SUB_EXPRESSION

Same as VAR but can be invoked from inside a helper: {{helper (subexpression)}}.

SECTION

public static final TagType SECTION

Sections render blocks of text one or more times, depending on the value of the key in the current context.

A section begins with a pound and ends with a slash. That is, {{#person}} begins a "person" section while {{/person}} ends it.

Method Detail

values

public static TagType[] 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 (TagType c : TagType.values())
    System.out.println(c);

Returns:

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

valueOf

public static TagType 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

inline

public boolean inline()

True for inline tags.

Returns:

True for inline tags.