Class MessageFilter

java.lang.Object
org.bzdev.drama.common.MessageFilter
Direct Known Subclasses:
CompoundMessageFilter

public class MessageFilter extends Object
Provides the ability to modify messages and indicate if they should be dropped. Message filters are used by the drama-simulation implementation to allow users of the drama packages to indicate how messages should be modified or when they should be dropped during message transmission. Groups and domains make use of message filters when these are provided.
  • Field Details

    • DELETED

      public static final Object DELETED
      Constant indicating that a message has been dropped.
  • Constructor Details

    • MessageFilter

      public MessageFilter()
  • Method Details

    • filterMessage

      public Object filterMessage(Object msg)
      Filter a message.
      Parameters:
      msg - the original message
      Returns:
      a modified message; MessageFilter.DELETED if the message should be dropped