hr.ngs.templater

Enum Handled

java.lang.Object

java.lang.Enum<Handled>

hr.ngs.templater.Handled

All Implemented Interfaces:

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

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

Specifying behavior of Templater after the handler.

Common usage of handler is to remove region of the document, but various scenarios can be taken after the removal. If handler is not relevant, Nothing should be returned, which will result in invocation of next registered handler.

Enum Constant Summary

Enum Constants

Enum Constant and Description
CURRENT_CONTEXT If other tags in the same context are also handled by the plugin, instruct Templater to avoid further processing of tags in this context
NESTED_TAGS When plugin handles this and nested tags.
NOTHING Indicate that handler is not applicable and Templater should call next plugin
OTHER_HANDLERS Indicate that plugin is applicable, that next plugin should not be called, but normal processing should continue as usual - calling replace on the tag
THIS_TAG Indicate that plugin has processed this tag, but has not processed nested or other tags.
WHOLE_OBJECT If other tags on the same level are also handled by the plugin, instruct Templater to avoid further processing of tags on this level

Method Summary

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

Methods inherited from class java.lang.Enum

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

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

NOTHING

public static final Handled NOTHING

Indicate that handler is not applicable and Templater should call next plugin

OTHER_HANDLERS

public static final Handled OTHER_HANDLERS

Indicate that plugin is applicable, that next plugin should not be called, but normal processing should continue as usual - calling replace on the tag

THIS_TAG

public static final Handled THIS_TAG

Indicate that plugin has processed this tag, but has not processed nested or other tags. If there are nested tags Templater will continue processing them as usual

NESTED_TAGS

public static final Handled NESTED_TAGS

When plugin handles this and nested tags. Templater will avoid calling into other plugins and will not call into nested tags

WHOLE_OBJECT

public static final Handled WHOLE_OBJECT

If other tags on the same level are also handled by the plugin, instruct Templater to avoid further processing of tags on this level

CURRENT_CONTEXT

public static final Handled CURRENT_CONTEXT

If other tags in the same context are also handled by the plugin, instruct Templater to avoid further processing of tags in this context

Method Detail

values

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

Returns:

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

valueOf

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