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

Class PayloadBusEvent<P>

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.PayloadBusEvent<P>
Type Parameters:
P - The type of the payload being carried by this event.
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.MetaDataAccessor<org.refcodes.observer.EventMetaData>, org.refcodes.mixin.PayloadAccessor<P>, org.refcodes.mixin.SourceAccessor<ApplicationBus>, org.refcodes.mixin.TypeAccessor<P>, 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 PayloadBusEvent<P> extends ApplicationBusEvent implements org.refcodes.mixin.PayloadAccessor<P>, org.refcodes.mixin.TypeAccessor<P>
The PayloadBusEvent represents an event indication a payload.

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Class
    Description
    static class 
    PayloadBusEvent.Builder<P>
    Builder to build PayloadBusEvent.

    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.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.PayloadAccessor

    org.refcodes.mixin.PayloadAccessor.PayloadBuilder<P extends Object,B extends org.refcodes.mixin.PayloadAccessor.PayloadBuilder<P,B>>, org.refcodes.mixin.PayloadAccessor.PayloadMutator<P extends Object>, org.refcodes.mixin.PayloadAccessor.PayloadProperty<P 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>

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

    org.refcodes.mixin.TypeAccessor.TypeBuilder<T extends Object,B extends org.refcodes.mixin.TypeAccessor.TypeBuilder<T,B>>, org.refcodes.mixin.TypeAccessor.TypeMutator<T extends Object>, org.refcodes.mixin.TypeAccessor.TypeProperty<T extends Object>

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    protected P
    _payload
     
    protected Class<P>
    _type
     

    Fields inherited from class org.refcodes.observer.AbstractMetaDataActionEvent

    _eventMetaData

    Fields inherited from class org.refcodes.observer.AbstractActionEvent

    _action

  • Constructor Summary

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

  • Method Summary

    Modifier and Type
    Method
    Description
    static <P> PayloadBusEvent.Builder<P>
    builder()
    Creates builder to build ApplicationBusEvent.
    P
    getPayload()
    Class<P>
    getType()

    Methods inherited from class org.refcodes.observer.AbstractMetaDataActionEvent

    getMetaData, toString

    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.PayloadAccessor

    getPayloadOr

    Methods inherited from interface org.refcodes.mixin.SourceAccessor

    getSource

  • Field Details

    • _payload

      protected P _payload

    • _type

      protected Class<P> _type

  • Constructor Details

    • PayloadBusEvent

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

    • PayloadBusEvent

      public PayloadBusEvent(Enum<?> aAction, P aPayload, Class<P> aType, ApplicationBus aSource)
      Constructs an event with the given Meta-Data.
      Parameters:
      aAction - The action which this represents.
      aPayload - The payload to carry.
      aType - The type of the payload.
      aSource - The source from which this event originated.

    • PayloadBusEvent

      public PayloadBusEvent(Enum<?> aAction, P aPayload, Class<P> aType, 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.
      aPayload - The payload to carry.
      aType - The type of the payload.
      aPublisherType - The type of the event publisher.
      aSource - The source from which this event originated.

    • PayloadBusEvent

      public PayloadBusEvent(Enum<?> aAction, P aPayload, Class<P> aType, 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.
      aPayload - The payload to carry.
      aType - The type of the payload.
      aChannel - The channel name on which the event is receivable.
      aSource - The source from which this event originated.

    • PayloadBusEvent

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

    • PayloadBusEvent

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

    • PayloadBusEvent

      public PayloadBusEvent(Enum<?> aAction, P aPayload, 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.
      aPayload - The payload to carry.
      aChannel - The channel name on which the event is receivable.
      aSource - The source from which this event originated.

    • PayloadBusEvent

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

    • PayloadBusEvent

      public PayloadBusEvent(Enum<?> aAction, P aPayload, 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.
      aPayload - The payload 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.

    • PayloadBusEvent

      public PayloadBusEvent(P aPayload, ApplicationBus aSource)
      Constructs an event with the given Meta-Data.
      Parameters:
      aPayload - The payload to carry.
      aSource - The source from which this event originated.

    • PayloadBusEvent

      public PayloadBusEvent(P aPayload, Class<P> aType, ApplicationBus aSource)
      Constructs an event with the given Meta-Data.
      Parameters:
      aPayload - The payload to carry.
      aType - The type of the payload.
      aSource - The source from which this event originated.

    • PayloadBusEvent

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

    • PayloadBusEvent

      public PayloadBusEvent(P aPayload, Class<P> aType, org.refcodes.observer.EventMetaData aEventMetaData, ApplicationBus aSource)
      Constructs an event with the given Meta-Data.
      Parameters:
      aPayload - The payload to carry.
      aType - The type of the payload.
      aEventMetaData - The Meta-Data to by supplied by the event.
      aSource - The source from which this event originated.

    • PayloadBusEvent

      public PayloadBusEvent(P aPayload, Class<P> aType, String aChannel, ApplicationBus aSource)
      Constructs an event with predefined values for the according properties retrieved from the caller's class.
      Parameters:
      aPayload - The payload to carry.
      aType - The type of the payload.
      aChannel - The channel name on which the event is receivable.
      aSource - The source from which this event originated.

    • PayloadBusEvent

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

    • PayloadBusEvent

      public PayloadBusEvent(P aPayload, Class<P> aType, String aAlias, String aGroup, String aChannel, String aUid, Class<?> aPublisherType, ApplicationBus aSource)
      Constructs an event with the given values for the according properties.
      Parameters:
      aPayload - The payload to carry.
      aType - The type of the payload.
      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.

    • PayloadBusEvent

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

    • PayloadBusEvent

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

    • PayloadBusEvent

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

    • PayloadBusEvent

      public PayloadBusEvent(P aPayload, String aAlias, String aGroup, String aChannel, String aUid, Class<?> aPublisherType, ApplicationBus aSource)
      Constructs an event with the given values for the according properties.
      Parameters:
      aPayload - The payload 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.

    • PayloadBusEvent

      public PayloadBusEvent(Enum<?> aAction, P aPayload, Class<P> aType, org.refcodes.observer.EventMetaData aEventMetaData, ApplicationBus aSource)
      Constructs an event with the given values for the according properties.
      Parameters:
      aAction - The action which this represents.
      aPayload - The payload to carry.
      aType - The type of the payload.
      aEventMetaData - The Meta-Data to by supplied by the event.
      aSource - The source from which this event originated.

    • PayloadBusEvent

      public PayloadBusEvent(Enum<?> aAction, P aPayload, Class<P> aType, 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.
      aPayload - The payload to carry.
      aType - The type of the payload.
      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.

  • Method Details

    • getPayload

      public P getPayload()
      Specified by:
      getPayload in interface org.refcodes.mixin.PayloadAccessor<P>

    • getType

      public Class<P> getType()
      Specified by:
      getType in interface org.refcodes.mixin.TypeAccessor<P>

    • builder

      public static <P> PayloadBusEvent.Builder<P> builder()
      Creates builder to build ApplicationBusEvent.
      Type Parameters:
      P - The type of the payload.
      Returns:
      created builder