Package org.refcodes.observer

This package provides types supporting the Observable-Pattern.

See: Description

Interface Summary

Interface	Description
ActionEvent	An ActionEvent extends the Event and provides additional means to provide an action ActionAccessor.getAction() being of type Enum.
ActionMetaDataEvent	An ActionMetaDataEvent is published by an Observable and is consumed by zero to many Observer instances.
ActionMetaDataEvent.ActionMetaDataEventBuilder	Builder for the ActionMetaDataEvent.
ActionPayloadEvent<P>	The ActionPayloadEvent represents an ActionEvent which carries an additional payload.
ActionPayloadMetaDataEvent<P>	An ActionPayloadMetaDataEvent provides Meta-Data describing the ActionPayloadMetaDataEvent in more detail and a payload as well as an action.
ActionPayloadMetaDataEvent.ActionPayloadMetaDataEventBuilder<P>	Builder extension for the ActionPayloadMetaDataEvent type.
Event	An Event is published by an Observable and is consumed by zero to many Observer instances.
EventMatcher<E extends GenericEvent<?>>	This interface typifies the Matcher interface for the usage with GenericActionEvent 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>	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 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 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 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 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 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 EventMetaData,SRC>	An GenericPayloadMetaDataEvent provides Meta-Data describing the GenericPayloadMetaDataEvent in more detail and a payload.
MetaDataEvent	An MetaDataEvent is published by an Observable and is consumed by zero to many Observer instances.
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.
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.
PayloadEvent<P>	The PayloadEvent represents an Event which carries an additional payload accessible via PayloadAccessor.getPayload().
PayloadMetaDataEvent<P>	An PayloadMetaDataEvent provides Meta-Data describing the GenericPayloadMetaDataEvent in more detail and a payload.
Publisher<E extends GenericEvent<?>>	A system publishing GenericActionEvent instances (such as an event bus), may implement this interface.
SubscribeEvent<O extends Observable<?>>	An SubscribeEvent is published by an Observable when an observer is being subscribed.
UnsubscribeEvent<O extends Observable<?>>	An UnsubscribeEvent is published by an Observable when an observer is being unsubscribed.

Class Summary

Class	Description
AbstractActionEvent<A,SRC>	The Class AbstractActionEvent.
AbstractActionMetaDataEvent<A,EM extends EventMetaData,SRC>	Ready to use GenericActionEvent storing a defined set of EventMetaData.
AbstractActionMetaDataEvent.AbstractActionMetaDataEventBuilder<A,EM extends EventMetaData,SRC,B extends GenericActionMetaDataEvent.GenericActionMetaDataEventBuilder<A,EM,SRC,B>>	Implementation of the GenericActionMetaDataEventBuilder interface for easily creating ActionMetaDataEvent instances.
AbstractActionPayloadEvent<A,P,SRC>	Basic implementation of the GenericActionPayloadEvent.
AbstractActionPayloadMetaDataEvent<A,P,EM extends EventMetaData,SRC>	Basic implementation of the GenericActionPayloadMetaDataEvent.
AbstractActionPayloadMetaDataEvent.AbstractActionPayloadMetaDataEventBuilder<A,P,EM extends EventMetaData,SRC,B extends GenericActionPayloadMetaDataEvent.GenericActionPayloadMetaDataEventBuilder<A,P,EM,SRC,B>>	Basic implementation of the GenericActionPayloadMetaDataEventBuilder.
AbstractEvent<SRC>	Basic implementation of the GenericEvent.
AbstractMetaDataEvent<EM extends 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.
AbstractPayloadEvent<P,SRC>	Basic implementation of the GenericPayloadEvent.
AbstractPayloadMetaDataEvent<P,EM extends EventMetaData,SRC>	Basic implementation of the GenericActionPayloadEvent.
ActionEventImpl	Basic implementation of the Event interface.
ActionMetaDataEventBuilderImpl	Implementation of the ActionMetaDataEvent.ActionMetaDataEventBuilder interface for easily creating ActionMetaDataEvent instances.
ActionMetaDataEventImpl
ActionPayloadEventImpl<P>	The ActionPayloadEvent represents an ActionEvent which carries an additional payload.
ActionPayloadMetaDataEventBuilderImpl<P>	Implementation of the ActionPayloadMetaDataEvent.ActionPayloadMetaDataEventBuilder interface for easily creating ActionPayloadMetaDataEvent instances.
ActionPayloadMetaDataEventImpl<P>	Basic implementation of the AbstractActionPayloadMetaDataEvent.
EventImpl	Basic implementation of the Event interface.
EventMatcherSugar	Declarative syntactic sugar which may be statically imported in order to allow declarative definitions for the EventMatcher elements.
EventMetaDataBuilderImpl
EventMetaDataImpl	Straight forward implementation of the minimal EventMetaData interface.
MetaDataEventImpl	Basic implementation of the Event interface.
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.
PayloadEventImpl<P>	Basic implementation of the PayloadEvent interface.
PayloadMetaDataEventImpl<P>	Basic implementation of the PayloadMetaDataEvent interface.
SubscribeEventImpl<O extends Observable<?>>	The Class SubscribeEventImpl.
UnsubscribeEventImpl<O extends Observable<?>>	The Class UnsubscribeEventImpl.

Package org.refcodes.observer Description

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).