A C D E F G H I M N O P S T U W _
A
- AbstractActionEvent<A,SRC> - Class in org.refcodes.observer
-
The Class AbstractActionEvent.
- AbstractActionEvent(A, SRC) - Constructor for class org.refcodes.observer.AbstractActionEvent
-
Constructs an event with the given source.
- AbstractActionEvent(SRC) - Constructor for class org.refcodes.observer.AbstractActionEvent
-
Constructs an event with the given source.
- AbstractActionMetaDataEvent<A,EM extends EventMetaData,SRC> - Class in org.refcodes.observer
-
Ready to use
GenericActionEvent
storing a defined set ofEventMetaData
. - AbstractActionMetaDataEvent(A, EM, SRC) - Constructor for class org.refcodes.observer.AbstractActionMetaDataEvent
-
Constructs an event with the given Meta-Data.
- AbstractActionMetaDataEvent(A, SRC) - Constructor for class org.refcodes.observer.AbstractActionMetaDataEvent
-
Constructs an event with the given Meta-Data.
- AbstractActionMetaDataEvent(EM, SRC) - Constructor for class org.refcodes.observer.AbstractActionMetaDataEvent
-
Constructs an event with the given Meta-Data.
- AbstractActionMetaDataEvent(SRC) - Constructor for class org.refcodes.observer.AbstractActionMetaDataEvent
-
Constructs an event with the given Meta-Data.
- AbstractActionMetaDataEvent.AbstractActionMetaDataEventBuilder<A,EM extends EventMetaData,SRC,B extends GenericActionMetaDataEvent.GenericActionMetaDataEventBuilder<A,EM,SRC,B>> - Class in org.refcodes.observer
-
Implementation of the
GenericActionMetaDataEvent.GenericActionMetaDataEventBuilder
interface for easily creatingActionMetaDataEvent
instances. - AbstractActionMetaDataEventBuilder(A, EM, SRC) - Constructor for class org.refcodes.observer.AbstractActionMetaDataEvent.AbstractActionMetaDataEventBuilder
-
Constructs an event with the given Meta-Data.
- AbstractActionMetaDataEventBuilder(A, SRC) - Constructor for class org.refcodes.observer.AbstractActionMetaDataEvent.AbstractActionMetaDataEventBuilder
-
Constructs an event with the given Meta-Data.
- AbstractActionMetaDataEventBuilder(EM, SRC) - Constructor for class org.refcodes.observer.AbstractActionMetaDataEvent.AbstractActionMetaDataEventBuilder
-
Constructs an event with the given Meta-Data.
- AbstractActionMetaDataEventBuilder(SRC) - Constructor for class org.refcodes.observer.AbstractActionMetaDataEvent.AbstractActionMetaDataEventBuilder
-
Constructs an event with the given Meta-Data.
- AbstractActionPayloadEvent<A,P,SRC> - Class in org.refcodes.observer
-
Basic implementation of the
GenericActionPayloadEvent
. - AbstractActionPayloadEvent(A, P, SRC) - Constructor for class org.refcodes.observer.AbstractActionPayloadEvent
-
Constructs an event with the given Meta-Data.
- AbstractActionPayloadMetaDataEvent<A,P,EM extends EventMetaData,SRC> - Class in org.refcodes.observer
-
Basic implementation of the
GenericActionPayloadMetaDataEvent
. - AbstractActionPayloadMetaDataEvent(A, P, EM, SRC) - Constructor for class org.refcodes.observer.AbstractActionPayloadMetaDataEvent
-
Constructs an event with the given Meta-Data.
- AbstractActionPayloadMetaDataEvent(A, P, SRC) - Constructor for class org.refcodes.observer.AbstractActionPayloadMetaDataEvent
-
Constructs an event with the given Meta-Data.
- AbstractActionPayloadMetaDataEvent(P, EM, SRC) - Constructor for class org.refcodes.observer.AbstractActionPayloadMetaDataEvent
-
Constructs an event with the given Meta-Data.
- AbstractActionPayloadMetaDataEvent(P, SRC) - Constructor for class org.refcodes.observer.AbstractActionPayloadMetaDataEvent
-
Constructs an event with the given Meta-Data.
- AbstractActionPayloadMetaDataEvent.AbstractActionPayloadMetaDataEventBuilder<A,P,EM extends EventMetaData,SRC,B extends GenericActionPayloadMetaDataEvent.GenericActionPayloadMetaDataEventBuilder<A,P,EM,SRC,B>> - Class in org.refcodes.observer
-
Basic implementation of the
GenericActionPayloadMetaDataEvent.GenericActionPayloadMetaDataEventBuilder
. - AbstractActionPayloadMetaDataEventBuilder(A, P, EM, SRC) - Constructor for class org.refcodes.observer.AbstractActionPayloadMetaDataEvent.AbstractActionPayloadMetaDataEventBuilder
-
Constructs an event with the given Meta-Data.
- AbstractActionPayloadMetaDataEventBuilder(A, P, SRC) - Constructor for class org.refcodes.observer.AbstractActionPayloadMetaDataEvent.AbstractActionPayloadMetaDataEventBuilder
-
Constructs an event with the given Meta-Data.
- AbstractActionPayloadMetaDataEventBuilder(EM, SRC) - Constructor for class org.refcodes.observer.AbstractActionPayloadMetaDataEvent.AbstractActionPayloadMetaDataEventBuilder
-
Constructs an event with the given Meta-Data.
- AbstractActionPayloadMetaDataEventBuilder(P, EM, SRC) - Constructor for class org.refcodes.observer.AbstractActionPayloadMetaDataEvent.AbstractActionPayloadMetaDataEventBuilder
-
Constructs an event with the given Meta-Data.
- AbstractActionPayloadMetaDataEventBuilder(P, SRC) - Constructor for class org.refcodes.observer.AbstractActionPayloadMetaDataEvent.AbstractActionPayloadMetaDataEventBuilder
-
Constructs an event with the given Meta-Data.
- AbstractEvent<SRC> - Class in org.refcodes.observer
-
Basic implementation of the
GenericEvent
. - AbstractEvent(SRC) - Constructor for class org.refcodes.observer.AbstractEvent
-
Constructs an event with the given source.
- AbstractMetaDataEvent<EM extends EventMetaData,SRC> - Class in org.refcodes.observer
-
Ready to use
GenericActionEvent
storing a defined set ofEventMetaData
. - AbstractMetaDataEvent(EM, SRC) - Constructor for class org.refcodes.observer.AbstractMetaDataEvent
-
Constructs an event with the given Meta-Data.
- AbstractMetaDataEvent(String, SRC) - Constructor for class org.refcodes.observer.AbstractMetaDataEvent
-
Constructs an event with the given Meta-Data.
- AbstractMetaDataEvent(SRC) - Constructor for class org.refcodes.observer.AbstractMetaDataEvent
-
Constructs an event with the given Meta-Data.
- AbstractObservable<O,EV> - Class in org.refcodes.observer
-
This abstract class provides functionality to implement default refcodes
Observable
behavior. - AbstractObservable() - Constructor for class org.refcodes.observer.AbstractObservable
-
Constructs the
AbstractObservable
with a defaultExecutorService
pool. - AbstractObservable(ExecutorService) - Constructor for class org.refcodes.observer.AbstractObservable
-
Constructs the
AbstractObservable
with a providedExecutorService
pool. - AbstractPayloadEvent<P,SRC> - Class in org.refcodes.observer
-
Basic implementation of the
GenericPayloadEvent
. - AbstractPayloadEvent(P, SRC) - Constructor for class org.refcodes.observer.AbstractPayloadEvent
-
Constructs an event with the given source.
- AbstractPayloadMetaDataEvent<P,EM extends EventMetaData,SRC> - Class in org.refcodes.observer
-
Basic implementation of the
GenericActionPayloadEvent
. - AbstractPayloadMetaDataEvent(P, EM, SRC) - Constructor for class org.refcodes.observer.AbstractPayloadMetaDataEvent
-
Constructs an event with the given Meta-Data and payload.
- actionEqualWith(A) - Static method in class org.refcodes.observer.EventMatcherSugar
-
Factory method to create an "EQUAL WITH" matcher for the given action compared with the action stored in the
EventMetaData
. - ActionEvent - Interface in org.refcodes.observer
-
An
ActionEvent
extends theEvent
and provides additional means to provide an actionActionAccessor.getAction()
being of typeEnum
. - ActionEventImpl - Class in org.refcodes.observer
-
Basic implementation of the
Event
interface. - ActionEventImpl(Enum<?>, Object) - Constructor for class org.refcodes.observer.ActionEventImpl
-
Constructs an event with the given source.
- ActionMetaDataEvent - Interface in org.refcodes.observer
-
An
ActionMetaDataEvent
is published by anObservable
and is consumed by zero to manyObserver
instances. - ActionMetaDataEvent.ActionMetaDataEventBuilder - Interface in org.refcodes.observer
-
Builder for the
ActionMetaDataEvent
. - ActionMetaDataEventBuilderImpl - Class in org.refcodes.observer
-
Implementation of the
ActionMetaDataEvent.ActionMetaDataEventBuilder
interface for easily creatingActionMetaDataEvent
instances. - ActionMetaDataEventBuilderImpl(Class<?>, Object) - Constructor for class org.refcodes.observer.ActionMetaDataEventBuilderImpl
-
Constructs an event with predefined values for the according properties retrieved from the caller's class.
- ActionMetaDataEventBuilderImpl(Enum<?>, Class<?>, Object) - Constructor for class org.refcodes.observer.ActionMetaDataEventBuilderImpl
-
Constructs an event with predefined values for the according properties retrieved from the caller's class.
- ActionMetaDataEventBuilderImpl(Enum<?>, Object) - Constructor for class org.refcodes.observer.ActionMetaDataEventBuilderImpl
-
Constructs an event with the given Meta-Data.
- ActionMetaDataEventBuilderImpl(Enum<?>, String, Object) - Constructor for class org.refcodes.observer.ActionMetaDataEventBuilderImpl
-
Constructs an event with predefined values for the according properties retrieved from the caller's class.
- ActionMetaDataEventBuilderImpl(Enum<?>, String, String, String, String, Class<?>, Object) - Constructor for class org.refcodes.observer.ActionMetaDataEventBuilderImpl
-
Constructs an event with the given values for the according properties.
- ActionMetaDataEventBuilderImpl(Enum<?>, EventMetaData, Object) - Constructor for class org.refcodes.observer.ActionMetaDataEventBuilderImpl
-
Constructs an event with the given Meta-Data.
- ActionMetaDataEventBuilderImpl(Object) - Constructor for class org.refcodes.observer.ActionMetaDataEventBuilderImpl
-
Constructs an event with the given Meta-Data.
- ActionMetaDataEventBuilderImpl(String, Object) - Constructor for class org.refcodes.observer.ActionMetaDataEventBuilderImpl
-
Constructs an event with predefined values for the according properties retrieved from the caller's class.
- ActionMetaDataEventBuilderImpl(String, String, String, String, Class<?>, Object) - Constructor for class org.refcodes.observer.ActionMetaDataEventBuilderImpl
-
Constructs an event with the given values for the according properties.
- ActionMetaDataEventBuilderImpl(EventMetaData, Object) - Constructor for class org.refcodes.observer.ActionMetaDataEventBuilderImpl
-
Constructs an event with the given Meta-Data.
- ActionMetaDataEventImpl - Class in org.refcodes.observer
- ActionMetaDataEventImpl(Class<?>, Object) - Constructor for class org.refcodes.observer.ActionMetaDataEventImpl
-
Constructs an event with the according properties.
- ActionMetaDataEventImpl(Enum<?>, Class<?>, Object) - Constructor for class org.refcodes.observer.ActionMetaDataEventImpl
-
Constructs an event with the according properties.
- ActionMetaDataEventImpl(Enum<?>, Object) - Constructor for class org.refcodes.observer.ActionMetaDataEventImpl
-
Constructs an event with the given Meta-Data.
- ActionMetaDataEventImpl(Enum<?>, String, Object) - Constructor for class org.refcodes.observer.ActionMetaDataEventImpl
-
Constructs an event with the according properties.
- ActionMetaDataEventImpl(Enum<?>, String, String, String, String, Class<?>, Object) - Constructor for class org.refcodes.observer.ActionMetaDataEventImpl
-
Constructs an event with the given values for the according properties.
- ActionMetaDataEventImpl(Enum<?>, EventMetaData, Object) - Constructor for class org.refcodes.observer.ActionMetaDataEventImpl
-
Constructs an event with the given Meta-Data.
- ActionMetaDataEventImpl(Object) - Constructor for class org.refcodes.observer.ActionMetaDataEventImpl
-
Constructs an event with the given Meta-Data.
- ActionMetaDataEventImpl(String, Object) - Constructor for class org.refcodes.observer.ActionMetaDataEventImpl
-
Constructs an event with the according properties.
- ActionMetaDataEventImpl(String, String, String, String, Class<?>, Object) - Constructor for class org.refcodes.observer.ActionMetaDataEventImpl
-
Constructs an event with the given values for the according properties.
- ActionMetaDataEventImpl(EventMetaData, Object) - Constructor for class org.refcodes.observer.ActionMetaDataEventImpl
-
Constructs an event with the given Meta-Data.
- ActionPayloadEvent<P> - Interface in org.refcodes.observer
-
The
ActionPayloadEvent
represents anActionEvent
which carries an additional payload. - ActionPayloadEventImpl<P> - Class in org.refcodes.observer
-
The
ActionPayloadEvent
represents anActionEvent
which carries an additional payload. - ActionPayloadEventImpl(Enum<?>, P, Object) - Constructor for class org.refcodes.observer.ActionPayloadEventImpl
-
Constructs an event with the given Meta-Data.
- ActionPayloadMetaDataEvent<P> - Interface in org.refcodes.observer
-
An
ActionPayloadMetaDataEvent
provides Meta-Data describing theActionPayloadMetaDataEvent
in more detail and a payload as well as an action. - ActionPayloadMetaDataEvent.ActionPayloadMetaDataEventBuilder<P> - Interface in org.refcodes.observer
-
Builder extension for the
ActionPayloadMetaDataEvent
type. - ActionPayloadMetaDataEventBuilderImpl<P> - Class in org.refcodes.observer
-
Implementation of the
ActionPayloadMetaDataEvent.ActionPayloadMetaDataEventBuilder
interface for easily creatingActionPayloadMetaDataEvent
instances. - ActionPayloadMetaDataEventBuilderImpl(Class<?>, Object) - Constructor for class org.refcodes.observer.ActionPayloadMetaDataEventBuilderImpl
-
Constructs an event with predefined values for the according properties retrieved from the caller's class.
- ActionPayloadMetaDataEventBuilderImpl(Enum<?>, Class<?>, Object) - Constructor for class org.refcodes.observer.ActionPayloadMetaDataEventBuilderImpl
-
Constructs an event with predefined values for the according properties retrieved from the caller's class.
- ActionPayloadMetaDataEventBuilderImpl(Enum<?>, Object) - Constructor for class org.refcodes.observer.ActionPayloadMetaDataEventBuilderImpl
-
Constructs an event with the given Meta-Data.
- ActionPayloadMetaDataEventBuilderImpl(Enum<?>, String, Object) - Constructor for class org.refcodes.observer.ActionPayloadMetaDataEventBuilderImpl
-
Constructs an event with predefined values for the according properties retrieved from the caller's class.
- ActionPayloadMetaDataEventBuilderImpl(Enum<?>, String, String, String, String, Class<?>, Object) - Constructor for class org.refcodes.observer.ActionPayloadMetaDataEventBuilderImpl
-
Constructs an event with the given values for the according properties.
- ActionPayloadMetaDataEventBuilderImpl(Enum<?>, EventMetaData, Object) - Constructor for class org.refcodes.observer.ActionPayloadMetaDataEventBuilderImpl
-
Constructs an event with the given Meta-Data.
- ActionPayloadMetaDataEventBuilderImpl(Enum<?>, P, Object) - Constructor for class org.refcodes.observer.ActionPayloadMetaDataEventBuilderImpl
-
Constructs an event with the given Meta-Data.
- ActionPayloadMetaDataEventBuilderImpl(Enum<?>, P, EventMetaData, Object) - Constructor for class org.refcodes.observer.ActionPayloadMetaDataEventBuilderImpl
-
Constructs an event with the given Meta-Data.
- ActionPayloadMetaDataEventBuilderImpl(Object) - Constructor for class org.refcodes.observer.ActionPayloadMetaDataEventBuilderImpl
-
Constructs an event with the given Meta-Data.
- ActionPayloadMetaDataEventBuilderImpl(String, Object) - Constructor for class org.refcodes.observer.ActionPayloadMetaDataEventBuilderImpl
-
Constructs an event with predefined values for the according properties retrieved from the caller's class.
- ActionPayloadMetaDataEventBuilderImpl(String, String, String, String, Class<?>, Object) - Constructor for class org.refcodes.observer.ActionPayloadMetaDataEventBuilderImpl
-
Constructs an event with the given values for the according properties.
- ActionPayloadMetaDataEventBuilderImpl(EventMetaData, Object) - Constructor for class org.refcodes.observer.ActionPayloadMetaDataEventBuilderImpl
-
Constructs an event with the given Meta-Data.
- ActionPayloadMetaDataEventBuilderImpl(P, Object) - Constructor for class org.refcodes.observer.ActionPayloadMetaDataEventBuilderImpl
-
Constructs an event with the given Meta-Data.
- ActionPayloadMetaDataEventBuilderImpl(P, EventMetaData, Object) - Constructor for class org.refcodes.observer.ActionPayloadMetaDataEventBuilderImpl
-
Constructs an event with the given Meta-Data.
- ActionPayloadMetaDataEventImpl<P> - Class in org.refcodes.observer
-
Basic implementation of the
AbstractActionPayloadMetaDataEvent
. - ActionPayloadMetaDataEventImpl(Enum<?>, Class<?>, Object) - Constructor for class org.refcodes.observer.ActionPayloadMetaDataEventImpl
-
Constructs an event with predefined values for the according properties retrieved from the caller's class.
- ActionPayloadMetaDataEventImpl(Enum<?>, Object) - Constructor for class org.refcodes.observer.ActionPayloadMetaDataEventImpl
-
Constructs an event with the given Meta-Data.
- ActionPayloadMetaDataEventImpl(Enum<?>, String, Object) - Constructor for class org.refcodes.observer.ActionPayloadMetaDataEventImpl
-
Constructs an event with predefined values for the according properties retrieved from the caller's class.
- ActionPayloadMetaDataEventImpl(Enum<?>, String, String, String, String, Class<?>, Object) - Constructor for class org.refcodes.observer.ActionPayloadMetaDataEventImpl
-
Constructs an event with the given values for the according properties.
- ActionPayloadMetaDataEventImpl(Enum<?>, EventMetaData, Object) - Constructor for class org.refcodes.observer.ActionPayloadMetaDataEventImpl
-
Constructs an event with the given Meta-Data.
- ActionPayloadMetaDataEventImpl(Enum<?>, P, Object) - Constructor for class org.refcodes.observer.ActionPayloadMetaDataEventImpl
-
Constructs an event with the given Meta-Data.
- ActionPayloadMetaDataEventImpl(Enum<?>, P, EventMetaData, Object) - Constructor for class org.refcodes.observer.ActionPayloadMetaDataEventImpl
-
Constructs an event with the given Meta-Data.
- ActionPayloadMetaDataEventImpl(P, Object) - Constructor for class org.refcodes.observer.ActionPayloadMetaDataEventImpl
-
Constructs an event with the given Meta-Data.
- ActionPayloadMetaDataEventImpl(P, EventMetaData, Object) - Constructor for class org.refcodes.observer.ActionPayloadMetaDataEventImpl
-
Constructs an event with the given Meta-Data.
- and(EventMatcher<E>...) - Static method in class org.refcodes.observer.EventMatcherSugar
-
Factory method to create an "AND" matcher for the given matchers.
C
- catchAll() - Static method in class org.refcodes.observer.EventMatcherSugar
-
Catches all events, no matching is done.
- catchNone() - Static method in class org.refcodes.observer.EventMatcherSugar
-
Catches no event, no matching is done.
- clear() - Method in class org.refcodes.observer.AbstractObservable
-
Clears all observers from this
AbstractObservable
.
D
- disableObservers() - Method in interface org.refcodes.observer.Observers
-
Disables all observables.
- dispose() - Method in class org.refcodes.observer.AbstractObservable
- doHandleEventListenerException(Exception, O, EV, ExecutionStrategy) - Method in class org.refcodes.observer.AbstractObservable
-
This hook method allows you to handle any exceptions being thrown by an event listener whilst invoking a given event.
E
- enableObservers() - Method in interface org.refcodes.observer.Observers
-
Enables all observables.
- Event - Interface in org.refcodes.observer
- EventImpl - Class in org.refcodes.observer
-
Basic implementation of the
Event
interface. - EventImpl(Object) - Constructor for class org.refcodes.observer.EventImpl
-
Constructs an event with the given source.
- EventMatcher<E extends GenericEvent<?>> - Interface in org.refcodes.observer
-
This interface typifies the
Matcher
interface for the usage withGenericActionEvent
instances. - EventMatcherSugar - Class in org.refcodes.observer
-
Declarative syntactic sugar which may be statically imported in order to allow declarative definitions for the
EventMatcher
elements. - EventMatcherSugar() - Constructor for class org.refcodes.observer.EventMatcherSugar
- EventMetaData - Interface in org.refcodes.observer
-
The Meta-Data describes the event which a publisher posts via the event bus to an event subscriber's event listener.
- EventMetaData.EventMetaDataBuilder - Interface in org.refcodes.observer
- EventMetaDataBuilderImpl - Class in org.refcodes.observer
- EventMetaDataBuilderImpl() - Constructor for class org.refcodes.observer.EventMetaDataBuilderImpl
-
Constructs the
EventMetaData
with no properties set except the Universal-ID. - EventMetaDataBuilderImpl(Class<?>) - Constructor for class org.refcodes.observer.EventMetaDataBuilderImpl
-
Constructs the
EventMetaData
with the given properties. - EventMetaDataBuilderImpl(String) - Constructor for class org.refcodes.observer.EventMetaDataBuilderImpl
-
Constructs the
EventMetaData
with the given properties. - EventMetaDataBuilderImpl(String, String) - Constructor for class org.refcodes.observer.EventMetaDataBuilderImpl
-
Constructs the
EventMetaData
with the given properties. - EventMetaDataBuilderImpl(String, String, String) - Constructor for class org.refcodes.observer.EventMetaDataBuilderImpl
-
Constructs the
EventMetaData
with the given properties. - EventMetaDataBuilderImpl(String, String, String, Class<?>) - Constructor for class org.refcodes.observer.EventMetaDataBuilderImpl
-
Constructs the
EventMetaData
with the given properties. - EventMetaDataBuilderImpl(String, String, String, String, Class<?>) - Constructor for class org.refcodes.observer.EventMetaDataBuilderImpl
-
Constructs the
EventMetaData
with the given properties. - EventMetaDataBuilderImpl(EventMetaData) - Constructor for class org.refcodes.observer.EventMetaDataBuilderImpl
-
Constructs the
EventMetaData
with the properties provided by the givenEventMetaData
instance. - EventMetaDataImpl - Class in org.refcodes.observer
-
Straight forward implementation of the minimal
EventMetaData
interface. - EventMetaDataImpl() - Constructor for class org.refcodes.observer.EventMetaDataImpl
-
Constructs the
EventMetaData
with no properties set except the Universal-ID. - EventMetaDataImpl(Class<?>) - Constructor for class org.refcodes.observer.EventMetaDataImpl
-
Constructs the
EventMetaData
with the given properties. - EventMetaDataImpl(String) - Constructor for class org.refcodes.observer.EventMetaDataImpl
-
Constructs the
EventMetaData
with the given properties. - EventMetaDataImpl(String, Class<?>) - Constructor for class org.refcodes.observer.EventMetaDataImpl
-
Constructs the
EventMetaData
with the given properties. - EventMetaDataImpl(String, String) - Constructor for class org.refcodes.observer.EventMetaDataImpl
-
Constructs the
EventMetaData
with the given properties. - EventMetaDataImpl(String, String, String) - Constructor for class org.refcodes.observer.EventMetaDataImpl
-
Constructs the
EventMetaData
with the given properties. - EventMetaDataImpl(String, String, String, String, Class<?>) - Constructor for class org.refcodes.observer.EventMetaDataImpl
-
Constructs the
EventMetaData
with the given properties. - EventMetaDataImpl(EventMetaData) - Constructor for class org.refcodes.observer.EventMetaDataImpl
-
Constructs the
EventMetaData
with the properties provided by the givenEventMetaData
instance.
F
- fireEvent(EV, ExecutionStrategy) - Method in class org.refcodes.observer.AbstractObservable
-
To be used by the implementing class when firing an event to it's listeners.
- fireEvent(EV, O, ExecutionStrategy) - Method in class org.refcodes.observer.AbstractObservable
-
This hook method is to be implemented by the implementing class.
G
- GenericActionEvent<A,SRC> - Interface in org.refcodes.observer
-
An
GenericActionEvent
extends theGenericEvent
and provides additional means to provide an action viaActionAccessor.getAction()
being of a generic type. - GenericActionMetaDataEvent<A,EM extends EventMetaData,SRC> - Interface in org.refcodes.observer
-
An
GenericActionMetaDataEvent
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>> - Interface in org.refcodes.observer
-
Builder extension for the
GenericActionMetaDataEvent
type. - GenericActionPayloadEvent<A,P,SRC> - Interface in org.refcodes.observer
-
The
GenericActionPayloadEvent
represents anActionEvent
which carries an additional payload. - GenericActionPayloadMetaDataEvent<A,P,EM extends EventMetaData,SRC> - Interface in org.refcodes.observer
-
An
GenericActionPayloadMetaDataEvent
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>> - Interface in org.refcodes.observer
-
Builder extension for the
GenericActionPayloadMetaDataEvent
type. - GenericEvent<SRC> - Interface in org.refcodes.observer
- GenericMetaDataEvent<EM extends EventMetaData,SRC> - Interface in org.refcodes.observer
-
An
GenericMetaDataEvent
provides Meta-Data describing theGenericActionEvent
in more detail and a source being the origin of theGenericMetaDataEvent
. - GenericPayloadEvent<P,SRC> - Interface in org.refcodes.observer
-
The
GenericPayloadEvent
represents anEvent
which carries an additional payload accessible viaPayloadAccessor.getPayload()
. - GenericPayloadMetaDataEvent<P,EM extends EventMetaData,SRC> - Interface in org.refcodes.observer
-
An
GenericPayloadMetaDataEvent
provides Meta-Data describing theGenericPayloadMetaDataEvent
in more detail and a payload. - getAction() - Method in class org.refcodes.observer.AbstractActionEvent
- getAlias() - Method in class org.refcodes.observer.AbstractActionMetaDataEvent.AbstractActionMetaDataEventBuilder
- getAlias() - Method in class org.refcodes.observer.EventMetaDataBuilderImpl
- getAlias() - Method in class org.refcodes.observer.EventMetaDataImpl
- getChannel() - Method in class org.refcodes.observer.AbstractActionMetaDataEvent.AbstractActionMetaDataEventBuilder
- getChannel() - Method in class org.refcodes.observer.EventMetaDataBuilderImpl
- getChannel() - Method in class org.refcodes.observer.EventMetaDataImpl
- getEventMatcher() - Method in interface org.refcodes.observer.ObserverDescriptor
-
Returns the
EventMatcher
associated with the givenObserver
. - getEventMatcher() - Method in class org.refcodes.observer.ObserverDescriptorImpl
-
Returns the
EventMatcher
associated with the givenObserver
. - getGroup() - Method in class org.refcodes.observer.AbstractActionMetaDataEvent.AbstractActionMetaDataEventBuilder
- getGroup() - Method in class org.refcodes.observer.EventMetaDataBuilderImpl
- getGroup() - Method in class org.refcodes.observer.EventMetaDataImpl
- getMetaData() - Method in class org.refcodes.observer.AbstractActionMetaDataEvent
- getMetaData() - Method in class org.refcodes.observer.AbstractMetaDataEvent
- getMetaData() - Method in interface org.refcodes.observer.ActionMetaDataEvent.ActionMetaDataEventBuilder
- getMetaData() - Method in class org.refcodes.observer.ActionMetaDataEventBuilderImpl
- getMetaData() - Method in class org.refcodes.observer.ActionPayloadMetaDataEventBuilderImpl
- getObserver() - Method in interface org.refcodes.observer.ObserverDescriptor
-
Returns the
Observer
associated with the givenEventMatcher
. - getObserver() - Method in class org.refcodes.observer.ObserverDescriptorImpl
-
Returns the
Observer
associated with the givenEventMatcher
. - getPayload() - Method in class org.refcodes.observer.AbstractActionPayloadEvent
- getPayload() - Method in class org.refcodes.observer.AbstractActionPayloadMetaDataEvent.AbstractActionPayloadMetaDataEventBuilder
- getPayload() - Method in class org.refcodes.observer.AbstractActionPayloadMetaDataEvent
- getPayload() - Method in class org.refcodes.observer.AbstractPayloadEvent
- getPayload() - Method in class org.refcodes.observer.AbstractPayloadMetaDataEvent
- getPublisherType() - Method in class org.refcodes.observer.AbstractActionMetaDataEvent.AbstractActionMetaDataEventBuilder
-
The least common denominator in event Meta-Data is the type of the publisher which gives a hint on the source of the event.
- getPublisherType() - Method in interface org.refcodes.observer.EventMetaData
-
The least common denominator in event Meta-Data is the type of the publisher which gives a hint on the source of the event.
- getPublisherType() - Method in class org.refcodes.observer.EventMetaDataBuilderImpl
-
The least common denominator in event Meta-Data is the type of the publisher which gives a hint on the source of the event.
- getPublisherType() - Method in class org.refcodes.observer.EventMetaDataImpl
-
The least common denominator in event Meta-Data is the type of the publisher which gives a hint on the source of the event.
- getSource() - Method in class org.refcodes.observer.AbstractEvent
- getThreadPriority() - Method in class org.refcodes.observer.AbstractObservable
-
In case of
ExecutionStrategy.PARALLEL
orExecutionStrategy.JOIN
, the threads' priority is defined by this attribute. - getUniversalId() - Method in class org.refcodes.observer.AbstractActionMetaDataEvent.AbstractActionMetaDataEventBuilder
- getUniversalId() - Method in class org.refcodes.observer.EventMetaDataBuilderImpl
- getUniversalId() - Method in class org.refcodes.observer.EventMetaDataImpl
- groupEqualWith(String) - Static method in class org.refcodes.observer.EventMatcherSugar
-
Factory method to create an "EQUAL WITH" matcher for the given group compared with the group stored in the
EventMetaData
.
H
- hasObserverSubscription(O) - Method in class org.refcodes.observer.AbstractObservable
-
Tests whether the given observer (event listener) has been added to this
Observable
. - hasObserverSubscription(O) - Method in interface org.refcodes.observer.Observable
-
Tests whether the given observer (event listener) has been added to this
Observable
.
I
- isAssignableFrom(Class<?>) - Static method in class org.refcodes.observer.EventMatcherSugar
-
Factory method to create an event matcher by event type.
- isEmpty() - Method in class org.refcodes.observer.AbstractObservable
-
Determines whether there are observers being registered.
- isMatching(E) - Method in interface org.refcodes.observer.EventMatcher
-
Tests whether the given
GenericActionEvent
is matching theMatcher
's criteria. - isMatching(E) - Method in interface org.refcodes.observer.MetaDataEventMatcher
-
Tests whether the given event is matching the mathcer's criteria.
- isObserversActive() - Method in class org.refcodes.observer.AbstractObservable
- isObserversActive() - Method in interface org.refcodes.observer.Observers
-
Returns true when all
Observer
instances are theoretically active (the instance may also decide by itself), else false.
M
- MetaDataEvent - Interface in org.refcodes.observer
- MetaDataEventImpl - Class in org.refcodes.observer
-
Basic implementation of the
Event
interface. - MetaDataEventImpl(Object) - Constructor for class org.refcodes.observer.MetaDataEventImpl
-
Constructs an event with the given Meta-Data.
- MetaDataEventImpl(String, Object) - Constructor for class org.refcodes.observer.MetaDataEventImpl
-
Constructs an event with the given Meta-Data.
- MetaDataEventImpl(EventMetaData, Object) - Constructor for class org.refcodes.observer.MetaDataEventImpl
-
Constructs an event with the given Meta-Data.
- MetaDataEventMatcher<E extends GenericMetaDataEvent<?,?>> - Interface in org.refcodes.observer
-
This interface typifies the
Matcher
interface for the usage withGenericMetaDataEvent
instances.
N
- nameEqualWith(String) - Static method in class org.refcodes.observer.EventMatcherSugar
-
Factory method to create an "EQUAL WITH" matcher for the given name compared with the name stored in the
EventMetaData
.
O
- Observable<O> - Interface in org.refcodes.observer
-
The
Observable
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<?>> - Interface in org.refcodes.observer
-
An
ObservableObserver
is an observer, observing an observable. - Observer<E extends GenericEvent<?>> - Interface in org.refcodes.observer
-
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>> - Interface in org.refcodes.observer
-
This
ObserverDescriptor
describes theObserver
, i.e. in some cases anObserver
requires anEventMatcher
which determines whichGenericActionEvent
instances to pass to theObserver
. - ObserverDescriptorImpl<E extends GenericEvent<?>,O extends Observer<E>,EM extends EventMatcher<E>> - Class in org.refcodes.observer
-
As a descriptor describes something fixed, this class is immutable in the sense that there are no setters for the attributes.
- ObserverDescriptorImpl(O, EM) - Constructor for class org.refcodes.observer.ObserverDescriptorImpl
-
Constructs the event listener descriptor with the given event listener and the given event matcher.
- observers() - Method in class org.refcodes.observer.AbstractObservable
- observers() - Method in interface org.refcodes.observer.Observers
-
Returns an
Iterator
with the registered observers. - Observers<O,B extends Observers<O,B>> - Interface in org.refcodes.observer
-
Provides methods to manage all subscribed
Observer
instances as a whole and is intended as an extension of theObservable
interface. - onEvent(E) - Method in interface org.refcodes.observer.Observer
-
The listener implementing this interface is notified of an event via this method.
- onEvent(E) - Method in class org.refcodes.observer.ObserverDescriptorImpl
-
The listener implementing this interface is notified of an event via this method.
- onSubscribe(SubscribeEvent<O>) - Method in interface org.refcodes.observer.ObservableObserver
-
This method is called when information about an Observable which was previously requested using an asynchronous interface becomes available.
- onUnsubscribe(UnsubscribeEvent<O>) - Method in interface org.refcodes.observer.ObservableObserver
-
This method is called when information about an Observable which was previously requested using an asynchronous interface becomes available.
- or(EventMatcher<E>...) - Static method in class org.refcodes.observer.EventMatcherSugar
-
Factory method to create an "OR" matcher for the given matchers.
- org.refcodes.observer - package org.refcodes.observer
-
This package provides types supporting the Observable-Pattern.
P
- PayloadEvent<P> - Interface in org.refcodes.observer
-
The
PayloadEvent
represents anEvent
which carries an additional payload accessible viaPayloadAccessor.getPayload()
. - PayloadEventImpl<P> - Class in org.refcodes.observer
-
Basic implementation of the
PayloadEvent
interface. - PayloadEventImpl(P, Object) - Constructor for class org.refcodes.observer.PayloadEventImpl
-
Constructs an event with the given source.
- PayloadMetaDataEvent<P> - Interface in org.refcodes.observer
-
An
PayloadMetaDataEvent
provides Meta-Data describing theGenericPayloadMetaDataEvent
in more detail and a payload. - PayloadMetaDataEventImpl<P> - Class in org.refcodes.observer
-
Basic implementation of the
PayloadMetaDataEvent
interface. - PayloadMetaDataEventImpl(P, EventMetaData, Object) - Constructor for class org.refcodes.observer.PayloadMetaDataEventImpl
-
Constructs an event with the given Meta-Data and payload.
- Publisher<E extends GenericEvent<?>> - Interface in org.refcodes.observer
-
A system publishing
GenericActionEvent
instances (such as an event bus), may implement this interface. - publisherIsAssignableFrom(Class<? extends PT>) - Static method in class org.refcodes.observer.EventMatcherSugar
-
Factory method to create an event matcher by event publisher type.
- publishEvent(E) - Method in interface org.refcodes.observer.Publisher
-
The listener implementing this interface is notified of an event via this method.
S
- setAction(A) - Method in class org.refcodes.observer.AbstractActionMetaDataEvent.AbstractActionMetaDataEventBuilder
- setAlias(String) - Method in class org.refcodes.observer.ActionMetaDataEventBuilderImpl
- setAlias(String) - Method in class org.refcodes.observer.ActionPayloadMetaDataEventBuilderImpl
- setAlias(String) - Method in class org.refcodes.observer.EventMetaDataBuilderImpl
- setChannel(String) - Method in class org.refcodes.observer.ActionMetaDataEventBuilderImpl
- setChannel(String) - Method in class org.refcodes.observer.ActionPayloadMetaDataEventBuilderImpl
- setChannel(String) - Method in class org.refcodes.observer.EventMetaDataBuilderImpl
- setGroup(String) - Method in class org.refcodes.observer.ActionMetaDataEventBuilderImpl
- setGroup(String) - Method in class org.refcodes.observer.ActionPayloadMetaDataEventBuilderImpl
- setGroup(String) - Method in class org.refcodes.observer.EventMetaDataBuilderImpl
- setMetaData(EventMetaData) - Method in class org.refcodes.observer.ActionMetaDataEventBuilderImpl
- setMetaData(EventMetaData) - Method in class org.refcodes.observer.ActionPayloadMetaDataEventBuilderImpl
- setObserversActive(boolean) - Method in class org.refcodes.observer.AbstractObservable
- setObserversActive(boolean) - Method in interface org.refcodes.observer.Observers
-
Enables or disables all
Observer
instances. - setPayload(P) - Method in class org.refcodes.observer.AbstractActionPayloadMetaDataEvent.AbstractActionPayloadMetaDataEventBuilder
- setPublisherType(Class<?>) - Method in class org.refcodes.observer.ActionMetaDataEventBuilderImpl
-
The least common denominator in event Meta-Data is the type of the publisher which gives a hint on the source of the event.
- setPublisherType(Class<?>) - Method in class org.refcodes.observer.ActionPayloadMetaDataEventBuilderImpl
-
The least common denominator in event Meta-Data is the type of the publisher which gives a hint on the source of the event.
- setPublisherType(Class<?>) - Method in interface org.refcodes.observer.EventMetaData.EventMetaDataBuilder
-
The least common denominator in event Meta-Data is the type of the publisher which gives a hint on the source of the event.
- setPublisherType(Class<?>) - Method in class org.refcodes.observer.EventMetaDataBuilderImpl
-
The least common denominator in event Meta-Data is the type of the publisher which gives a hint on the source of the event.
- setThreadPriority(int) - Method in class org.refcodes.observer.AbstractObservable
-
In case of
ExecutionStrategy.PARALLEL
orExecutionStrategy.JOIN
, the threads' priority is defined by this attribute. - setUniversalId(String) - Method in class org.refcodes.observer.ActionMetaDataEventBuilderImpl
- setUniversalId(String) - Method in class org.refcodes.observer.ActionPayloadMetaDataEventBuilderImpl
- setUniversalId(String) - Method in class org.refcodes.observer.EventMetaDataBuilderImpl
- size() - Method in class org.refcodes.observer.AbstractObservable
-
Determines the number of observers being registered.
- SubscribeEvent<O extends Observable<?>> - Interface in org.refcodes.observer
-
An
SubscribeEvent
is published by anObservable
when an observer is being subscribed. - SubscribeEventImpl<O extends Observable<?>> - Class in org.refcodes.observer
-
The Class SubscribeEventImpl.
- SubscribeEventImpl(O) - Constructor for class org.refcodes.observer.SubscribeEventImpl
-
Instantiates a new subscribe event.
- subscribeObserver(O) - Method in class org.refcodes.observer.AbstractObservable
-
Adds the given observer (event listener).
- subscribeObserver(O) - Method in interface org.refcodes.observer.Observable
-
Adds the given observer (event listener).
T
- toString() - Method in class org.refcodes.observer.AbstractActionMetaDataEvent
- toString() - Method in class org.refcodes.observer.AbstractMetaDataEvent
- toString() - Method in class org.refcodes.observer.EventMetaDataImpl
U
- universalIdEqualWith(String) - Static method in class org.refcodes.observer.EventMatcherSugar
-
Factory method to create an "EQUAL WITH" matcher for the given UID compared with the UID stored in the
EventMetaData
. - UnsubscribeEvent<O extends Observable<?>> - Interface in org.refcodes.observer
-
An
UnsubscribeEvent
is published by anObservable
when an observer is being unsubscribed. - UnsubscribeEventImpl<O extends Observable<?>> - Class in org.refcodes.observer
-
The Class UnsubscribeEventImpl.
- UnsubscribeEventImpl(O) - Constructor for class org.refcodes.observer.UnsubscribeEventImpl
-
Instantiates a new unsubscribe event.
- unsubscribeObserver(O) - Method in class org.refcodes.observer.AbstractObservable
-
Removes the observer (event listener).
- unsubscribeObserver(O) - Method in interface org.refcodes.observer.Observable
-
Removes the observer (event listener).
W
- withAction(A) - Method in interface org.refcodes.observer.GenericActionMetaDataEvent.GenericActionMetaDataEventBuilder
- withAction(Enum<?>) - Method in interface org.refcodes.observer.ActionPayloadMetaDataEvent.ActionPayloadMetaDataEventBuilder
- withAlias(String) - Method in interface org.refcodes.observer.ActionPayloadMetaDataEvent.ActionPayloadMetaDataEventBuilder
- withAlias(String) - Method in interface org.refcodes.observer.EventMetaData.EventMetaDataBuilder
- withAlias(String) - Method in interface org.refcodes.observer.GenericActionMetaDataEvent.GenericActionMetaDataEventBuilder
- withChannel(String) - Method in interface org.refcodes.observer.ActionPayloadMetaDataEvent.ActionPayloadMetaDataEventBuilder
- withChannel(String) - Method in interface org.refcodes.observer.EventMetaData.EventMetaDataBuilder
- withChannel(String) - Method in interface org.refcodes.observer.GenericActionMetaDataEvent.GenericActionMetaDataEventBuilder
- withDisableObservers() - Method in interface org.refcodes.observer.Observers
-
Builder method for the
Observers.disableObservers()
operation. - withEnableObservers() - Method in interface org.refcodes.observer.Observers
-
Builder method for the
Observers.enableObservers()
operation. - withGroup(String) - Method in interface org.refcodes.observer.ActionPayloadMetaDataEvent.ActionPayloadMetaDataEventBuilder
- withGroup(String) - Method in interface org.refcodes.observer.EventMetaData.EventMetaDataBuilder
- withGroup(String) - Method in interface org.refcodes.observer.GenericActionMetaDataEvent.GenericActionMetaDataEventBuilder
- withMetaData(EM) - Method in interface org.refcodes.observer.GenericActionMetaDataEvent.GenericActionMetaDataEventBuilder
- withMetaData(EventMetaData) - Method in interface org.refcodes.observer.ActionPayloadMetaDataEvent.ActionPayloadMetaDataEventBuilder
- withObserversActive(boolean) - Method in interface org.refcodes.observer.Observers
-
Builder method for the
Observers.setObserversActive(boolean)
operation. - withPayload(P) - Method in interface org.refcodes.observer.ActionPayloadMetaDataEvent.ActionPayloadMetaDataEventBuilder
- withPublisherType(Class<?>) - Method in interface org.refcodes.observer.ActionPayloadMetaDataEvent.ActionPayloadMetaDataEventBuilder
-
The least common denominator in event Meta-Data is the type of the publisher which gives a hint on the source of the event.
- withPublisherType(Class<?>) - Method in interface org.refcodes.observer.EventMetaData.EventMetaDataBuilder
-
The least common denominator in event Meta-Data is the type of the publisher which gives a hint on the source of the event.
- withPublisherType(Class<?>) - Method in interface org.refcodes.observer.GenericActionMetaDataEvent.GenericActionMetaDataEventBuilder
-
The least common denominator in event Meta-Data is the type of the publisher which gives a hint on the source of the event.
- withUniversalId(String) - Method in interface org.refcodes.observer.ActionPayloadMetaDataEvent.ActionPayloadMetaDataEventBuilder
- withUniversalId(String) - Method in interface org.refcodes.observer.EventMetaData.EventMetaDataBuilder
- withUniversalId(String) - Method in interface org.refcodes.observer.GenericActionMetaDataEvent.GenericActionMetaDataEventBuilder
_
- _action - Variable in class org.refcodes.observer.AbstractActionEvent
- _alias - Variable in class org.refcodes.observer.EventMetaDataImpl
- _channel - Variable in class org.refcodes.observer.EventMetaDataImpl
- _eventMetaData - Variable in class org.refcodes.observer.AbstractActionMetaDataEvent
- _eventMetaData - Variable in class org.refcodes.observer.AbstractMetaDataEvent
- _group - Variable in class org.refcodes.observer.EventMetaDataImpl
- _payload - Variable in class org.refcodes.observer.AbstractActionPayloadEvent
- _payload - Variable in class org.refcodes.observer.AbstractPayloadMetaDataEvent
- _publisherType - Variable in class org.refcodes.observer.EventMetaDataImpl
- _uid - Variable in class org.refcodes.observer.EventMetaDataImpl