Package org.refcodes.observer

This package provides types supporting the Observable-Pattern.

See: Description

Interface Summary

Interface	Description
ActionEvent<A,SRC>	An ActionEvent is published by an Observable and is consumed by zero to many Observer instances.
Event<SRC>	An Event is published by an Observable and is consumed by zero to many Observer instances.
EventMatcher<E extends Event<?>>	This interface typifies the Matcher interface for the usage with ActionEvent instances.
EventMetaData	The meta data describes the event which a publisher posts via the event bus to an event subscriber's event listener.
MetaDataActionEvent<A,SRC>	An MetaDataActionEvent is published by an Observable and is consumed by zero to many Observer instances.
MetaDataEvent<SRC>	An MetaDataEvent is published by an Observable and is consumed by zero to many Observer instances.
MetaDataEventMatcher<E extends MetaDataEvent<?>>	This interface typifies the Matcher interface for the usage with MetaDataEvent 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 Event<?>>	The listener of an event subscriber to be fed with events by a event publisher.
ObserverDescriptor<E extends Event<?>,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 ActionEvent instances to pass to the Observer.
Publisher<E extends Event<?>>	A system publishing ActionEvent 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.
AbstractEvent<SRC>	The Class AbstractEvent.
AbstractObservable<O,EV>	This abstract class provides functionality to implement default refcodes Observable behavior.
EventMatcherSugar	Declarative syntactic sugar which may be statically imported in order to allow declarative definitions for the EventMatcher elements.
EventMetaDataImpl	Straight forward implementation of the minimal EventMetaData interface.
MetaDataActionEventImpl<A,SRC>	Ready to use ActionEvent storing a defined set of EventMetaData.
MetaDataEventImpl<SRC>	Ready to use ActionEvent storing a defined set of EventMetaData.
ObserverDescriptorImpl<E extends Event<?>,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.
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).