Module org.refcodes.observer

Package org.refcodes.observer

package org.refcodes.observer

This package provides types supporting the Observable-Pattern. E.g. we have the definitions of an Observable and the according Observer.

An Observable for example can be observed by Observer instances being subscribed to it via Observable.subscribeObserver(Object).

Class	Description
AbstractActionEvent<A,SRC>	The Class AbstractActionEvent.
AbstractEvent<SRC>	Basic implementation of the GenericEvent.
AbstractEventMatcher<E extends GenericEvent<?>>	Abstract implementation of an EventMatcher type.
AbstractMetaDataActionEvent<A,EM extends org.refcodes.mixin.EventMetaData,SRC>	Ready to use GenericActionEvent storing a defined set of EventMetaData.
AbstractMetaDataActionEvent.AbstractActionMetaDataEventBuilder<A,EM extends org.refcodes.mixin.EventMetaData,SRC,B extends GenericActionMetaDataEvent.GenericActionMetaDataEventBuilder<A,EM,SRC,B>>	Implementation of the GenericActionMetaDataEvent.GenericActionMetaDataEventBuilder interface for easily creating MetaDataActionEvent instances.
AbstractMetaDataEvent<EM extends org.refcodes.mixin.EventMetaData,SRC>	Ready to use GenericActionEvent storing a defined set of EventMetaData.
AbstractObservable<O,EV>	This abstract class provides functionality to implement default refcodes Observable behavior.
AbstractPayloadActionEvent<A,P,SRC>	Basic implementation of the GenericActionPayloadEvent.
AbstractPayloadEvent<P,SRC>	Basic implementation of the GenericPayloadEvent.
AbstractPayloadMetaDataActionEvent<A,P,EM extends org.refcodes.mixin.EventMetaData,SRC>	Basic implementation of the GenericActionPayloadMetaDataEvent.
AbstractPayloadMetaDataActionEvent.AbstractActionPayloadMetaDataEventBuilder<A,P,EM extends org.refcodes.mixin.EventMetaData,SRC,B extends GenericActionPayloadMetaDataEvent.GenericActionPayloadMetaDataEventBuilder<A,P,EM,SRC,B>>	Basic implementation of the GenericActionPayloadMetaDataEvent.GenericActionPayloadMetaDataEventBuilder.
AbstractPayloadMetaDataEvent<P,EM extends org.refcodes.mixin.EventMetaData,SRC>	Basic implementation of the GenericActionPayloadEvent.
ActionEqualWithEventMatcher<E extends GenericActionMetaDataEvent<?,?,?>>	Matches the given action with the action stored in an event's meta data (ACTION EQUAL WITH).
ActionEvent	An ActionEvent extends the Event and provides additional means to provide an action ActionAccessor.getAction() being of type Enum.
ActionEventImpl	Basic implementation of the Event interface.
AliasEqualWithEventMatcher<E extends GenericMetaDataEvent<?,?>>	Matches the given alias with the alias stored in an event's meta data (ALIAS EQUAL WITH).
CatchAllEventMatcher<E extends GenericMetaDataEvent<?,?>>	Catches all events, no matching is done (CATCH ALL).
CatchNoneEventMatcher<E extends GenericMetaDataEvent<?,?>>	Catches no events, no matching is done (CATCH NONE).
ChannelEqualWithEventMatcher<E extends GenericMetaDataEvent<?,?>>	Matches the given channel with the channel stored in an event's meta data (CHANNEL EQUAL WITH).
Event	An Event is published by an Observable and is consumed by zero to many Observer instances.
EventImpl	Basic implementation of the Event interface.
EventMatcher<E extends GenericEvent<?>>	This interface typifies the Matcher interface for the usage with GenericActionEvent instances.
EventMatcherSugar	Declarative syntactic sugar which may be statically imported in order to allow declarative definitions for the EventMatcher elements.
GenericActionEvent<A,SRC>	An GenericActionEvent extends the GenericEvent and provides additional means to provide an action via ActionAccessor.getAction() being of a generic type.
GenericActionMetaDataEvent<A,EM extends org.refcodes.mixin.EventMetaData,SRC>	An GenericActionMetaDataEvent provides Meta-Data describing the GenericActionEvent in more detail and a source being the origin of the GenericActionMetaDataEvent.
GenericActionMetaDataEvent.GenericActionMetaDataEventBuilder<A,EM extends org.refcodes.mixin.EventMetaData,SRC,B extends GenericActionMetaDataEvent.GenericActionMetaDataEventBuilder<A,EM,SRC,B>>	Builder extension for the GenericActionMetaDataEvent type.
GenericActionPayloadEvent<A,P,SRC>	The GenericActionPayloadEvent represents an ActionEvent which carries an additional payload.
GenericActionPayloadMetaDataEvent<A,P,EM extends org.refcodes.mixin.EventMetaData,SRC>	An GenericActionPayloadMetaDataEvent provides Meta-Data describing the GenericActionPayloadMetaDataEvent in more detail and a payload as well as an action.
GenericActionPayloadMetaDataEvent.GenericActionPayloadMetaDataEventBuilder<A,P,EM extends org.refcodes.mixin.EventMetaData,SRC,B extends GenericActionPayloadMetaDataEvent.GenericActionPayloadMetaDataEventBuilder<A,P,EM,SRC,B>>	Builder extension for the GenericActionPayloadMetaDataEvent type.
GenericEvent<SRC>	An GenericEvent is published by an Observable and is consumed by zero to many Observer instances.
GenericMetaDataEvent<EM extends org.refcodes.mixin.EventMetaData,SRC>	An GenericMetaDataEvent provides Meta-Data describing the GenericActionEvent in more detail and a source being the origin of the GenericMetaDataEvent.
GenericPayloadEvent<P,SRC>	The GenericPayloadEvent represents an Event which carries an additional payload accessible via PayloadAccessor.getPayload().
GenericPayloadMetaDataEvent<P,EM extends org.refcodes.mixin.EventMetaData,SRC>	An GenericPayloadMetaDataEvent provides Meta-Data describing the GenericPayloadMetaDataEvent in more detail and a payload.
GroupEqualWithEventMatcher<E extends GenericMetaDataEvent<?,?>>	Matches the given group with the group stored in an event's meta data (GROUP EQUAL WITH).
MetaDataActionEvent	An MetaDataActionEvent is published by an Observable and is consumed by zero to many Observer instances.
MetaDataActionEvent.ActionMetaDataEventBuilder	Builder for the MetaDataActionEvent.
MetaDataActionEventBuilderImpl	Implementation of the MetaDataActionEvent.ActionMetaDataEventBuilder interface for easily creating MetaDataActionEvent instances.
MetaDataActionEventImpl	The Class MetaDataActionEventImpl.
MetaDataEvent	An MetaDataEvent is published by an Observable and is consumed by zero to many Observer instances.
MetaDataEventImpl	Basic implementation of the Event interface.
MetaDataEventMatcher<E extends GenericMetaDataEvent<?,?>>	This interface typifies the Matcher interface for the usage with GenericMetaDataEvent instances.
Observable<O>	The Observable interface can be implemented by any class which can be observed by Observer instances (proposal) or any listener interface (custom as of your needs).
ObservableObserver<O extends Observable<?>>	An ObservableObserver is an observer, observing an observable.
Observer<E extends GenericEvent<?>>	The listener of an event subscriber to be fed with events by a event publisher.
ObserverDescriptor<E extends GenericEvent<?>,O extends Observer<E>,EM extends EventMatcher<E>>	This ObserverDescriptor describes the Observer, i.e. in some cases an Observer requires an EventMatcher which determines which GenericActionEvent instances to pass to the Observer.
ObserverDescriptorImpl<E extends GenericEvent<?>,O extends Observer<E>,EM extends EventMatcher<E>>	As a descriptor describes something fixed, this class is immutable in the sense that there are no setters for the attributes.
Observers<O,B extends Observers<O,B>>	Provides methods to manage all subscribed Observer instances as a whole and is intended as an extension of the Observable interface.
PayloadActionEvent<P>	The PayloadActionEvent represents an ActionEvent which carries an additional payload.
PayloadActionEventImpl<P>	The PayloadActionEvent represents an ActionEvent which carries an additional payload.
PayloadEvent<P>	The PayloadEvent represents an Event which carries an additional payload accessible via PayloadAccessor.getPayload().
PayloadEventImpl<P>	Basic implementation of the PayloadEvent interface.
PayloadMetaDataActionEvent<P>	An PayloadMetaDataActionEvent provides Meta-Data describing the PayloadMetaDataActionEvent in more detail and a payload as well as an action.
PayloadMetaDataActionEvent.ActionPayloadMetaDataEventBuilder<P>	Builder extension for the PayloadMetaDataActionEvent type.
PayloadMetaDataActionEventBuilderImpl<P>	Implementation of the PayloadMetaDataActionEvent.ActionPayloadMetaDataEventBuilder interface for easily creating PayloadMetaDataActionEvent instances.
PayloadMetaDataActionEventImpl<P>	Basic implementation of the AbstractPayloadMetaDataActionEvent.
PayloadMetaDataEvent<P>	An PayloadMetaDataEvent provides Meta-Data describing the GenericPayloadMetaDataEvent in more detail and a payload.
PayloadMetaDataEventImpl<P>	Basic implementation of the PayloadMetaDataEvent interface.
Publisher<E extends GenericEvent<?>>	A system publishing GenericActionEvent instances (such as an event bus), may implement this interface.
PublisherIsAssignableFromMatcher<E extends GenericMetaDataEvent<?,?>,PT>	Matches by event publisher type (EVENT PUBLISHER TYPE).
SubscribeEvent<O extends Observable<?>>	An SubscribeEvent is published by an Observable when an observer is being subscribed.
SubscribeEventImpl<O extends Observable<?>>	The Class SubscribeEventImpl.
UniversalIdEqualWithEventMatcher<E extends GenericMetaDataEvent<?,?>>	Matches the given universal ID with the universal ID stored in an event's meta data (UNIVERSAL ID EQUAL WITH).
UnsubscribeEvent<O extends Observable<?>>	An UnsubscribeEvent is published by an Observable when an observer is being unsubscribed.
UnsubscribeEventImpl<O extends Observable<?>>	The Class UnsubscribeEventImpl.