org.lsst.ccs.gconsole.plugins.tracer.filters

Class StandardFormatter

java.lang.Object

org.lsst.ccs.gconsole.plugins.tracer.filters.StandardFormatter

All Implemented Interfaces:

MessageFilter

public class StandardFormatter
extends Object
implements MessageFilter

Standard formatter for message viewers.

Author:

onoprien

Field Summary

Fields

Modifier and Type	Field and Description
static Color	COLOR_ERROR
static Color	COLOR_FINE
static Color	COLOR_GOOD
static Color	COLOR_WARNING

Constructor Summary

Constructors

Constructor and Description
StandardFormatter(boolean brief, boolean includeSubsystemName)

Method Summary

Modifier and Type	Method and Description
FilteredMessage	apply(FilteredMessage filteredMessage) Applies this filter to the given message.
static Tracer	brief(boolean includeSubsystemName)
static Tracer	defNoName()
static Tracer	defWithName()
static Tracer	longf(boolean includeSubsystemName)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

COLOR_ERROR

public static final Color COLOR_ERROR

COLOR_WARNING

public static final Color COLOR_WARNING

COLOR_GOOD

public static final Color COLOR_GOOD

COLOR_FINE

public static final Color COLOR_FINE

Constructor Detail

StandardFormatter

public StandardFormatter(boolean brief,
                         boolean includeSubsystemName)

Method Detail

apply

public FilteredMessage apply(FilteredMessage filteredMessage)

Description copied from interface: MessageFilter

Applies this filter to the given message.

Specified by:

apply in interface MessageFilter

Parameters:

filteredMessage - The message to be filtered.

Returns:

The (possibly modified) message if it passes the filter; null otherwise.

brief

@Create(category="Tracer",
        name="Brief Format",
        path="Built-In/Formatters/Brief",
        description="Accepts all messages, applies brief version of default formatting.")
public static Tracer brief(@Par(def="false",desc="Include the source subsystem name into the displayed message.")
                                                                                                                                                                                                                       boolean includeSubsystemName)

longf

@Create(category="Tracer",
        name="Long Format",
        path="Built-In/Formatters/Long",
        description="Accepts all messages, applies long version of default formatting.")
public static Tracer longf(@Par(def="false",desc="Include the source subsystem name into the displayed message.")
                                                                                                                                                                                                                    boolean includeSubsystemName)

defWithName

@Create(category="Tracer",
        name="Default Format",
        path="Built-In/Formatters/Default With Subsystem",
        description="Accepts all messages, applies default formatting, includes the source subsystem name.")
public static Tracer defWithName()

defNoName

@Create(category="Tracer",
        name="Default Format",
        path="Built-In/Formatters/Default No Subsystem",
        description="Accepts all messages, applies default formatting, no source subsystem name.")
public static Tracer defNoName()