Keyword (Rythm Template Engine 1.1.1-SNAPSHOT API)

java.lang.Object
- java.lang.Enum<Keyword>
- - org.rythmengine.internal.Keyword

All Implemented Interfaces:

Serializable, Comparable<Keyword>, IKeyword
```
public enum Keyword
extends Enum<Keyword>
implements IKeyword
```

Enum Constant Summary

Enum Constants
Enum Constant and Description
`ARGS` Declare arguments used in the template
`ASSIGN` Assign enclosed part into a String variable
`BREAK` break current loop
`CACHE` Cache the block for a certain period
`CASE`
`COMPACT` Force compact mode in regard of engine.conf().compactEnabled()
`CONTINUE` Continue current loop
`DEBUG` output debug message
`EACH` Foreach loop
`ESCAPE` Mark a section that expression should be output after escaped
`EXEC` Execute an macro
`EXIT_IF_NO_CLASS` Exit parsing process if no class loaded in current class loader
`EXPAND` Expand an macro, alias of exec
`EXTENDS` Declare parent template for this template
`FINALLY` Mark a finally section.
`GET` Fetch named content from this or sub template
`I18N` Lookup i18n message
`IF` plain java if else block
`IMPORT` import java packages/classes
`INCLUDE` include other templates
`INIT` Mark a section init code.
`INVOKE` Explicitly invoke a tag (could be used to implement dynamic tag dispatch
`LOCALE` Define a different locale block
`LOG_TIME` Instruct that this template needs to log execution time
`MACRO` Define an macro.
`NOCOMPACT` For no compact in regard to engine.conf().compactEnabled()
`NOSIM` Indicate this is not a SIM template
`RAW` Mark a section that expression should be output as raw data
`RENDER_BODY` Output sub template render content in place
`RENDER_INHERITED`
`RENDER_SECTION` Output sub template section content in place
`RETURN` break the current template execution process and return to caller
`RETURN_IF` break the current template execution process and return to caller if an expression evaluated to true
`SECTION` Declare a section start
`SET` Declare named content to be used in this or parent template
`SIMPLE` Identify current template is a simple template
`SWITCH`
`TAG` define tag
`THIS` Call self as a tag
`TS` output timestamp
`VERBATIM` Verbatim tag mark a block of template source shall not be parsed

Method Summary

Methods
Modifier and Type	Method and Description
`boolean`	`isRegexp()`
`String`	`toString()`
`static Keyword`	`valueOf(String name)` Returns the enum constant of this type with the specified name.
`static Keyword[]`	`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, valueOf

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

- Enum Constant Detail
  - ASSIGN
```
public static final Keyword ASSIGN
```
    Assign enclosed part into a String variable
  - ARGS
```
public static final Keyword ARGS
```
    Declare arguments used in the template
  - BREAK
```
public static final Keyword BREAK
```
    break current loop
  - CACHE
```
public static final Keyword CACHE
```
    Cache the block for a certain period
  - CASE
```
public static final Keyword CASE
```
  - COMPACT
```
public static final Keyword COMPACT
```
    Force compact mode in regard of engine.conf().compactEnabled()
  - CONTINUE
```
public static final Keyword CONTINUE
```
    Continue current loop
  - DEBUG
```
public static final Keyword DEBUG
```
    output debug message
  - EACH
```
public static final Keyword EACH
```
    Foreach loop
  - ESCAPE
```
public static final Keyword ESCAPE
```
    Mark a section that expression should be output after escaped
  - EXEC
```
public static final Keyword EXEC
```
    Execute an macro
  - EXPAND
```
public static final Keyword EXPAND
```
    Expand an macro, alias of exec
  - EXIT_IF_NO_CLASS
```
public static final Keyword EXIT_IF_NO_CLASS
```
    Exit parsing process if no class loaded in current class loader
  - EXTENDS
```
public static final Keyword EXTENDS
```
    Declare parent template for this template
  - FINALLY
```
public static final Keyword FINALLY
```
    Mark a finally section. There can be at most one
  - GET
```
public static final Keyword GET
```
    Fetch named content from this or sub template
  - I18N
```
public static final Keyword I18N
```
    Lookup i18n message
  - IF
```
public static final Keyword IF
```
    plain java if else block
  - IMPORT
```
public static final Keyword IMPORT
```
    import java packages/classes
  - INCLUDE
```
public static final Keyword INCLUDE
```
    include other templates
  - INIT
```
public static final Keyword INIT
```
    Mark a section init code. There can be at most one @init{} section per template
  - INVOKE
```
public static final Keyword INVOKE
```
    Explicitly invoke a tag (could be used to implement dynamic tag dispatch
  - LOCALE
```
public static final Keyword LOCALE
```
    Define a different locale block
  - LOG_TIME
```
public static final Keyword LOG_TIME
```
    Instruct that this template needs to log execution time
  - MACRO
```
public static final Keyword MACRO
```
    Define an macro.
    A macro is different from an assignment or an inline tag in that it is purely happen at parsing time, while the assign and inline tag is evaluated at runtime
  - NOCOMPACT
```
public static final Keyword NOCOMPACT
```
    For no compact in regard to engine.conf().compactEnabled()
  - NOSIM
```
public static final Keyword NOSIM
```
    Indicate this is not a SIM template
  - RAW
```
public static final Keyword RAW
```
    Mark a section that expression should be output as raw data
  - RENDER_BODY
```
public static final Keyword RENDER_BODY
```
    Output sub template render content in place
  - RENDER_INHERITED
```
public static final Keyword RENDER_INHERITED
```
  - RENDER_SECTION
```
public static final Keyword RENDER_SECTION
```
    Output sub template section content in place
  - RETURN
```
public static final Keyword RETURN
```
    break the current template execution process and return to caller
  - RETURN_IF
```
public static final Keyword RETURN_IF
```
    break the current template execution process and return to caller if an expression evaluated to true
  - SECTION
```
public static final Keyword SECTION
```
    Declare a section start
  - SET
```
public static final Keyword SET
```
    Declare named content to be used in this or parent template
  - SIMPLE
```
public static final Keyword SIMPLE
```
    Identify current template is a simple template
  - SWITCH
```
public static final Keyword SWITCH
```
  - THIS
```
public static final Keyword THIS
```
    Call self as a tag
  - TS
```
public static final Keyword TS
```
    output timestamp
  - TAG
```
public static final Keyword TAG
```
    define tag
  - VERBATIM
```
public static final Keyword VERBATIM
```
    Verbatim tag mark a block of template source shall not be parsed
- Method Detail
  - values
```
public static Keyword[] 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 (Keyword c : Keyword.values())
    System.out.println(c);
```
    Returns:
    an array containing the constants of this enum type, in the order they are declared
  - valueOf
```
public static Keyword 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
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Enum<Keyword>
  - isRegexp
```
public boolean isRegexp()
```
    Specified by:
    
    isRegexp in interface IKeyword

Enum Keyword

Enum Constant Summary

Method Summary

Methods inherited from class java.lang.Enum

Methods inherited from class java.lang.Object

Enum Constant Detail

ASSIGN

ARGS

BREAK

CACHE

CASE

COMPACT

CONTINUE

DEBUG

EACH

ESCAPE

EXEC

EXPAND

EXIT_IF_NO_CLASS

EXTENDS

FINALLY

GET

I18N

IF

IMPORT

INCLUDE

INIT

INVOKE

LOCALE

LOG_TIME

MACRO

NOCOMPACT

NOSIM

RAW

RENDER_BODY

RENDER_INHERITED

RENDER_SECTION

RETURN

RETURN_IF

SECTION

SET

SIMPLE

SWITCH

THIS

TS

TAG

VERBATIM

Method Detail

values

valueOf

toString

isRegexp