Module org.refcodes.eventbus

Package org.refcodes.eventbus

Class SimpleBusEventBuilder

java.lang.Object

org.refcodes.observer.AbstractEvent<SRC>

org.refcodes.observer.AbstractActionEvent<A,SRC>

org.refcodes.observer.AbstractMetaDataActionEvent<A,EM,SRC>

org.refcodes.observer.AbstractMetaDataActionEvent.AbstractActionMetaDataEventBuilder<Enum<?>,org.refcodes.mixin.EventMetaData,SimpleEventBus,SimpleBusEventBuilder>

org.refcodes.eventbus.SimpleBusEventBuilder

All Implemented Interfaces:

BusEvent<Enum<?>,org.refcodes.mixin.EventMetaData,SimpleEventBus>, BusEvent.GenericBusEventBuilder<Enum<?>,org.refcodes.mixin.EventMetaData,SimpleEventBus,SimpleBusEventBuilder>, org.refcodes.mixin.ActionAccessor<Enum<?>>, org.refcodes.mixin.ActionAccessor.ActionBuilder<Enum<?>,org.refcodes.mixin.EventMetaData>, org.refcodes.mixin.ActionAccessor.ActionMutator<Enum<?>>, org.refcodes.mixin.ActionAccessor.ActionProperty<Enum<?>>, org.refcodes.mixin.AliasAccessor, org.refcodes.mixin.AliasAccessor.AliasBuilder<Enum<?>>, org.refcodes.mixin.AliasAccessor.AliasMutator, org.refcodes.mixin.AliasAccessor.AliasProperty, org.refcodes.mixin.ChannelAccessor, org.refcodes.mixin.ChannelAccessor.ChannelBuilder<Enum<?>>, org.refcodes.mixin.ChannelAccessor.ChannelMutator, org.refcodes.mixin.ChannelAccessor.ChannelProperty, org.refcodes.mixin.EventMetaData, org.refcodes.mixin.EventMetaData.EventMetaDataBuilder, org.refcodes.mixin.GroupAccessor, org.refcodes.mixin.GroupAccessor.GroupBuilder<Enum<?>>, org.refcodes.mixin.GroupAccessor.GroupMutator, org.refcodes.mixin.GroupAccessor.GroupProperty, org.refcodes.mixin.MetaDataAccessor<Enum<?>>, org.refcodes.mixin.MetaDataAccessor.MetaDataBuilder<Enum<?>,org.refcodes.mixin.EventMetaData>, org.refcodes.mixin.MetaDataAccessor.MetaDataMutator<Enum<?>>, org.refcodes.mixin.MetaDataAccessor.MetaDataProperty<Enum<?>>, org.refcodes.mixin.SourceAccessor<Enum<?>>, org.refcodes.mixin.UniversalIdAccessor, org.refcodes.mixin.UniversalIdAccessor.UniversalIdBuilder<Enum<?>>, org.refcodes.mixin.UniversalIdAccessor.UniversalIdMutator, org.refcodes.mixin.UniversalIdAccessor.UniversalIdProperty, org.refcodes.observer.GenericActionEvent<Enum<?>,org.refcodes.mixin.EventMetaData>, org.refcodes.observer.GenericActionMetaDataEvent<Enum<?>,org.refcodes.mixin.EventMetaData,SimpleEventBus>, org.refcodes.observer.GenericActionMetaDataEvent.GenericActionMetaDataEventBuilder<Enum<?>,org.refcodes.mixin.EventMetaData,SimpleEventBus,SimpleBusEventBuilder>, org.refcodes.observer.GenericEvent<Enum<?>>, org.refcodes.observer.GenericMetaDataEvent<Enum<?>,org.refcodes.mixin.EventMetaData>

public class SimpleBusEventBuilder
extends org.refcodes.observer.AbstractMetaDataActionEvent.AbstractActionMetaDataEventBuilder<Enum<?>,org.refcodes.mixin.EventMetaData,SimpleEventBus,SimpleBusEventBuilder>
implements BusEvent<Enum<?>,org.refcodes.mixin.EventMetaData,SimpleEventBus>, BusEvent.GenericBusEventBuilder<Enum<?>,org.refcodes.mixin.EventMetaData,SimpleEventBus,SimpleBusEventBuilder>

Intuitive Meta-Class for the MetaDataActionEventBuilderImpl as used by the SimpleEventBus.

Nested Class Summary

Nested classes/interfaces inherited from class org.refcodes.observer.AbstractMetaDataActionEvent

