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

Class EventMetaData

java.lang.Object
org.refcodes.observer.EventMetaData
All Implemented Interfaces:
org.refcodes.mixin.AliasAccessor, org.refcodes.mixin.ChannelAccessor, org.refcodes.mixin.GroupAccessor, org.refcodes.mixin.UniversalIdAccessor
Direct Known Subclasses:
EventMetaDataBuilder
public class EventMetaData extends Object implements org.refcodes.mixin.UniversalIdAccessor, org.refcodes.mixin.AliasAccessor, org.refcodes.mixin.GroupAccessor, org.refcodes.mixin.ChannelAccessor
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/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
    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
    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()
    String
    toString()

    Methods inherited from class java.lang.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

  • Method Details

    • getAlias

      public String getAlias()
      Specified by:
      getAlias in interface org.refcodes.mixin.AliasAccessor

    • getChannel

      public String getChannel()
      Specified by:
      getChannel in interface org.refcodes.mixin.ChannelAccessor

    • getGroup

      public String getGroup()
      Specified by:
      getGroup in interface org.refcodes.mixin.GroupAccessor

    • 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.
      Returns:
      The type of the publisher who published the event.

    • getUniversalId

      public String getUniversalId()
      Specified by:
      getUniversalId in interface org.refcodes.mixin.UniversalIdAccessor

    • toString

      public String toString()
      Overrides:
      toString in class Object