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)
.
-
Interface Summary Interface Description ActionEvent AnActionEvent
extends theEvent
and provides additional means to provide an actionActionAccessor.getAction()
being of typeEnum
.ActionMetaDataEvent AnActionMetaDataEvent
is published by anObservable
and is consumed by zero to manyObserver
instances.ActionMetaDataEvent.ActionMetaDataEventBuilder Builder for theActionMetaDataEvent
.ActionPayloadEvent<P> TheActionPayloadEvent
represents anActionEvent
which carries an additional payload.ActionPayloadMetaDataEvent<P> AnActionPayloadMetaDataEvent
provides Meta-Data describing theActionPayloadMetaDataEvent
in more detail and a payload as well as an action.ActionPayloadMetaDataEvent.ActionPayloadMetaDataEventBuilder<P> Builder extension for theActionPayloadMetaDataEvent
type.Event EventMatcher<E extends GenericEvent<?>> This interface typifies theMatcher
interface for the usage withGenericActionEvent
instances.EventMetaData The Meta-Data describes the event which a publisher posts via the event bus to an event subscriber's event listener.EventMetaData.EventMetaDataBuilder GenericActionEvent<A,SRC> AnGenericActionEvent
extends theGenericEvent
and provides additional means to provide an action viaActionAccessor.getAction()
being of a generic type.GenericActionMetaDataEvent<A,EM extends EventMetaData,SRC> AnGenericActionMetaDataEvent
provides Meta-Data describing theGenericActionEvent
in more detail and a source being the origin of theGenericActionMetaDataEvent
.GenericActionMetaDataEvent.GenericActionMetaDataEventBuilder<A,EM extends EventMetaData,SRC,B extends GenericActionMetaDataEvent.GenericActionMetaDataEventBuilder<A,EM,SRC,B>> Builder extension for theGenericActionMetaDataEvent
type.GenericActionPayloadEvent<A,P,SRC> TheGenericActionPayloadEvent
represents anActionEvent
which carries an additional payload.GenericActionPayloadMetaDataEvent<A,P,EM extends EventMetaData,SRC> AnGenericActionPayloadMetaDataEvent
provides Meta-Data describing theGenericActionPayloadMetaDataEvent
in more detail and a payload as well as an action.GenericActionPayloadMetaDataEvent.GenericActionPayloadMetaDataEventBuilder<A,P,EM extends EventMetaData,SRC,B extends GenericActionPayloadMetaDataEvent.GenericActionPayloadMetaDataEventBuilder<A,P,EM,SRC,B>> Builder extension for theGenericActionPayloadMetaDataEvent
type.GenericEvent<SRC> GenericMetaDataEvent<EM extends EventMetaData,SRC> AnGenericMetaDataEvent
provides Meta-Data describing theGenericActionEvent
in more detail and a source being the origin of theGenericMetaDataEvent
.GenericPayloadEvent<P,SRC> TheGenericPayloadEvent
represents anEvent
which carries an additional payload accessible viaPayloadAccessor.getPayload()
.GenericPayloadMetaDataEvent<P,EM extends EventMetaData,SRC> AnGenericPayloadMetaDataEvent
provides Meta-Data describing theGenericPayloadMetaDataEvent
in more detail and a payload.MetaDataEvent MetaDataEventMatcher<E extends GenericMetaDataEvent<?,?>> This interface typifies theMatcher
interface for the usage withGenericMetaDataEvent
instances.Observable<O> TheObservable
interface can be implemented by any class which can be observed byObserver
instances (proposal) or any listener interface (custom as of your needs).ObservableObserver<O extends Observable<?>> AnObservableObserver
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>> ThisObserverDescriptor
describes theObserver
, i.e. in some cases anObserver
requires anEventMatcher
which determines whichGenericActionEvent
instances to pass to theObserver
.Observers<O,B extends Observers<O,B>> Provides methods to manage all subscribedObserver
instances as a whole and is intended as an extension of theObservable
interface.PayloadEvent<P> ThePayloadEvent
represents anEvent
which carries an additional payload accessible viaPayloadAccessor.getPayload()
.PayloadMetaDataEvent<P> AnPayloadMetaDataEvent
provides Meta-Data describing theGenericPayloadMetaDataEvent
in more detail and a payload.Publisher<E extends GenericEvent<?>> A system publishingGenericActionEvent
instances (such as an event bus), may implement this interface.SubscribeEvent<O extends Observable<?>> AnSubscribeEvent
is published by anObservable
when an observer is being subscribed.UnsubscribeEvent<O extends Observable<?>> AnUnsubscribeEvent
is published by anObservable
when an observer is being unsubscribed.