org.lsst.ccs.gconsole.plugins.tracer

Interface FilteredMessage

All Known Implementing Classes:

TracerMessage

public interface FilteredMessage

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

Author:

onoprien

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method and Description
default void	addFlag(FilteredMessage.Flag action, FilteredMessage.Flag... actions) Associates one or more flags with this message.
default 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.
default Color	getColor() Returns the color to be used for printing this message.
default EnumSet<FilteredMessage.Flag>	getFlags() Returns the flags associated with this message.
default String	getMessage() Deprecated. Use getText() instead.
default Object	getProperty(String key) Returns the property of this message identified by the specified key.
default 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.
default Color	setColor(Color color) Sets the color to be used for printing this message.
default String	setMessage(String message) Deprecated. Use setText(...) instead.
default Object	setProperty(String key, Object value) Sets the property of this message identified by the specified key.
default String	setText(String message) Associates a text message with this filtered message.

Method Detail

getBusMessage

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

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

Returns:

The wrapped bus message object.

setBusMessage

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

Sets the wrapped bus message.

Parameters:

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

Returns:

the bus message object previously wrapped by this filtered message.

getMessage

@Deprecated
default String getMessage()

Deprecated. Use getText() instead.

Returns the text message associated with this filtered message.

Returns:

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

setMessage

@Deprecated
default String setMessage(String message)

Deprecated. Use setText(...) instead.

Associates a text message with this filtered message.

Parameters:

message - The text message to be associated.

Returns:

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

getText

default String getText()

Returns the text message associated with this filtered message.

Returns:

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

setText

default String setText(String message)

Associates a text message with this filtered message.

Parameters:

message - The text message to be associated.

Returns:

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

getFlags

default 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

default void addFlag(FilteredMessage.Flag action,
                     FilteredMessage.Flag... actions)

Associates one or more flags with this message.

Parameters:

action - The first flag.

actions - More flags, if any.

clearFlags

default void clearFlags()

Removes all flags from this message.

getColor

default 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

default Color setColor(Color color)

Sets the color to be used for printing this message.

Parameters:

color - the color associated with this message.

Returns:

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

getProperty

default Object getProperty(String key)

Returns the property of this message identified by the specified key.

Parameters:

key - The key.

Returns:

The property identified by the specified key, or null if there is no such property.

setProperty

default Object setProperty(String key,
                           Object value)

Sets the property of this message identified by the specified key.

Parameters:

key - The key.

value - The value to be set.

Returns:

The previous value, or null if there was no such property.