com.github.jknack.handlebars.internal

Enum ParamType

java.lang.Object

java.lang.Enum<ParamType>

com.github.jknack.handlebars.internal.ParamType

All Implemented Interfaces:

Serializable, Comparable<ParamType>

public enum ParamType
extends Enum<ParamType>

A strategy for parameter type resolver.

Since:

0.1.0

Author:

edgar.espina

Enum Constant Summary

Enum Constants

Enum Constant and Description
BOOLEAN Matches true or false.
CONTEXT Resolve the parameter type as Context#context().
INTEGER Matches a integer value.
REFERENCE Matches a reference value.
STRING Matches ".*" expressions.
SUB_EXPRESSION Sub-expression are inner-helper invocations.

Method Summary

Methods

Modifier and Type	Method and Description
static Object	parse(Context context, Object param) Parse the given parameter to a runtime representation.
static ParamType	valueOf(String name) Returns the enum constant of this type with the specified name.
static ParamType[]	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

CONTEXT

public static final ParamType CONTEXT

Resolve the parameter type as Context#context().

STRING

public static final ParamType STRING

Matches ".*" expressions.

BOOLEAN

public static final ParamType BOOLEAN

Matches true or false.

INTEGER

public static final ParamType INTEGER

Matches a integer value.

REFERENCE

public static final ParamType REFERENCE

Matches a reference value.

SUB_EXPRESSION

public static final ParamType SUB_EXPRESSION

Sub-expression are inner-helper invocations.

Method Detail

values

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

Returns:

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

valueOf

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

parse

public static Object parse(Context context,
           Object param)
                    throws IOException

Parse the given parameter to a runtime representation.

Parameters:

context - The current context.

param - The candidate parameter.

Returns:

The parameter value at runtime.

Throws:

IOException - If param can't be applied.