org.refcodes.observer.impls

Class MetaDataActionEventImpl<A,SRC>

java.lang.Object

org.refcodes.observer.impls.AbstractEvent<SRC>

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

org.refcodes.observer.impls.MetaDataActionEventImpl<A,SRC>

Type Parameters:

A - The type of the action stored in the event.

SRC - The type of the source in question.

All Implemented Interfaces:

MetaDataAccessor<EventMetaData>, SourceAccessor<SRC>, ActionEvent<A,SRC>, Event<SRC>, MetaDataActionEvent<A,SRC>, MetaDataEvent<SRC>

public class MetaDataActionEventImpl<A,SRC>
extends AbstractActionEvent<A,SRC>
implements MetaDataActionEvent<A,SRC>

Ready to use ActionEvent storing a defined set of EventMetaData.

TIPP: In order to distinguish MetaDataActionEventImpl instances from each other, create an actions enumeration, enumerating the various event actions you support. Pass the actual action you intend to notify upon to the according constructor, as an Observer you may use the declarative method EventMatcherByDeclaration.actionEqualWith(Object) to test whether your action was notified (or a simple switch case statement).

Nested Class Summary

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

SourceAccessor.SourceMutator<SRC>, SourceAccessor.SourceProperty<SRC>

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

MetaDataAccessor.MetaDataMutator<MD>, MetaDataAccessor.MetaDataProperty<MD>

Constructor Summary

Constructors

Constructor and Description
MetaDataActionEventImpl(A aAction, SRC aSource) Constructs an event with the given meta Data.
MetaDataActionEventImpl(EventMetaData aEventMetaData, A aAction, SRC aSource) Constructs an event with the given meta Data.
MetaDataActionEventImpl(EventMetaData aEventMetaData, SRC aSource) Constructs an event with the given meta Data.
MetaDataActionEventImpl(SRC aSource) Constructs an event with the given meta Data.
MetaDataActionEventImpl(String channel, SRC aSource) Constructs an event with the given meta Data.

Method Summary

Modifier and Type	Method and Description
EventMetaData	getMetaData()

Methods inherited from class org.refcodes.observer.impls.AbstractActionEvent

getAction

Methods inherited from class org.refcodes.observer.impls.AbstractEvent

getSource

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.refcodes.observer.ActionEvent

getAction

Methods inherited from interface org.refcodes.mixin.SourceAccessor

getSource

Constructor Detail

MetaDataActionEventImpl

public MetaDataActionEventImpl(EventMetaData aEventMetaData,
                               SRC aSource)

Constructs an event with the given meta Data.

Parameters:

aEventMetaData - The meta data to by supplied by the event.

aSource - The source from which this event originated.

MetaDataActionEventImpl

public MetaDataActionEventImpl(String channel,
                               SRC aSource)

Constructs an event with the given meta Data.

Parameters:

channel - The value for ChannelAccessor.getChannel() attribute.

aSource - The source from which this event originated.

MetaDataActionEventImpl

public MetaDataActionEventImpl(EventMetaData aEventMetaData,
                               A aAction,
                               SRC aSource)

Constructs an event with the given meta Data.

Type Parameters:

A - The type of the action stored in the event. CAUTION: The drawback of not using generic generic type declaration on a class level is no granted type safety, the advantage is the ease of use: Sub-classes can be used out of the box.

Parameters:

aEventMetaData - The meta data to by supplied by the event.

aAction - The action which the ActionEvent represents.

aSource - The source from which this event originated.

MetaDataActionEventImpl

public MetaDataActionEventImpl(A aAction,
                               SRC aSource)

Constructs an event with the given meta Data.

Type Parameters:

A - The type of the action stored in the event. CAUTION: The drawback of not using generic generic type declaration on a class level is no granted type safety, the advantage is the ease of use: Sub-classes can be used out of the box.

Parameters:

aEventMetaData - The meta data to by supplied by the event.

aAction - The action which the ActionEvent represents.

aSource - The source from which this event originated.

MetaDataActionEventImpl

public MetaDataActionEventImpl(SRC aSource)

Constructs an event with the given meta Data.

Parameters:

aEventMetaData - The meta data to by supplied by the event.

aSource - The source from which this event originated.

Method Detail

getMetaData

public EventMetaData getMetaData()

Specified by:

getMetaData in interface MetaDataAccessor<EventMetaData>