com.buildforge.services.common.dbo
Enum FilterPatternDBO.Action
java.lang.Object
java.lang.Enum<FilterPatternDBO.Action>
com.buildforge.services.common.dbo.FilterPatternDBO.Action
- All Implemented Interfaces:
- java.io.Serializable, java.lang.Comparable<FilterPatternDBO.Action>
- Enclosing class:
- FilterPatternDBO
public static enum FilterPatternDBO.Action
- extends java.lang.Enum<FilterPatternDBO.Action>
Identifies what action should be taken when a filter pattern matches.
For each line of output from the step, each of the filter patterns is
checked in the specified order. The filters can set the step to pass,
pass with warnings, or fail. Regardless of the final status, a tally
is maintained for the total number of warning or fail
Value | Meaning |
CLEAR | The overall status of the step is
set to pass. The warning and failure event tallies are
unaffected. |
CLEAR_AND_HALT | Combines the effects of
CLEAR and HALT . |
CLEAR_WARNING | The warning flag is cleared.
The failure flag is not effected, so a step that is set to fail
will still fail. |
CLEAR_WARNING_AND_HALT | Combines the effects
of CLEAR_WARNING and HALT . |
FAIL | The overall status for the step
is set to fail. The failure tally for the step is also
incremented. |
FAIL_AND_HALT | Combines the effects of
FAIL and HALT . |
HALT | If this pattern matches, then it will
be the last one that is checked. In other words, HALT
means "Stop processing more filter patterns". |
INCLUDE | The pattern specifies the name
of another filter set to include at this point |
NOTIFY_CHANGERS | If the project has an
adaptor linked to it, and if the adaptor generated a list of
changes, then the users who are identified has having made
changes are notified of the match. Otherwise, there is no
effect. |
WARNING | The overall status for the step
is set to pass with warnings unless it was previously set to
fail by another filter. The warning tally for the step is also
incremented. |
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 |
CLEAR
public static final FilterPatternDBO.Action CLEAR
CLEAR_AND_HALT
public static final FilterPatternDBO.Action CLEAR_AND_HALT
CLEAR_WARNING
public static final FilterPatternDBO.Action CLEAR_WARNING
CLEAR_WARNING_AND_HALT
public static final FilterPatternDBO.Action CLEAR_WARNING_AND_HALT
FAIL
public static final FilterPatternDBO.Action FAIL
FAIL_AND_HALT
public static final FilterPatternDBO.Action FAIL_AND_HALT
HALT
public static final FilterPatternDBO.Action HALT
INCLUDE
public static final FilterPatternDBO.Action INCLUDE
NOTIFY_CHANGERS
public static final FilterPatternDBO.Action NOTIFY_CHANGERS
WARNING
public static final FilterPatternDBO.Action WARNING
CLASS
public static final java.lang.Class<FilterPatternDBO.Action> CLASS
code
public final char code
values
public static final FilterPatternDBO.Action[] values()
- Returns an array containing the constants of this enum type, in
the order they're declared. This method may be used to iterate
over the constants as follows:
for(FilterPatternDBO.Action c : FilterPatternDBO.Action.values())
System.out.println(c);
- Returns:
- an array containing the constants of this enum type, in
the order they're declared
valueOf
public static FilterPatternDBO.Action 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
fromDB
public static FilterPatternDBO.Action fromDB(char c)
fromObject
public static FilterPatternDBO.Action fromObject(java.lang.Object o)
throws APIException
- Throws:
APIException