hu.akarnokd.reactive4java.util

Class OriginalObservableWrapper<T>

java.lang.Object

java.util.Observable

hu.akarnokd.reactive4java.util.OriginalObservableWrapper<T>

Type Parameters:

T - the reactive-observer's type

All Implemented Interfaces:

CloseableObservable<T>, Observable<T>, java.io.Closeable, java.lang.AutoCloseable

public class OriginalObservableWrapper<T>
extends java.util.Observable
implements CloseableObservable<T>

Helper class that wraps a Java Observable and makes its services availabel as java- and reactive- observable. Data incoming through the observer interfaces are routed to the underlying java-observable. The class implements Observable<Object>, therefore reactive-observers can be registered as well.

Since:

0.97

Field Summary

Fields

Modifier and Type	Field and Description
protected Action0E<? extends java.io.IOException>	closeAction The close action.
protected java.util.Observable	observable The observable.

Constructor Summary

Constructors

Constructor and Description
OriginalObservableWrapper(java.util.Observable observable) Wraps the given observable and sets a close action to remove all observers.
OriginalObservableWrapper(java.util.Observable observable, Action0 action) Wraps the given observable which calls the supplied action in case of a close event and unregisters all observables.
OriginalObservableWrapper(java.util.Observable observable, Action0 closeAction, boolean unregisterAll) Wraps the given observable and sets up this observable to call the closeAction on close() and remove all registered observers if unregisterAll is true.
OriginalObservableWrapper(java.util.Observable observable, Action0E<? extends java.io.IOException> action) Wraps the given observable which calls the supplied action in case of a close event and unregisters all observables.
OriginalObservableWrapper(java.util.Observable observable, Action0E<? extends java.io.IOException> closeAction, boolean unregisterAll) Wraps the given observable and sets up this observable to call the closeAction on close() and remove all registered observers if unregisterAll is true.

Method Summary

Modifier and Type	Method and Description
void	addObserver(java.util.Observer o)
void	close()
int	countObservers()
void	deleteObserver(java.util.Observer o)
void	deleteObservers()
boolean	hasChanged()
void	notifyObservers()
void	notifyObservers(java.lang.Object arg)
java.io.Closeable	register(java.util.Observer observer) Registers a java-observer and returns a handle to it.
java.io.Closeable	register(Observer<? super T> observer) Registers an observer for the notification of Ts.

Methods inherited from class java.util.Observable

clearChanged, setChanged

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

observable

@Nonnull
protected final java.util.Observable observable

The observable.

closeAction

@Nonnull
protected final Action0E<? extends java.io.IOException> closeAction

The close action.

Constructor Detail

OriginalObservableWrapper

public OriginalObservableWrapper(@Nonnull
                                 java.util.Observable observable)

Wraps the given observable and sets a close action to remove all observers.

Parameters:

observable - the java-observable to wrap

OriginalObservableWrapper

public OriginalObservableWrapper(@Nonnull
                                 java.util.Observable observable,
                                 @Nonnull
                                 Action0 action)

Wraps the given observable which calls the supplied action in case of a close event and unregisters all observables.

Parameters:

observable - the java-observable to wrap

action - the close action

OriginalObservableWrapper

public OriginalObservableWrapper(@Nonnull
                                 java.util.Observable observable,
                                 @Nonnull
                                 Action0 closeAction,
                                 boolean unregisterAll)

Wraps the given observable and sets up this observable to call the closeAction on close() and remove all registered observers if unregisterAll is true.

Parameters:

observable - the java-observable to wrap

closeAction - the close action

unregisterAll - undegister all observers on close?

OriginalObservableWrapper

public OriginalObservableWrapper(@Nonnull
                                 java.util.Observable observable,
                                 @Nonnull
                                 Action0E<? extends java.io.IOException> action)

Wraps the given observable which calls the supplied action in case of a close event and unregisters all observables.

Parameters:

observable - the java-observable to wrap

action - the close action

OriginalObservableWrapper

public OriginalObservableWrapper(@Nonnull
                                 java.util.Observable observable,
                                 @Nonnull
                                 Action0E<? extends java.io.IOException> closeAction,
                                 boolean unregisterAll)

Wraps the given observable and sets up this observable to call the closeAction on close() and remove all registered observers if unregisterAll is true.

Parameters:

observable - the java-observable to wrap

closeAction - the close action

unregisterAll - undegister all observers on close?

Method Detail

addObserver

public void addObserver(java.util.Observer o)

Overrides:

addObserver in class java.util.Observable

deleteObserver

public void deleteObserver(java.util.Observer o)

Overrides:

deleteObserver in class java.util.Observable

deleteObservers

public void deleteObservers()

Overrides:

deleteObservers in class java.util.Observable

countObservers

public int countObservers()

Overrides:

countObservers in class java.util.Observable

notifyObservers

public void notifyObservers()

Overrides:

notifyObservers in class java.util.Observable

notifyObservers

public void notifyObservers(java.lang.Object arg)

Overrides:

notifyObservers in class java.util.Observable

hasChanged

public boolean hasChanged()

Overrides:

hasChanged in class java.util.Observable

register

@Nonnull
public java.io.Closeable register(@Nonnull
                                            java.util.Observer observer)

Registers a java-observer and returns a handle to it. The observer can be unregistered via this handle or the regular deleteObserver().

The convenience method is to have symmetric means for both observer kinds to interact with this observable.

Parameters:

observer - the observer to register

Returns:

the unregistration handle

close

public void close()
           throws java.io.IOException

Specified by:

close in interface java.io.Closeable

Specified by:

close in interface java.lang.AutoCloseable

Throws:

java.io.IOException

register

@Nonnull
public java.io.Closeable register(@Nonnull
                                            Observer<? super T> observer)

Description copied from interface: Observable

Registers an observer for the notification of Ts.

Specified by:

register in interface Observable<T>

Parameters:

observer - the observer of Ts or any supertype of it

Returns:

the way of deregister the observer from this provider