Class EventMetaData

java.lang.Object

org.refcodes.observer.EventMetaData

All Implemented Interfaces:

AliasAccessor, ChannelAccessor, GroupAccessor, UniversalIdAccessor, PublisherTypeAccessor

public class EventMetaData
extends Object
implements UniversalIdAccessor, AliasAccessor, GroupAccessor, ChannelAccessor, PublisherTypeAccessor

The Meta-Data describes the event which a publisher posts via the event bus to an event subscriber's event listener. The Meta-Data is the criteria most commonly used by an event matcher in order to identify an loosely coupled event.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	EventMetaData.Builder	Builder to build EventMetaData.

Nested classes/interfaces inherited from interface AliasAccessor

AliasAccessor.AliasBuilder<B>, AliasAccessor.AliasMutator, AliasAccessor.AliasProperty

Nested classes/interfaces inherited from interface ChannelAccessor

ChannelAccessor.ChannelBuilder<B>, ChannelAccessor.ChannelMutator, ChannelAccessor.ChannelProperty

Nested classes/interfaces inherited from interface GroupAccessor

GroupAccessor.GroupBuilder<B>, GroupAccessor.GroupMutator, GroupAccessor.GroupProperty

Nested classes/interfaces inherited from interface PublisherTypeAccessor

PublisherTypeAccessor.PublisherTypeBuilder<B>, PublisherTypeAccessor.PublisherTypeMutator, PublisherTypeAccessor.PublisherTypeProperty

Nested classes/interfaces inherited from interface UniversalIdAccessor

UniversalIdAccessor.UniversalIdBuilder<B>, UniversalIdAccessor.UniversalIdMutator, UniversalIdAccessor.UniversalIdProperty

Field Summary

Fields

Modifier and Type	Field	Description
protected String	_alias
protected String	_channel
protected String	_group
protected Class<?>	_publisherType
protected String	_uid

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
static EventMetaData.Builder	builder()	Creates builder to build EventMetaData.
String	getAlias()
String	getChannel()
String	getGroup()
Class<?>	getPublisherType()	Retrieves the publisher's type property.
String	getUniversalId()
String	toString()

Methods inherited from class Object

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

Field Details

_alias

protected String _alias

_channel

protected String _channel

_group

protected String _group

_uid

protected String _uid

_publisherType

protected Class<?> _publisherType

Constructor Details

EventMetaData

public EventMetaData()

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

EventMetaData

public EventMetaData(Class<?> aPublisherType)

Constructs the EventMetaData with the given properties.

Parameters:

aPublisherType - The type of the publisher.

EventMetaData

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

EventMetaData

public EventMetaData(String aChannel)

Constructs the EventMetaData with the given properties.

Parameters:

aChannel - The channel for the EventMetaData.

EventMetaData

public EventMetaData(String aChannel,
 Class<?> aPublisherType)

Constructs the EventMetaData with the given properties.

Parameters:

aChannel - The channel for the EventMetaData.

aPublisherType - The publisher type for the EventMetaData.

EventMetaData

public EventMetaData(String aAlias,
 String aGroup)

Constructs the EventMetaData with the given properties.

Parameters:

aAlias - The alias for the EventMetaData.

aGroup - The group for the EventMetaData.

EventMetaData

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

EventMetaData

public EventMetaData(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 publisher type for the EventMetaData.

EventMetaData

public EventMetaData(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 publisher type for the EventMetaData.

Method Details

getAlias

public String getAlias()

Specified by:

getAlias in interface AliasAccessor

getChannel

public String getChannel()

Specified by:

getChannel in interface ChannelAccessor

getGroup

public String getGroup()

Specified by:

getGroup in interface GroupAccessor

getPublisherType

public Class<?> getPublisherType()

Retrieves the publisher's type property.

Specified by:

getPublisherType in interface PublisherTypeAccessor

Returns:

The publisher's type stored by the property.

getUniversalId

public String getUniversalId()

Specified by:

getUniversalId in interface UniversalIdAccessor

toString

public String toString()

Overrides:

toString in class Object

builder

public static EventMetaData.Builder builder()

Creates builder to build EventMetaData.

Returns:

created builder