org.jboss.windup.config.metadata

Enum RuleMetadataType

java.lang.Object

java.lang.Enum<RuleMetadataType>

org.jboss.windup.config.metadata.RuleMetadataType

All Implemented Interfaces:

Serializable, Comparable<RuleMetadataType>

public enum RuleMetadataType
extends Enum<RuleMetadataType>

Author:

Lincoln Baxter, III

Enum Constant Summary

Enum Constants

Enum Constant and Description
AUTO_COMMIT Whether or not to call commit after each Rule execution.
HALT_ON_EXCEPTION Whether Windup should stop execution if this provider's rule execution ends with an exception.
ORIGIN The Rule origin.
RULE_PROVIDER The AbstractRuleProvider that originated this rule
RULE_XML Contains the raw xml that produced this Rule.
TAGS The tags describing this Rule.

Method Summary

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

RULE_PROVIDER

public static final RuleMetadataType RULE_PROVIDER

The AbstractRuleProvider that originated this rule

RULE_XML

public static final RuleMetadataType RULE_XML

Contains the raw xml that produced this Rule.

ORIGIN

public static final RuleMetadataType ORIGIN

The Rule origin.

TAGS

public static final RuleMetadataType TAGS

The tags describing this Rule.

AUTO_COMMIT

public static final RuleMetadataType AUTO_COMMIT

Whether or not to call commit after each Rule execution. The default behavior (if this is not set) is to autocommit after each rule execution.

HALT_ON_EXCEPTION

public static final RuleMetadataType HALT_ON_EXCEPTION

Whether Windup should stop execution if this provider's rule execution ends with an exception. By default, the exceptions are only logged and the failing rule appears in report. The rule itself is responsible for handling exceptions and storing them into the graph.

Method Detail

values

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

Returns:

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

valueOf

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