org.refcodes.observer.AbstractMetaDataActionEvent.AbstractActionMetaDataEventBuilder<A extends Object,EM extends org.refcodes.mixin.EventMetaData,SRC extends Object,B extends org.refcodes.observer.GenericActionMetaDataEvent.GenericActionMetaDataEventBuilder<A,EM,SRC,B>>

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

org.refcodes.mixin.AliasAccessor.AliasBuilder<B extends org.refcodes.mixin.AliasAccessor.AliasBuilder<B>>, org.refcodes.mixin.AliasAccessor.AliasMutator, org.refcodes.mixin.AliasAccessor.AliasProperty

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

BusEvent.GenericBusEventBuilder<A,META extends org.refcodes.mixin.EventMetaData,SRC extends EventBus<?,?,?,?,?>,B extends BusEvent.GenericBusEventBuilder<A,META,SRC,B>>

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

org.refcodes.mixin.ChannelAccessor.ChannelBuilder<B extends org.refcodes.mixin.ChannelAccessor.ChannelBuilder<B>>, org.refcodes.mixin.ChannelAccessor.ChannelMutator, org.refcodes.mixin.ChannelAccessor.ChannelProperty

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

org.refcodes.mixin.EventMetaData.EventMetaDataBuilder

Nested classes/interfaces inherited from interface org.refcodes.observer.GenericActionMetaDataEvent

org.refcodes.observer.GenericActionMetaDataEvent.GenericActionMetaDataEventBuilder<A extends Object,EM extends org.refcodes.mixin.EventMetaData,SRC extends Object,B extends org.refcodes.observer.GenericActionMetaDataEvent.GenericActionMetaDataEventBuilder<A,EM,SRC,B>>

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

org.refcodes.mixin.GroupAccessor.GroupBuilder<B extends org.refcodes.mixin.GroupAccessor.GroupBuilder<B>>, org.refcodes.mixin.GroupAccessor.GroupMutator, org.refcodes.mixin.GroupAccessor.GroupProperty

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

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

org.refcodes.mixin.UniversalIdAccessor.UniversalIdBuilder<B extends org.refcodes.mixin.UniversalIdAccessor.UniversalIdBuilder<B>>, org.refcodes.mixin.UniversalIdAccessor.UniversalIdMutator, org.refcodes.mixin.UniversalIdAccessor.UniversalIdProperty

Field Summary

Fields inherited from class org.refcodes.observer.AbstractActionEvent

_action

Fields inherited from class org.refcodes.observer.AbstractMetaDataActionEvent

_eventMetaData

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
org.refcodes.mixin.EventMetaData.EventMetaDataBuilder	getMetaData()
void	setAlias(String aAlias)
void	setChannel(String aChannel)
void	setGroup(String aGroup)
void	setMetaData(org.refcodes.mixin.EventMetaData aMetaData)
void	setPublisherType(Class<?> aPublisherType)
void	setUniversalId(String aUid)

Methods inherited from class org.refcodes.observer.AbstractActionEvent

getAction

Methods inherited from class org.refcodes.observer.AbstractEvent

getSource

Methods inherited from class org.refcodes.observer.AbstractMetaDataActionEvent

toString

Methods inherited from class org.refcodes.observer.AbstractMetaDataActionEvent.AbstractActionMetaDataEventBuilder

getAlias, getChannel, getGroup, getPublisherType, getUniversalId, setAction

Methods inherited from interface org.refcodes.mixin.ActionAccessor.ActionMutator

setAction

Methods inherited from interface org.refcodes.mixin.ActionAccessor.ActionProperty

letAction

Methods inherited from interface org.refcodes.mixin.AliasAccessor

getAlias

Methods inherited from interface org.refcodes.mixin.AliasAccessor.AliasProperty

letAlias

Methods inherited from interface org.refcodes.mixin.ChannelAccessor

getChannel

Methods inherited from interface org.refcodes.mixin.ChannelAccessor.ChannelProperty

letChannel

Methods inherited from interface org.refcodes.mixin.EventMetaData

getPublisherType

Methods inherited from interface org.refcodes.observer.GenericActionMetaDataEvent.GenericActionMetaDataEventBuilder

withAction, withAlias, withChannel, withGroup, withMetaData, withPublisherType, withUniversalId

Methods inherited from interface org.refcodes.mixin.GroupAccessor

getGroup

Methods inherited from interface org.refcodes.mixin.GroupAccessor.GroupProperty

letGroup

Methods inherited from interface org.refcodes.mixin.MetaDataAccessor.MetaDataProperty

letMetaData

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.refcodes.mixin.SourceAccessor

getSource

Methods inherited from interface org.refcodes.mixin.UniversalIdAccessor

getUniversalId

Methods inherited from interface org.refcodes.mixin.UniversalIdAccessor.UniversalIdProperty

letUniversalId

