Module org.refcodes.observer
Package org.refcodes.observer

Class AbstractMetaDataEvent<EM extends org.refcodes.mixin.EventMetaData,SRC>

java.lang.Object
org.refcodes.observer.AbstractEvent<SRC>
org.refcodes.observer.AbstractMetaDataEvent<EM,SRC>
Type Parameters:
EM - The type of the EventMetaData
SRC - The type of the source in question.
All Implemented Interfaces:
org.refcodes.mixin.MetaDataAccessor<EM>, org.refcodes.mixin.SourceAccessor<SRC>, GenericEvent<SRC>, GenericMetaDataEvent<EM,SRC>
Direct Known Subclasses:
AbstractPayloadMetaDataEvent, MetaDataEventImpl
public abstract class AbstractMetaDataEvent<EM extends org.refcodes.mixin.EventMetaData,SRC> extends AbstractEvent<SRC> implements GenericMetaDataEvent<EM,SRC>
Ready to use GenericActionEvent storing a defined set of EventMetaData.

TIPP: In order to distinguish AbstractMetaDataEvent 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 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.MetaDataAccessor

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

    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>

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    protected EM
    _eventMetaData
     

  • Constructor Summary

    Constructors
    Constructor
    Description
    AbstractMetaDataEvent(EM aEventMetaData, SRC aSource)
    Constructs an event with the given Meta-Data.
    AbstractMetaDataEvent(String channel, SRC aSource)
    Constructs an event with the given Meta-Data.
    AbstractMetaDataEvent(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.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.SourceAccessor

    getSource

  • Field Details

    • _eventMetaData

      protected EM extends org.refcodes.mixin.EventMetaData _eventMetaData

  • Constructor Details

    • AbstractMetaDataEvent

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

    • AbstractMetaDataEvent

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

    • AbstractMetaDataEvent

      public AbstractMetaDataEvent(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<EM extends org.refcodes.mixin.EventMetaData>

    • toString

      public String toString()
      Overrides:
      toString in class Object