org.lsst.ccs.gconsole.plugins.tracer

Enum FilterStep.Mode

java.lang.Object

java.lang.Enum<FilterStep.Mode>

org.lsst.ccs.gconsole.plugins.tracer.FilterStep.Mode

All Implemented Interfaces:

Serializable, Comparable<FilterStep.Mode>

Enclosing class:

FilterStep

public static enum FilterStep.Mode
extends Enum<FilterStep.Mode>

Enumeration of filter application modes. The mode determines conditions for accepting the message and passing it to subsequent steps, as well as conditions for modifying the message (formatting, actions, flags, etc).

Enum Constant Summary

Enum Constants

Enum Constant and Description
OFF Skip this step.
ON Only accept messages that satisfy this step.
PASS Accept all messages, modify only those that satisfy this step.
TRY Accept a message if this step is either satisfied or inapplicable, modify only if this step is satisfied.

Method Summary

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

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

ON

public static final FilterStep.Mode ON

Only accept messages that satisfy this step. Messages to which this filter cannot be applied are rejected.

TRY

public static final FilterStep.Mode TRY

Accept a message if this step is either satisfied or inapplicable, modify only if this step is satisfied. For example, if this step is configured to use the embedded object as a target, but the object could not be deserialized since its class definition is not available to this console, the message is accepted and passed to subsequent steps, but any formatting and actions that could be applied by this step are skipped.

PASS

public static final FilterStep.Mode PASS

Accept all messages, modify only those that satisfy this step.

OFF

public static final FilterStep.Mode OFF

Skip this step.

Method Detail

values

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

Returns:

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

valueOf

public static FilterStep.Mode 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

getToolTip

public String getToolTip()

toString

public String toString()

Overrides:

toString in class Enum<FilterStep.Mode>