au.com.codeka.carrot.tmpl.parse

Enum TokenType

java.lang.Object

java.lang.Enum<TokenType>

au.com.codeka.carrot.tmpl.parse.TokenType

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<TokenType>

public enum TokenType
extends java.lang.Enum<TokenType>

An enumeration which describes the different types of tokens we can parse.

Enum Constant Summary

Enum Constants

Enum Constant and Description
COMMENT A comment token is of the form {# foo #}, where "foo" is the content.
ECHO An echo token is of the form {{ foo }}, where "foo" is the content.
FIXED A fixed token is anything outside of a {{foo}} or {%foo%} etc.
TAG A tag token is of the form {% foo %}, where "foo" is the content.
UNKNOWN Unknown token usually represents the end of the file.

Method Summary

Modifier and Type	Method and Description
static TokenType	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static TokenType[]	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

UNKNOWN

public static final TokenType UNKNOWN

Unknown token usually represents the end of the file.

FIXED

public static final TokenType FIXED

A fixed token is anything outside of a {{foo}} or {%foo%} etc.

TAG

public static final TokenType TAG

A tag token is of the form {% foo %}, where "foo" is the content.

ECHO

public static final TokenType ECHO

An echo token is of the form {{ foo }}, where "foo" is the content.

COMMENT

public static final TokenType COMMENT

A comment token is of the form {# foo #}, where "foo" is the content.

Method Detail

values

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

Returns:

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

valueOf

public static TokenType valueOf(java.lang.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:

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

java.lang.NullPointerException - if the argument is null