freemarker.template
Enum TemplateProcessor.ExitStatus

java.lang.Object
  java.lang.Enum<TemplateProcessor.ExitStatus>
      freemarker.template.TemplateProcessor.ExitStatus

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<TemplateProcessor.ExitStatus>

Enclosing interface:

TemplateProcessor

public static enum TemplateProcessor.ExitStatus
extends java.lang.Enum<TemplateProcessor.ExitStatus>

Enumates the return values from a template processor. The caller will sometimes need to perform special actions based on the result.

Enum Constant Summary

BREAK
Constant returned by process() indicating that this is the result of a break instruction.

EXIT
Constant returned by process() indicating that this is the result of an exit instruction.

OK
Constant returned by process() indicating that this is normal control flow.

UNCOMPILED_TEMPLATE
Constant returned by process() indicating that this is the result of a template compilation error.

Method Summary

static TemplateProcessor.ExitStatus	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static TemplateProcessor.ExitStatus[]	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

OK

public static final TemplateProcessor.ExitStatus OK

Constant returned by process() indicating that this is normal control flow.

BREAK

public static final TemplateProcessor.ExitStatus BREAK

Constant returned by process() indicating that this is the result of a break instruction.

EXIT

public static final TemplateProcessor.ExitStatus EXIT

Constant returned by process() indicating that this is the result of an exit instruction.

UNCOMPILED_TEMPLATE

public static final TemplateProcessor.ExitStatus UNCOMPILED_TEMPLATE

Constant returned by process() indicating that this is the result of a template compilation error.

Method Detail

values

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

Returns:

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

valueOf

public static TemplateProcessor.ExitStatus 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