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

A

AbstractActionEvent<A,SRC> - Class in org.refcodes.observer.impls

AbstractActionEvent(SRC) - Constructor for class org.refcodes.observer.impls.AbstractActionEvent

Constructs an event with the given source.

AbstractActionEvent(A, SRC) - Constructor for class org.refcodes.observer.impls.AbstractActionEvent

Constructs an event with the given source.

AbstractEvent<SRC> - Class in org.refcodes.observer.impls

AbstractEvent(SRC) - Constructor for class org.refcodes.observer.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.EventMatcherSugar

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

ActionEvent<A,SRC> - Interface in org.refcodes.observer

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

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

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

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

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(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(String) - 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(String, 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.

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(String, 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(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).

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

Returns the Action associated to the given ActionEvent.

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

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

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

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

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

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

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

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

Returns the Observer associated with the given EventMatcher

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

getSource() - Method in class org.refcodes.observer.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.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.impls.AbstractObservable

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

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

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

Tests whether the given ActionEvent 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

MetaDataActionEvent<A,SRC> - Interface in org.refcodes.observer

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

MetaDataActionEventImpl<A,SRC> - Class in org.refcodes.observer.impls

Ready to use ActionEvent storing a defined set of EventMetaData.

MetaDataActionEventImpl(EventMetaData, SRC) - Constructor for class org.refcodes.observer.impls.MetaDataActionEventImpl

Constructs an event with the given meta Data.

MetaDataActionEventImpl(String, SRC) - Constructor for class org.refcodes.observer.impls.MetaDataActionEventImpl

Constructs an event with the given meta Data.

MetaDataActionEventImpl(EventMetaData, A, SRC) - Constructor for class org.refcodes.observer.impls.MetaDataActionEventImpl

Constructs an event with the given meta Data.

MetaDataActionEventImpl(A, SRC) - Constructor for class org.refcodes.observer.impls.MetaDataActionEventImpl

Constructs an event with the given meta Data.

MetaDataActionEventImpl(SRC) - Constructor for class org.refcodes.observer.impls.MetaDataActionEventImpl

Constructs an event with the given meta Data.

MetaDataEvent<SRC> - Interface in org.refcodes.observer

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

MetaDataEventImpl<SRC> - Class in org.refcodes.observer.impls

Ready to use ActionEvent storing a defined set of EventMetaData.

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

Constructs an event with the given meta Data.

MetaDataEventImpl(String, SRC) - Constructor for class org.refcodes.observer.impls.MetaDataEventImpl

Constructs an event with the given meta Data.

MetaDataEventImpl(SRC) - Constructor for class org.refcodes.observer.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.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 by Observer instances (proposal) or any listener interface (custom as of your needs).

ObservableObserver<O extends Observable<?>> - Interface in org.refcodes.observer

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 ActionEvent 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

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

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

onSubscribe(SubscribeEvent<O>) - Method in interface org.refcodes.observer.ObservableObserver

onUnsubscribe(UnsubscribeEvent<O>) - Method in interface org.refcodes.observer.ObservableObserver

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

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

P

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

A system publishing ActionEvent 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

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 Containable.size().

SubscribeEvent<O extends Observable<?>> - Interface in org.refcodes.observer

An SubscribeEvent is published by an Observable when an observer is being subscribed.

SubscribeEventImpl<O extends Observable<?>> - Class in org.refcodes.observer.impls

SubscribeEventImpl(O) - Constructor for class org.refcodes.observer.impls.SubscribeEventImpl

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

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.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 an Observable when an observer is being unsubscribed.

UnsubscribeEventImpl<O extends Observable<?>> - Class in org.refcodes.observer.impls

UnsubscribeEventImpl(O) - Constructor for class org.refcodes.observer.impls.UnsubscribeEventImpl

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

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