Module org.refcodes.observer

Package org.refcodes.observer

Class AbstractMetaDataActionEvent<A,EM extends EventMetaData,SRC>

java.lang.Object

org.refcodes.observer.AbstractEvent<SRC>

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

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

Type Parameters:

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

EM - The type of the EventMetaData

SRC - The type of the source in question.

All Implemented Interfaces:

org.refcodes.mixin.ActionAccessor<A>, org.refcodes.mixin.MetaDataAccessor<EM>, org.refcodes.mixin.SourceAccessor<SRC>, ActionEvent<A,SRC>, Event<SRC>, MetaDataActionEvent<A,EM,SRC>, MetaDataEvent<EM,SRC>

public abstract class AbstractMetaDataActionEvent<A,EM extends EventMetaData,SRC>
extends AbstractActionEvent<A,SRC>
implements MetaDataActionEvent<A,EM,SRC>

The AbstractMetaDataActionEvent provides a base implementation for an MetaDataActionEvent. In order to distinguish AbstractMetaDataActionEvent instances from each other, you may 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 EventMatcherSugar.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.ActionAccessor

org.refcodes.mixin.ActionAccessor.ActionBuilder<A,B extends org.refcodes.mixin.ActionAccessor.ActionBuilder<A,B>>, org.refcodes.mixin.ActionAccessor.ActionMutator<A>, org.refcodes.mixin.ActionAccessor.ActionProperty<A>

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

org.refcodes.mixin.MetaDataAccessor.MetaDataBuilder<MD,B extends org.refcodes.mixin.MetaDataAccessor.MetaDataBuilder<MD,B>>, org.refcodes.mixin.MetaDataAccessor.MetaDataMutator<MD>, org.refcodes.mixin.MetaDataAccessor.MetaDataProperty<MD>

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

org.refcodes.mixin.SourceAccessor.SourceBuilder<SRC,B extends org.refcodes.mixin.SourceAccessor.SourceBuilder<SRC,B>>, org.refcodes.mixin.SourceAccessor.SourceMutator<SRC>, org.refcodes.mixin.SourceAccessor.SourceProperty<SRC>

Field Summary

Fields

Modifier and Type	Field	Description
protected EM	_eventMetaData

Fields inherited from class org.refcodes.observer.AbstractActionEvent

_action

Constructor Summary

Constructors

Constructor	Description
AbstractMetaDataActionEvent(A aAction, EM aEventMetaData, SRC aSource)	Constructs an event with the given Meta-Data.
AbstractMetaDataActionEvent(A aAction, SRC aSource)	Constructs an event with the given Meta-Data.
AbstractMetaDataActionEvent(EM aEventMetaData, SRC aSource)	Constructs an event with the given Meta-Data.
AbstractMetaDataActionEvent(SRC aSource)	Constructs an event with the given Meta-Data.

Method Summary

Modifier and Type	Method	Description
EM	getMetaData()
String	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.SourceAccessor

getSource

Field Details

_eventMetaData

protected EM extends EventMetaData _eventMetaData

Constructor Details

AbstractMetaDataActionEvent

public AbstractMetaDataActionEvent(EM 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.

AbstractMetaDataActionEvent

public AbstractMetaDataActionEvent(A aAction,
 EM aEventMetaData,
 SRC aSource)

Constructs an event with the given Meta-Data.

Parameters:

aAction - The action which the event represents.

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

aSource - The source from which this event originated.

AbstractMetaDataActionEvent

public AbstractMetaDataActionEvent(A aAction,
 SRC aSource)

Constructs an event with the given Meta-Data.

Parameters:

aAction - The action which the event represents.

aSource - The source from which this event originated.

AbstractMetaDataActionEvent

public AbstractMetaDataActionEvent(SRC aSource)

Constructs an event with the given Meta-Data.

Parameters:

aSource - The source from which this event originated.

Method Details

getMetaData

public EM getMetaData()

Specified by:

getMetaData in interface org.refcodes.mixin.MetaDataAccessor<A>

toString

public String toString()

Overrides:

toString in class Object