Constructor Detail

SimpleBusEventBuilder

public SimpleBusEventBuilder(Enum<?> aAction,
                             org.refcodes.mixin.EventMetaData aEventMetaData,
                             SimpleEventBus aSource)

Constructs an event with the given Meta-Data.

Parameters:

aAction - The action which this represents.

aEventMetaData - The Meta-Data to be supplied by the event.

aSource - The source from which this event originated.

SimpleBusEventBuilder

public SimpleBusEventBuilder(Enum<?> aAction,
                             SimpleEventBus aSource)

Constructs an event with the given Meta-Data.

Parameters:

aAction - The action which this represents.

aSource - The source from which this event originated.

SimpleBusEventBuilder

public SimpleBusEventBuilder(org.refcodes.mixin.EventMetaData aEventMetaData,
                             SimpleEventBus aSource)

Constructs an event with the given Meta-Data.

Parameters:

aEventMetaData - The Meta-Data to be supplied by the event.

aSource - The source from which this event originated.

SimpleBusEventBuilder

public SimpleBusEventBuilder(SimpleEventBus aSource)

Constructs an event with the given Meta-Data.

Parameters:

aSource - The source from which this event originated.

SimpleBusEventBuilder

public SimpleBusEventBuilder(Enum<?> aAction,
                             Class<?> aPublisherType,
                             SimpleEventBus aSource)

Constructs an event with predefined values for the according properties retrieved from the caller's class.

Parameters:

aAction - The action which this represents.

aPublisherType - The type of the event publisher.

aSource - The source from which this event originated.

SimpleBusEventBuilder

public SimpleBusEventBuilder(Enum<?> aAction,
                             String aChannel,
                             SimpleEventBus aSource)

Constructs an event with predefined values for the according properties retrieved from the caller's class.

Parameters:

aAction - The action which this represents.

aChannel - The channel name on which the event is receivable.

aSource - The source from which this event originated.

SimpleBusEventBuilder

public SimpleBusEventBuilder(Enum<?> aAction,
                             String aAlias,
                             String aGroup,
                             String aChannel,
                             String aUid,
                             Class<?> aPublisherType,
                             SimpleEventBus aSource)

Constructs an event with the given values for the according properties.

Parameters:

aAction - The action which this represents.

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.

SimpleBusEventBuilder

public SimpleBusEventBuilder(Class<?> aPublisherType,
                             SimpleEventBus aSource)

Constructs an event with predefined values for the according properties retrieved from the caller's class.

Parameters:

aPublisherType - The type of the event publisher.

aSource - The source from which this event originated.

SimpleBusEventBuilder

public SimpleBusEventBuilder(String aChannel,
                             SimpleEventBus aSource)

Constructs an event with predefined values for the according properties retrieved from the caller's class.

Parameters:

aChannel - The channel name on which the event is receivable.

aSource - The source from which this event originated.

SimpleBusEventBuilder

public SimpleBusEventBuilder(String aAlias,
                             String aGroup,
                             String aChannel,
                             String aUid,
                             Class<?> aPublisherType,
                             SimpleEventBus aSource)

Constructs an event with the given values for the according properties.

Parameters:

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 Detail

setPublisherType

public void setPublisherType(Class<?> aPublisherType)

Specified by:

setPublisherType in interface org.refcodes.mixin.EventMetaData.EventMetaDataBuilder

setUniversalId

public void setUniversalId(String aUid)

Specified by:

setUniversalId in interface org.refcodes.mixin.UniversalIdAccessor.UniversalIdMutator

setAlias

public void setAlias(String aAlias)

Specified by:

setAlias in interface org.refcodes.mixin.AliasAccessor.AliasMutator

setGroup

public void setGroup(String aGroup)

Specified by:

setGroup in interface org.refcodes.mixin.GroupAccessor.GroupMutator

setChannel

public void setChannel(String aChannel)

Specified by:

setChannel in interface org.refcodes.mixin.ChannelAccessor.ChannelMutator

setMetaData

public void setMetaData(org.refcodes.mixin.EventMetaData aMetaData)

Specified by:

setMetaData in interface org.refcodes.mixin.MetaDataAccessor.MetaDataMutator<Enum<?>>

getMetaData

public org.refcodes.mixin.EventMetaData.EventMetaDataBuilder getMetaData()

Specified by:

getMetaData in interface org.refcodes.mixin.MetaDataAccessor<Enum<?>>

Overrides:

getMetaData in class org.refcodes.observer.AbstractMetaDataActionEvent.AbstractActionMetaDataEventBuilder<Enum<?>,org.refcodes.mixin.EventMetaData,SimpleEventBus,SimpleBusEventBuilder>