org.lsst.ccs.gconsole.plugins.tracer

Class FilteredMessage

java.lang.Object

org.lsst.ccs.gconsole.plugins.tracer.FilteredMessage

public class FilteredMessage
extends Object

A bus message that has been processed by tracer filters. Provides access to the original BusMessage object and to the textual representation, additional flags and properties added by filters.

Author:

onoprien

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	FilteredMessage.Flag Flags that can trigger various actions by the tracer and/or the graphical console.

Constructor Summary

Constructors

Constructor and Description
FilteredMessage(org.lsst.ccs.bus.messages.BusMessage busMessage)
FilteredMessage(FilteredMessage filteredMessage)

Method Summary

Modifier and Type	Method and Description
void	addFlag(FilteredMessage.Flag action) Associates a flags with this message.
void	clearFlags() Removes all flags from this message.
Color	getColor() Returns the color to be used for printing this message.
EnumSet<FilteredMessage.Flag>	getFlags() Returns the flags associated with this message.
org.lsst.ccs.bus.messages.BusMessage	getMessage() Returns the wrapped bus message, usually the original message received over the buses.
String	getText() Returns the textual representation associated with this filtered message.
void	setColor(Color color) Sets the color to be used for printing this message.
void	setText(String text) Associates a textual representation with this filtered message.

Methods inherited from class java.lang.Object

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

Constructor Detail

FilteredMessage

public FilteredMessage(org.lsst.ccs.bus.messages.BusMessage busMessage)

FilteredMessage

public FilteredMessage(FilteredMessage filteredMessage)

Method Detail

getMessage

public org.lsst.ccs.bus.messages.BusMessage getMessage()

Returns the wrapped bus message, usually the original message received over the buses.

Returns:

The wrapped bus message object.

getText

public String getText()

Returns the textual representation associated with this filtered message.

Returns:

String representation of this message.

setText

public void setText(String text)

Associates a textual representation with this filtered message.

Parameters:

text - New string representation for this message.

getFlags

public EnumSet<FilteredMessage.Flag> getFlags()

Returns the flags associated with this message.

Returns:

Set of flags associated with this message, or null if there are no flags.

addFlag

public void addFlag(FilteredMessage.Flag action)

Associates a flags with this message.

Parameters:

action - The flag.

clearFlags

public void clearFlags()

Removes all flags from this message.

getColor

public Color getColor()

Returns the color to be used for printing this message.

Returns:

the color associated with this message, or null if there is no associated color.

setColor

public void setColor(Color color)

Sets the color to be used for printing this message.

Parameters:

color - Color for this message.