Module org.refcodes.observer

Package org.refcodes.observer

Class EventMetaDataBuilder

java.lang.Object

org.refcodes.observer.EventMetaData

org.refcodes.observer.EventMetaDataBuilder

All Implemented Interfaces:

org.refcodes.mixin.AliasAccessor, org.refcodes.mixin.AliasAccessor.AliasBuilder<EventMetaDataBuilder>, org.refcodes.mixin.AliasAccessor.AliasMutator, org.refcodes.mixin.AliasAccessor.AliasProperty, org.refcodes.mixin.ChannelAccessor, org.refcodes.mixin.ChannelAccessor.ChannelBuilder<EventMetaDataBuilder>, org.refcodes.mixin.ChannelAccessor.ChannelMutator, org.refcodes.mixin.ChannelAccessor.ChannelProperty, org.refcodes.mixin.GroupAccessor, org.refcodes.mixin.GroupAccessor.GroupBuilder<EventMetaDataBuilder>, org.refcodes.mixin.GroupAccessor.GroupMutator, org.refcodes.mixin.GroupAccessor.GroupProperty, org.refcodes.mixin.UniversalIdAccessor, org.refcodes.mixin.UniversalIdAccessor.UniversalIdBuilder<EventMetaDataBuilder>, org.refcodes.mixin.UniversalIdAccessor.UniversalIdMutator, org.refcodes.mixin.UniversalIdAccessor.UniversalIdProperty

public class EventMetaDataBuilder
extends EventMetaData
implements org.refcodes.mixin.UniversalIdAccessor.UniversalIdProperty, org.refcodes.mixin.UniversalIdAccessor.UniversalIdBuilder<EventMetaDataBuilder>, org.refcodes.mixin.AliasAccessor.AliasProperty, org.refcodes.mixin.AliasAccessor.AliasBuilder<EventMetaDataBuilder>, org.refcodes.mixin.GroupAccessor.GroupProperty, org.refcodes.mixin.GroupAccessor.GroupBuilder<EventMetaDataBuilder>, org.refcodes.mixin.ChannelAccessor.ChannelProperty, org.refcodes.mixin.ChannelAccessor.ChannelBuilder<EventMetaDataBuilder>

The EventMetaDataBuilder is the builder class counterpart of the EventMetaData class.

Nested Class Summary

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

_alias, _channel, _group, _publisherType, _uid

Constructor Summary

Constructors

Constructor	Description
EventMetaDataBuilder()	Constructs the EventMetaData with no properties set except the Universal-TID.
EventMetaDataBuilder(Class<?> aPublisherType)	Constructs the EventMetaData with the given properties.
EventMetaDataBuilder(String aChannel)	Constructs the EventMetaData with the given properties.
EventMetaDataBuilder(String aAlias, String aGroup)	Constructs the EventMetaData with the given properties.
EventMetaDataBuilder(String aAlias, String aGroup, String aChannel)	Constructs the EventMetaData with the given properties.
EventMetaDataBuilder(String aAlias, String aGroup, String aChannel, Class<?> aPublisherType)	Constructs the EventMetaData with the given properties.
EventMetaDataBuilder(String aAlias, String aGroup, String aChannel, String aUid, Class<?> aPublisherType)	Constructs the EventMetaData with the given properties.
EventMetaDataBuilder(EventMetaData aMetaData)	Constructs the EventMetaData with the properties provided by the given EventMetaData instance.

Method Summary

Modifier and Type	Method	Description
String	getAlias()
String	getChannel()
String	getGroup()
Class<?>	getPublisherType()	The least common denominator in event Meta-Data is the type of the publisher which gives a hint on the source of the event.
String	getUniversalId()
void	setAlias(String aAlias)
void	setChannel(String aChannel)
void	setGroup(String aGroup)
void	setPublisherType(Class<?> aPublisherType)	The least common denominator in event Meta-Data is the type of the publisher which gives a hint on the source of the event.
void	setUniversalId(String aUid)
EventMetaDataBuilder	withAlias(String aAlias)
EventMetaDataBuilder	withChannel(String aChannel)
EventMetaDataBuilder	withGroup(String aGroup)
EventMetaDataBuilder	withPublisherType(Class<?> aPublisherType)	The least common denominator in event Meta-Data is the type of the publisher which gives a hint on the source of the event.
EventMetaDataBuilder	withUniversalId(String aUid)

Methods inherited from class org.refcodes.observer.EventMetaData

toString

Methods inherited from class java.lang.Object

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

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

letAlias

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

letChannel

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

letGroup

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

letUniversalId

Constructor Details

EventMetaDataBuilder

public EventMetaDataBuilder()

Constructs the EventMetaData with no properties set except the Universal-TID.

