hu.akarnokd.reactive4java.util

Class DefaultRunnable

java.lang.Object

hu.akarnokd.reactive4java.util.DefaultRunnable

All Implemented Interfaces:

java.lang.Runnable

Direct Known Subclasses:

Delay.DelayedObservation

public abstract class DefaultRunnable
extends java.lang.Object
implements java.lang.Runnable

A default runnable implementation which may use an internal or external lock to synchronize access to its alternative onRun method. FIXME might need an option to share a completed flag?!

Field Summary

Fields

Modifier and Type	Field and Description
protected java.util.concurrent.locks.Lock	lock The lock protecting the runnable.

Constructor Summary

Constructors

Constructor and Description
DefaultRunnable() Creates a new instance with a fair reentrant lock.
DefaultRunnable(java.util.concurrent.locks.Lock lock) Creates a new instance with the supplied lock.

Method Summary

Modifier and Type	Method and Description
protected void	cancel() An internal cancel method which ensures that if this runnable is within a periodic schedule, it won't execute the next time.
boolean	cancelled()
protected abstract void	onRun() The alternative run method, which will be called by the original run() method under lock.
void	run()

Methods inherited from class java.lang.Object

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

Field Detail

lock

protected final java.util.concurrent.locks.Lock lock

The lock protecting the runnable.

Constructor Detail

DefaultRunnable

public DefaultRunnable()

Creates a new instance with a fair reentrant lock.

DefaultRunnable

public DefaultRunnable(@Nonnull
                       java.util.concurrent.locks.Lock lock)

Creates a new instance with the supplied lock.

Parameters:

lock - the lock object

Method Detail

run

public final void run()

Specified by:

run in interface java.lang.Runnable

cancelled

public boolean cancelled()

Returns:

returns the current thread's interrupted state, which indicate a cancel request from an outside source.

cancel

protected void cancel()

An internal cancel method which ensures that if this runnable is within a periodic schedule, it won't execute the next time.

Note that this method throws a CancellationException which, when propagated back to the scheduler pool, will disable the wrapper task. Therefore, ensure that you do not accidentally catch this exception by a catch (Throwable ex) clause.

onRun

protected abstract void onRun()

The alternative run method, which will be called by the original run() method under lock.