org.lsst.ccs.gconsole.plugins.tracer

Class TracerMessage

java.lang.Object

org.lsst.ccs.gconsole.plugins.tracer.TracerMessage

All Implemented Interfaces:

FilteredMessage

public class TracerMessage
extends Object
implements FilteredMessage

Default implementation of FilteredMessage.

Author:

onoprien

Nested Class Summary

Nested classes/interfaces inherited from interface org.lsst.ccs.gconsole.plugins.tracer.FilteredMessage

FilteredMessage.Flag

Constructor Summary

Constructors

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

Method Summary

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

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.lsst.ccs.gconsole.plugins.tracer.FilteredMessage

getMessage, getProperty, setMessage, setProperty

Constructor Detail

TracerMessage

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

TracerMessage

public TracerMessage(FilteredMessage filteredMessage)

Method Detail

getBusMessage

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

Description copied from interface: FilteredMessage

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

Specified by:

getBusMessage in interface FilteredMessage

Returns:

The wrapped bus message object.

setBusMessage

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

Description copied from interface: FilteredMessage

Sets the wrapped bus message.

Specified by:

setBusMessage in interface FilteredMessage

Parameters:

busMessage - the bus message object to be wrapped by this filtered message.

Returns:

the bus message object previously wrapped by this filtered message.

getText

public String getText()

Description copied from interface: FilteredMessage

Returns the text message associated with this filtered message.

Specified by:

getText in interface FilteredMessage

Returns:

The text message associated with this filtered message, or null if there is no associated message.

setText

public String setText(String message)

Description copied from interface: FilteredMessage

Associates a text message with this filtered message.

Specified by:

setText in interface FilteredMessage

Parameters:

message - The text message to be associated.

Returns:

The previously associated message, or null if there was no associated message.

getFlags

public EnumSet<FilteredMessage.Flag> getFlags()

Description copied from interface: FilteredMessage

Returns the flags associated with this message.

Specified by:

getFlags in interface FilteredMessage

Returns:

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

addFlag

public void addFlag(FilteredMessage.Flag action,
                    FilteredMessage.Flag... moreActions)

Description copied from interface: FilteredMessage

Associates one or more flags with this message.

Specified by:

addFlag in interface FilteredMessage

Parameters:

action - The first flag.

moreActions - More flags, if any.

clearFlags

public void clearFlags()

Description copied from interface: FilteredMessage

Removes all flags from this message.

Specified by:

clearFlags in interface FilteredMessage

getColor

public Color getColor()

Description copied from interface: FilteredMessage

Returns the color to be used for printing this message.

Specified by:

getColor in interface FilteredMessage

Returns:

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

setColor

public Color setColor(Color color)

Description copied from interface: FilteredMessage

Sets the color to be used for printing this message.

Specified by:

setColor in interface FilteredMessage

Parameters:

color - the color associated with this message.

Returns:

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