Module io.jstach.jstache

Package io.jstach.jstache

Enum Class JStacheFlags.Flag

java.lang.Object

java.lang.Enum<JStacheFlags.Flag>

io.jstach.jstache.JStacheFlags.Flag

All Implemented Interfaces:

Serializable, Comparable<JStacheFlags.Flag>, Constable

Enclosing class:

JStacheFlags

public static enum JStacheFlags.Flag
extends Enum<JStacheFlags.Flag>

Compiler flags.

Author:

agentgt

API Note

SUBJECT TO CHANGE!

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
DEBUG	This will produce additional logging that is sent to standard out while the annotation processor runs (not during runtime).
NO_INVERTED_BROKEN_CHAIN	Per mustache spec dotted names can actually not exist at all for inverted sections.

Method Summary

Modifier and Type	Method	Description
static JStacheFlags.Flag	valueOf(String name)	Returns the enum constant of this class with the specified name.
static JStacheFlags.Flag[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class java.lang.Enum

compareTo, describeConstable, equals, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

DEBUG

public static final JStacheFlags.Flag DEBUG

This will produce additional logging that is sent to standard out while the annotation processor runs (not during runtime).

NO_INVERTED_BROKEN_CHAIN

public static final JStacheFlags.Flag NO_INVERTED_BROKEN_CHAIN

Per mustache spec dotted names can actually not exist at all for inverted sections. This flag disables that so that a compiler failure will happen if the fields are missing. For example assume "missing" is not present on "data" as in data has no field or method called "missing".

 {{^data.missing}}
 {{/data.missing}}
 

Normally the above will compile just fine per the spec but this can lead to bugs. To not allow what the spec calls "dotted broken chains" you can use this flag.

Method Details

values

public static JStacheFlags.Flag[] values()

Returns an array containing the constants of this enum class, in the order they are declared.

Returns:

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

valueOf

public static JStacheFlags.Flag valueOf(String name)

Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (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 class has no constant with the specified name

NullPointerException - if the argument is null