A C D E F G H I M N O P S U

A

AbstractEvent - Class in org.refcodes.observer.events.impls

AbstractEvent(Object) - Constructor for class org.refcodes.observer.events.impls.AbstractEvent

Constructs an event with the given source.

AbstractEvent(A, Object) - Constructor for class org.refcodes.observer.events.impls.AbstractEvent

Constructs an event with the given source.

AbstractObservable<O,EV> - Class in org.refcodes.observer.impls

This abstract class provides functionality to implement default refcodes Observable behavior.

AbstractObservable() - Constructor for class org.refcodes.observer.impls.AbstractObservable

Constructs the AbstractObservable with a default ExecutorService pool.

AbstractObservable(ExecutorService) - Constructor for class org.refcodes.observer.impls.AbstractObservable

Constructs the AbstractObservable with a provided ExecutorService pool.

actionEqualWith(A) - Static method in class org.refcodes.observer.statics.EventMatcherByDeclaration

Factory method to create an "EQUAL WITH" matcher for the given action compared with the action stored in the EventMetaData.

and(EventMatcher<E>...) - Static method in class org.refcodes.observer.statics.EventMatcherByDeclaration

Factory method to create an "AND" matcher for the given matchers.

C

clear() - Method in class org.refcodes.observer.impls.AbstractObservable

Clears all observers from this AbstractObservable.

D

dispose() - Method in class org.refcodes.observer.impls.AbstractObservable

doHandleEventListenerException(Exception, O, EV, ExecutionStrategy) - Method in class org.refcodes.observer.impls.AbstractObservable

This hook method allows you to handle any exceptions being thrown by an event listener whilst invoking a given event.

E

Event - Interface in org.refcodes.observer.events

An Event is published by an Observable and is consumed by zero to many Observer instances.

EventMatcher<E extends Event> - Interface in org.refcodes.observer

This interface typifies the Matcher interface for the usage with Event instances.

EventMatcherByDeclaration - Class in org.refcodes.observer.statics

EventMatcherByDeclaration() - Constructor for class org.refcodes.observer.statics.EventMatcherByDeclaration

EventMetaData - Interface in org.refcodes.observer.events

The meta data describes the event which a publisher posts via the event bus to an event subscriber's event listener.

EventMetaDataImpl - Class in org.refcodes.observer.impls

Straight forward implementation of the minimal EventMetaData interface.

EventMetaDataImpl() - Constructor for class org.refcodes.observer.impls.EventMetaDataImpl

Constructs an instance of the EventMetaData with predefined values for the according properties retrieved from the caller's class.

EventMetaDataImpl(StackTraceElement) - Constructor for class org.refcodes.observer.impls.EventMetaDataImpl

Constructs an instance of the EventMetaData with predefined values for the according properties retrieved from the caller's class (retrieved from the StackTraceElement; the assumed caller relative to the stack trace element and not this instance is taken).

EventMetaDataImpl(Class<?>) - Constructor for class org.refcodes.observer.impls.EventMetaDataImpl

Constructs an instance of the EventMetaData with predefined values for the according properties retrieved from the caller's class.

EventMetaDataImpl(StackTraceElement, Class<?>) - Constructor for class org.refcodes.observer.impls.EventMetaDataImpl

Constructs an instance of the EventMetaData with predefined values for the according properties retrieved from the caller's class (retrieved from the StackTraceElement; the assumed caller relative to the stack trace element and not this instance is taken).

EventMetaDataImpl(String, String, String, Class<?>) - Constructor for class org.refcodes.observer.impls.EventMetaDataImpl

Constructs an instance of the EventMetaData with the given values for the according properties.

F

fireEvent(EV, ExecutionStrategy) - Method in class org.refcodes.observer.impls.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.impls.AbstractObservable

This hook method is to be implemented by the implementing class.

G

getAction() - Method in interface org.refcodes.observer.events.Event

Returns the Action associated to the given Event

getAction() - Method in class org.refcodes.observer.events.impls.AbstractEvent

Returns the Action associated to the given Event

getEventMatcher() - Method in class org.refcodes.observer.impls.ObserverDescriptorImpl

Returns the EventMatcher associated with the given Observer.

getEventMatcher() - Method in interface org.refcodes.observer.ObserverDescriptor

Returns the EventMatcher associated with the given Observer.

getGroup() - Method in class org.refcodes.observer.impls.EventMetaDataImpl

getMetaData() - Method in class org.refcodes.observer.events.impls.MetaDataEventImpl

getName() - Method in class org.refcodes.observer.impls.EventMetaDataImpl

getObserver() - Method in class org.refcodes.observer.impls.ObserverDescriptorImpl

Returns the Observer associated with the given EventMatcher

getObserver() - Method in interface org.refcodes.observer.ObserverDescriptor

Returns the Observer associated with the given EventMatcher

getPublisherType() - Method in interface org.refcodes.observer.events.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.impls.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.events.impls.AbstractEvent

getThreadPriority() - Method in class org.refcodes.observer.impls.AbstractObservable