EventMetaDataBuilder

public EventMetaDataBuilder(Class<?> aPublisherType)

Constructs the EventMetaData with the given properties.

Parameters:

aPublisherType - The type of the publisher.

EventMetaDataBuilder

public EventMetaDataBuilder(EventMetaData aMetaData)

Constructs the EventMetaData with the properties provided by the given EventMetaData instance.

Parameters:

aMetaData - The EventMetaData instance from which to get the properties.

EventMetaDataBuilder

public EventMetaDataBuilder(String aChannel)

Constructs the EventMetaData with the given properties.

Parameters:

aChannel - The channel for the EventMetaData.

EventMetaDataBuilder

public EventMetaDataBuilder(String aAlias,
 String aGroup)

Constructs the EventMetaData with the given properties.

Parameters:

aAlias - The alias for the EventMetaData.

aGroup - The group for the EventMetaData.

EventMetaDataBuilder

public EventMetaDataBuilder(String aAlias,
 String aGroup,
 String aChannel)

Constructs the EventMetaData with the given properties.

Parameters:

aAlias - The alias for the EventMetaData.

aGroup - The group for the EventMetaData.

aChannel - The channel for the EventMetaData.

EventMetaDataBuilder

public EventMetaDataBuilder(String aAlias,
 String aGroup,
 String aChannel,
 Class<?> aPublisherType)

Constructs the EventMetaData with the given properties.

Parameters:

aAlias - The alias for the EventMetaData.

aGroup - The group for the EventMetaData.

aChannel - The channel for the EventMetaData.

aPublisherType - The name for the EventMetaData.

EventMetaDataBuilder

public EventMetaDataBuilder(String aAlias,
 String aGroup,
 String aChannel,
 String aUid,
 Class<?> aPublisherType)

Constructs the EventMetaData with the given properties.

Parameters:

aAlias - The alias for the EventMetaData.

aGroup - The group for the EventMetaData.

aChannel - The channel for the EventMetaData.

aUid - The Universal-TID for the EventMetaData.

aPublisherType - The name for the EventMetaData.

Method Details

getAlias

public String getAlias()

Specified by:

getAlias in interface org.refcodes.mixin.AliasAccessor

Overrides:

getAlias in class EventMetaData

getChannel

public String getChannel()

Specified by:

getChannel in interface org.refcodes.mixin.ChannelAccessor

Overrides:

getChannel in class EventMetaData

getGroup

public String getGroup()

Specified by:

getGroup in interface org.refcodes.mixin.GroupAccessor

Overrides:

getGroup in class EventMetaData

getPublisherType

public Class<?> getPublisherType()

The least common denominator in event Meta-Data is the type of the publisher which gives a hint on the source of the event.

Overrides:

getPublisherType in class EventMetaData

Returns:

The type of the publisher who published the event.

getUniversalId

public String getUniversalId()

Specified by:

getUniversalId in interface org.refcodes.mixin.UniversalIdAccessor

Overrides:

getUniversalId in class EventMetaData

setAlias

public void setAlias(String aAlias)

Specified by:

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

setChannel

public void setChannel(String aChannel)

Specified by:

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

setGroup

public void setGroup(String aGroup)

Specified by:

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

setPublisherType

public void setPublisherType(Class<?> aPublisherType)

The least common denominator in event Meta-Data is the type of the publisher which gives a hint on the source of the event.

Parameters:

aPublisherType - The type of the publisher who published the event.

setUniversalId

public void setUniversalId(String aUid)

Specified by:

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

withAlias

public EventMetaDataBuilder withAlias(String aAlias)

Specified by:

withAlias in interface org.refcodes.mixin.AliasAccessor.AliasBuilder<EventMetaDataBuilder>

withChannel

public EventMetaDataBuilder withChannel(String aChannel)

Specified by:

withChannel in interface org.refcodes.mixin.ChannelAccessor.ChannelBuilder<EventMetaDataBuilder>

withGroup

public EventMetaDataBuilder withGroup(String aGroup)

Specified by:

withGroup in interface org.refcodes.mixin.GroupAccessor.GroupBuilder<EventMetaDataBuilder>

withPublisherType

public EventMetaDataBuilder withPublisherType(Class<?> aPublisherType)

The least common denominator in event Meta-Data is the type of the publisher which gives a hint on the source of the event.

Parameters:

aPublisherType - The type of the publisher who published the event.

Returns:

The builder for applying multiple build operations.

withUniversalId

public EventMetaDataBuilder withUniversalId(String aUid)

Specified by:

withUniversalId in interface org.refcodes.mixin.UniversalIdAccessor.UniversalIdBuilder<EventMetaDataBuilder>