hr.ngs.templater

Enum DocumentFactoryBuilder.RemovalOption

java.lang.Object

java.lang.Enum<DocumentFactoryBuilder.RemovalOption>

hr.ngs.templater.DocumentFactoryBuilder.RemovalOption

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<DocumentFactoryBuilder.RemovalOption>

Enclosing interface:

DocumentFactoryBuilder

public static enum DocumentFactoryBuilder.RemovalOption
extends java.lang.Enum<DocumentFactoryBuilder.RemovalOption>

How to deal with tag detected in XML. It can be removed from XML before calling the plugin, after calling the plugin, or by the plugin itself.

Enum Constant Summary

Enum Constants

Enum Constant and Description
AFTER Remove tag from XML after calling the plugin.
BEFORE Remove tag from XML before calling the plugin
MANUAL In cases where we need to have absolute control over tag removal we can remove it manually from XML.

Method Summary

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

BEFORE

public static final DocumentFactoryBuilder.RemovalOption BEFORE

Remove tag from XML before calling the plugin

AFTER

public static final DocumentFactoryBuilder.RemovalOption AFTER

Remove tag from XML after calling the plugin. This is mostly for convenience to avoid manual tag removal from within the plugin.

MANUAL

public static final DocumentFactoryBuilder.RemovalOption MANUAL

In cases where we need to have absolute control over tag removal we can remove it manually from XML. Cases could be to preserve the original tags until the last one was processed.

Method Detail

values

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

Returns:

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

valueOf

public static DocumentFactoryBuilder.RemovalOption 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