In case of ExecutionStrategy.PARALLEL or ExecutionStrategy.JOIN, the threads' priority is defined by this attribute.

getUniversalId() - Method in class org.refcodes.observer.impls.EventMetaDataImpl

groupEqualWith(String) - Static method in class org.refcodes.observer.statics.EventMatcherByDeclaration

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.impls.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.statics.EventMatcherByDeclaration

Factory method to create an event matcher by event type.

isEmpty() - Method in class org.refcodes.observer.impls.AbstractObservable

Determines whether there are observers being registered, similar to CollectionMetaData.isEmpty().

isMatching(E) - Method in interface org.refcodes.observer.EventMatcher

Tests whether the given Event is matching the Matcher's criteria.

isMatching(E) - Method in interface org.refcodes.observer.MetaDataEventMatcher

Tests whether the given event is matching the mathcer's criteria.

M

MetaDataEvent - Interface in org.refcodes.observer.events

An MetaDataEvent is published by an Observable and is consumed by zero to many Observer instances.

MetaDataEventImpl - Class in org.refcodes.observer.events.impls

Ready to use Event storing a defined set of EventMetaData. ----------------------------------------------------------------------------- TIPP: In order to distinguish MetaDataEventImpl instances from each other, create an actions enumeration, enumerating the various event actions you support.

MetaDataEventImpl(EventMetaData, Object) - Constructor for class org.refcodes.observer.events.impls.MetaDataEventImpl

Constructs an event with the given meta Data.

MetaDataEventImpl(EventMetaData, A, Object) - Constructor for class org.refcodes.observer.events.impls.MetaDataEventImpl

Constructs an event with the given meta Data.

MetaDataEventImpl(A, Object) - Constructor for class org.refcodes.observer.events.impls.MetaDataEventImpl

Constructs an event with the given meta Data.

MetaDataEventImpl(Object) - Constructor for class org.refcodes.observer.events.impls.MetaDataEventImpl

Constructs an event with the given meta Data.

MetaDataEventMatcher<E extends MetaDataEvent> - Interface in org.refcodes.observer

This interface typifies the Matcher interface for the usage with MetaDataEvent instances.

N

nameEqualWith(String) - Static method in class org.refcodes.observer.statics.EventMatcherByDeclaration

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 by Observer instances (proposal) or any listener interface (custom as of your needs).

Observer<E extends Event> - Interface in org.refcodes.observer

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>> - Interface in org.refcodes.observer

This ObserverDescriptor describes the Observer, i.e. in some cases an Observer requires an EventMatcher which determines which Event instances to pass to the Observer.

ObserverDescriptorImpl<E extends Event,O extends Observer<E>,EM extends EventMatcher<E>> - Class in org.refcodes.observer.impls

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.impls.ObserverDescriptorImpl

Constructs the event listener descriptor with the given event listener and the given event matcher.

onEvent(E) - Method in class org.refcodes.observer.impls.ObserverDescriptorImpl

The listener implementing this interface is notified of an event via this method.

onEvent(E) - Method in interface org.refcodes.observer.Observer

The listener implementing this interface is notified of an event via this method.

or(EventMatcher<E>...) - Static method in class org.refcodes.observer.statics.EventMatcherByDeclaration

Factory method to create an "OR" matcher for the given matchers.

org.refcodes.observer - package org.refcodes.observer

org.refcodes.observer.events - package org.refcodes.observer.events

org.refcodes.observer.events.impls - package org.refcodes.observer.events.impls

org.refcodes.observer.impls - package org.refcodes.observer.impls

org.refcodes.observer.statics - package org.refcodes.observer.statics

P

Publisher<E extends Event> - Interface in org.refcodes.observer

A system publishing Event instances (such as an event bus), may implement this interface.

publisherIsAssignableFrom(Class<? extends PT>) - Static method in class org.refcodes.observer.statics.EventMatcherByDeclaration

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

setThreadPriority(int) - Method in class org.refcodes.observer.impls.AbstractObservable

In case of ExecutionStrategy.PARALLEL or ExecutionStrategy.JOIN, the threads' priority is defined by this attribute.

size() - Method in class org.refcodes.observer.impls.AbstractObservable

Determines the number of observers being registered, similar to CollectionMetaData.size().

subscribeObserver(O) - Method in class org.refcodes.observer.impls.AbstractObservable

Adds the given observer (event listener).

subscribeObserver(O) - Method in interface org.refcodes.observer.Observable

Adds the given observer (event listener).

U

universalIdEqualWith(String) - Static method in class org.refcodes.observer.statics.EventMatcherByDeclaration

Factory method to create an "EQUAL WITH" matcher for the given UID compared with the UID stored in the EventMetaData.

unsubscribeObserver(O) - Method in class org.refcodes.observer.impls.AbstractObservable

Removes the observer (event listener).

unsubscribeObserver(O) - Method in interface org.refcodes.observer.Observable

Removes the observer (event listener).

A C D E F G H I M N O P S U