Module org.refcodes.eventbus.ext.application
Package org.refcodes.eventbus.ext.application

Class MessageBusEvent

java.lang.Object
org.refcodes.observer.AbstractEvent<SRC>
org.refcodes.observer.AbstractActionEvent<A,SRC>
org.refcodes.observer.AbstractMetaDataActionEvent<Enum<?>,org.refcodes.observer.EventMetaData,ApplicationBus>
org.refcodes.eventbus.ext.application.ApplicationBusEvent
org.refcodes.eventbus.ext.application.MessageBusEvent
All Implemented Interfaces:
org.refcodes.eventbus.EventBrokerEvent<ApplicationBus>, org.refcodes.eventbus.EventDispatcherEvent<Enum<?>,org.refcodes.observer.EventMetaData,ApplicationBus>, org.refcodes.mixin.ActionAccessor<Enum<?>>, org.refcodes.mixin.MessageAccessor, org.refcodes.mixin.MetaDataAccessor<org.refcodes.observer.EventMetaData>, org.refcodes.mixin.SourceAccessor<ApplicationBus>, org.refcodes.observer.ActionEvent<Enum<?>,ApplicationBus>, org.refcodes.observer.Event<ApplicationBus>, org.refcodes.observer.MetaDataActionEvent<Enum<?>,org.refcodes.observer.EventMetaData,ApplicationBus>, org.refcodes.observer.MetaDataEvent<org.refcodes.observer.EventMetaData,ApplicationBus>
public class MessageBusEvent extends ApplicationBusEvent implements org.refcodes.mixin.MessageAccessor
The MessageBusEvent represents an event indication a message.

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Class
    Description
    static final class 
    MessageBusEvent.Builder
    Builder to build MessageBusEvent.

    Nested classes/interfaces inherited from interface org.refcodes.mixin.ActionAccessor

    org.refcodes.mixin.ActionAccessor.ActionBuilder<A extends Object,B extends org.refcodes.mixin.ActionAccessor.ActionBuilder<A,B>>, org.refcodes.mixin.ActionAccessor.ActionMutator<A extends Object>, org.refcodes.mixin.ActionAccessor.ActionProperty<A extends Object>

    Nested classes/interfaces inherited from interface org.refcodes.eventbus.EventDispatcherEvent

    org.refcodes.eventbus.EventDispatcherEvent.EventDispatcherEventBuilder<A extends Object,META extends org.refcodes.observer.EventMetaData,SRC extends org.refcodes.eventbus.EventDispatcher<?,?,?,?,?>,B extends org.refcodes.eventbus.EventDispatcherEvent.EventDispatcherEventBuilder<A,META,SRC,B>>

    Nested classes/interfaces inherited from interface org.refcodes.mixin.MessageAccessor

    org.refcodes.mixin.MessageAccessor.MessageBuilder<B extends org.refcodes.mixin.MessageAccessor.MessageBuilder<B>>, org.refcodes.mixin.MessageAccessor.MessageMutator, org.refcodes.mixin.MessageAccessor.MessageProperty

    Nested classes/interfaces inherited from interface org.refcodes.mixin.MetaDataAccessor

    org.refcodes.mixin.MetaDataAccessor.MetaDataBuilder<MD extends Object,B extends org.refcodes.mixin.MetaDataAccessor.MetaDataBuilder<MD,B>>, org.refcodes.mixin.MetaDataAccessor.MetaDataMutator<MD extends Object>, org.refcodes.mixin.MetaDataAccessor.MetaDataProperty<MD extends Object>

    Nested classes/interfaces inherited from interface org.refcodes.mixin.SourceAccessor

    org.refcodes.mixin.SourceAccessor.SourceBuilder<SRC extends Object,B extends org.refcodes.mixin.SourceAccessor.SourceBuilder<SRC,B>>, org.refcodes.mixin.SourceAccessor.SourceMutator<SRC extends Object>, org.refcodes.mixin.SourceAccessor.SourceProperty<SRC extends Object>

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    protected String
    _message
     

    Fields inherited from class org.refcodes.observer.AbstractMetaDataActionEvent

    _eventMetaData

    Fields inherited from class org.refcodes.observer.AbstractActionEvent

    _action

  • Constructor Summary

    Constructors
    Constructor
    Description
    MessageBusEvent(Enum<?> aAction, String aMessage, Class<?> aPublisherType, ApplicationBus aSource)
    Constructs an event with predefined values for the according properties retrieved from the caller's class.
    MessageBusEvent(Enum<?> aAction, String aMessage, String aChannel, Class<?> aPublisherType, ApplicationBus aSource)
    Constructs an event with the given values for the according properties.
    MessageBusEvent(Enum<?> aAction, String aMessage, String aAlias, String aGroup, String aChannel, String aUid, Class<?> aPublisherType, ApplicationBus aSource)
    Constructs an event with the given values for the according properties.
    MessageBusEvent(Enum<?> aAction, String aMessage, String aChannel, ApplicationBus aSource)
    Constructs an event with predefined values for the according properties retrieved from the caller's class.
    MessageBusEvent(Enum<?> aAction, String aMessage, ApplicationBus aSource)
    Constructs an event with the given Meta-Data.
    MessageBusEvent(Enum<?> aAction, String aMessage, org.refcodes.observer.EventMetaData aEventMetaData, ApplicationBus aSource)
    Constructs an event with the given Meta-Data.
    MessageBusEvent(String aMessage, Class<?> aPublisherType, ApplicationBus aSource)
    Constructs an event with predefined values for the according properties retrieved from the caller's class.
    MessageBusEvent(String aMessage, String aChannel, Class<?> aPublisherType, ApplicationBus aSource)
    Constructs an event with the given values for the according properties.
    MessageBusEvent(String aMessage, String aAlias, String aGroup, String aChannel, String aUid, Class<?> aPublisherType, ApplicationBus aSource)
    Constructs an event with the given values for the according properties.
    MessageBusEvent(String aMessage, String aChannel, ApplicationBus aSource)
    Constructs an event with predefined values for the according properties retrieved from the caller's class.
    MessageBusEvent(String aMessage, ApplicationBus aSource)
    Constructs an event with the given Meta-Data.
    MessageBusEvent(String aMessage, org.refcodes.observer.EventMetaData aEventMetaData, ApplicationBus aSource)
    Constructs an event with the given Meta-Data.

  • Method Summary

    Modifier and Type
    Method
    Description
    String
    getMessage()
    String
    toString()

    Methods inherited from class org.refcodes.eventbus.ext.application.ApplicationBusEvent

    builder

    Methods inherited from class org.refcodes.observer.AbstractMetaDataActionEvent

    getMetaData

    Methods inherited from class org.refcodes.observer.AbstractActionEvent

    getAction

    Methods inherited from class org.refcodes.observer.AbstractEvent

    getSource

    Methods inherited from class java.lang.Object

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

    Methods inherited from interface org.refcodes.mixin.ActionAccessor

    getAction

    Methods inherited from interface org.refcodes.mixin.MetaDataAccessor

    getMetaData

    Methods inherited from interface org.refcodes.mixin.SourceAccessor

    getSource

  • Field Details

    • _message

      protected String _message

  • Constructor Details

    • MessageBusEvent

      public MessageBusEvent(String aMessage, Class<?> aPublisherType, ApplicationBus aSource)
      Constructs an event with predefined values for the according properties retrieved from the caller's class.
      Parameters:
      aMessage - The message to carry.
      aPublisherType - The type of the event publisher.
      aSource - The source from which this event originated.

    • MessageBusEvent

      public MessageBusEvent(Enum<?> aAction, String aMessage, Class<?> aPublisherType, ApplicationBus aSource)
      Constructs an event with predefined values for the according properties retrieved from the caller's class.
      Parameters:
      aAction - The action which this represents.
      aMessage - The message to carry.
      aPublisherType - The type of the event publisher.
      aSource - The source from which this event originated.

    • MessageBusEvent

      public MessageBusEvent(Enum<?> aAction, String aMessage, org.refcodes.observer.EventMetaData aEventMetaData, ApplicationBus aSource)
      Constructs an event with the given Meta-Data.
      Parameters:
      aAction - The action which this represents.
      aMessage - The message to carry.
      aEventMetaData - The Meta-Data to by supplied by the event.
      aSource - The source from which this event originated.

    • MessageBusEvent

      public MessageBusEvent(Enum<?> aAction, String aMessage, ApplicationBus aSource)
      Constructs an event with the given Meta-Data.
      Parameters:
      aAction - The action which this represents.
      aMessage - The message to carry.
      aSource - The source from which this event originated.

    • MessageBusEvent

      public MessageBusEvent(Enum<?> aAction, String aMessage, String aChannel, ApplicationBus aSource)
      Constructs an event with predefined values for the according properties retrieved from the caller's class.
      Parameters:
      aAction - The action which this represents.
      aMessage - The message to carry.
      aChannel - The channel name on which the event is receivable.
      aSource - The source from which this event originated.

    • MessageBusEvent

      public MessageBusEvent(Enum<?> aAction, String aMessage, String aAlias, String aGroup, String aChannel, String aUid, Class<?> aPublisherType, ApplicationBus aSource)
      Constructs an event with the given values for the according properties.
      Parameters:
      aAction - The action which this represents.
      aMessage - The message to carry.
      aAlias - The alias property.
      aGroup - The group property.
      aChannel - The channel property.
      aUid - The UID (Universal-TID) property.
      aPublisherType - The type of the event publisher.
      aSource - The source from which this event originated.

    • MessageBusEvent

      public MessageBusEvent(String aMessage, org.refcodes.observer.EventMetaData aEventMetaData, ApplicationBus aSource)
      Constructs an event with the given Meta-Data.
      Parameters:
      aMessage - The message to carry.
      aEventMetaData - The Meta-Data to by supplied by the event.
      aSource - The source from which this event originated.

    • MessageBusEvent

      public MessageBusEvent(String aMessage, ApplicationBus aSource)
      Constructs an event with the given Meta-Data.
      Parameters:
      aMessage - The message to carry.
      aSource - The source from which this event originated.

    • MessageBusEvent

      public MessageBusEvent(String aMessage, String aChannel, ApplicationBus aSource)
      Constructs an event with predefined values for the according properties retrieved from the caller's class.
      Parameters:
      aMessage - The message to carry.
      aChannel - The channel name on which the event is receivable.
      aSource - The source from which this event originated.

    • MessageBusEvent

      public MessageBusEvent(String aMessage, String aAlias, String aGroup, String aChannel, String aUid, Class<?> aPublisherType, ApplicationBus aSource)
      Constructs an event with the given values for the according properties.
      Parameters:
      aMessage - The message to carry.
      aAlias - The alias property.
      aGroup - The group property.
      aChannel - The channel property.
      aUid - The UID (Universal-TID) property.
      aPublisherType - The type of the event publisher.
      aSource - The source from which this event originated.

    • MessageBusEvent

      public MessageBusEvent(String aMessage, String aChannel, Class<?> aPublisherType, ApplicationBus aSource)
      Constructs an event with the given values for the according properties.
      Parameters:
      aMessage - The message to carry.
      aChannel - The channel for the EventMetaData.
      aPublisherType - The publisher type for the EventMetaData.
      aSource - The according source (origin).

    • MessageBusEvent

      public MessageBusEvent(Enum<?> aAction, String aMessage, String aChannel, Class<?> aPublisherType, ApplicationBus aSource)
      Constructs an event with the given values for the according properties.
      Parameters:
      aAction - The action which this represents.
      aMessage - The message to carry.
      aChannel - The channel property.
      aPublisherType - The type of the event publisher.
      aSource - The source from which this event originated.

  • Method Details

    • getMessage

      public String getMessage()
      Specified by:
      getMessage in interface org.refcodes.mixin.MessageAccessor

    • toString

      public String toString()
      Overrides:
      toString in class org.refcodes.observer.AbstractMetaDataActionEvent<Enum<?>,org.refcodes.observer.EventMetaData,ApplicationBus>