org.lsst.ccs.gconsole.plugins.tracer

Enum TracerFilter.Target

java.lang.Object

java.lang.Enum<TracerFilter.Target>

org.lsst.ccs.gconsole.plugins.tracer.TracerFilter.Target

All Implemented Interfaces:

Serializable, Comparable<TracerFilter.Target>

Enclosing class:

TracerFilter

public static enum TracerFilter.Target
extends Enum<TracerFilter.Target>

Enumeration of targets to which the filter can be applied.

Enum Constant Summary

Enum Constants

Enum Constant and Description
FLAG The filter is applied to the comma-separated list of flags attached to the message.
MESSAGE The filter is applied to the BusMessage object.
OBJECT The filter is applied to the BusMessage object.
SOURCE The filter is applied to the name of the BusMessage origin.
TEMPLATE The filter definition string is expected to be in Template==Definition format.
TEXT The filter is applied to the string produced by formatters embedded in previously applied filters.

Method Summary

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

MESSAGE

public static final TracerFilter.Target MESSAGE

The filter is applied to the BusMessage object. If the TracerFilter.Method of the filter requires a String as a target, the BusMessage is converted to String by calling its toString() method.

OBJECT

public static final TracerFilter.Target OBJECT

The filter is applied to the BusMessage object. If the TracerFilter.Method of the filter requires a String as a target, the BusMessage is converted to String by calling its toString() method.

SOURCE

public static final TracerFilter.Target SOURCE

The filter is applied to the name of the BusMessage origin.

TEXT

public static final TracerFilter.Target TEXT

The filter is applied to the string produced by formatters embedded in previously applied filters. If none of the previously applied filters formatted the message, the BusMessage is converted to String by calling its toString() method.

FLAG

public static final TracerFilter.Target FLAG

The filter is applied to the comma-separated list of flags attached to the message.

TEMPLATE

public static final TracerFilter.Target TEMPLATE

The filter definition string is expected to be in Template==Definition format. The filter is applied to the string produced by parsing the message with the template. If parsing fails, the filter is not satisfied. The template may include place holders in the ${name} format, where name is a name of the message property, or one of the following:

SOURCE

Name of message origin.

TEXT

String formatted by previous filters.

DATE

Message date in 'yyyy-MM-dd' format.

TIME

Message time in 'HH:mm:ss' format.

DT

Message date and time in 'yyyy-MM-dd HH:mm:ss' format.

LOGGER

The name of the logger.

LEVEL

The level of the log message.

MESSAGE

The formatted message associated with the bus message.

STATE

The subsystem state embedded in the status message.

DESTINATION

The destination of the command message.

Method Detail

values

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

Returns:

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

valueOf

public static TracerFilter.Target 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<TracerFilter.Target>