de.aristaflow.adept2.util.threading

Class LoggingFuture<V>

java.lang.Object

de.aristaflow.adept2.util.threading.LoggingFuture<V>

Type Parameters:

V - The result type returned by this Future's get method.

All Implemented Interfaces:

java.lang.Runnable, java.util.concurrent.Future<V>, java.util.concurrent.RunnableFuture<V>

Direct Known Subclasses:

LoggingScheduledFuture

public class LoggingFuture<V>
extends java.lang.Object
implements java.util.concurrent.RunnableFuture<V>

A future that wraps another future and logs all occurred exceptions and the result for information purpose if no one was interested in it. This is especially useful when using an executor service and ignoring the returned future. If the result (or the exception) of the future is retrieved, no additional logging will take place.

Author:

Ulrich Kreher

Field Summary

Fields

Modifier and Type	Field and Description
protected java.util.logging.Logger	logger The logger for logging unhandled results, Exception, RuntimeException or Error.
protected boolean	resultRelevant Whether the result of the future is relevant and therefore it should be logged if it is not retrieved.

Constructor Summary

Constructors

Constructor and Description
LoggingFuture(java.util.concurrent.RunnableFuture<V> future, boolean resultRelevant, java.util.logging.Logger logger) Creates a new future wrapping the designated RunnableFuture logging the outcome of the future if no one has retrieved it.

Method Summary

Modifier and Type	Method and Description
boolean	cancel(boolean mayInterruptIfRunning)
boolean	equals(java.lang.Object other)
protected void	finalize()
V	get()
V	get(long timeout, java.util.concurrent.TimeUnit unit)
protected java.util.concurrent.RunnableFuture<V>	getWrappedFutureRunnable() Gets the wrapped future runnable.
int	hashCode()
boolean	isCancelled()
boolean	isDone()
void	run()

Methods inherited from class java.lang.Object

clone, getClass, notify, notifyAll, toString, wait, wait, wait

Field Detail

resultRelevant

protected final boolean resultRelevant

Whether the result of the future is relevant and therefore it should be logged if it is not retrieved. Runnables do not have a return value and therefore the result is irrelevant and need not be logged.

logger

protected java.util.logging.Logger logger

The logger for logging unhandled results, Exception, RuntimeException or Error.

Constructor Detail

LoggingFuture

public LoggingFuture(java.util.concurrent.RunnableFuture<V> future,
                     boolean resultRelevant,
                     java.util.logging.Logger logger)

Creates a new future wrapping the designated RunnableFuture logging the outcome of the future if no one has retrieved it.

Parameters:

future - The RunnableFuture which to wrap.

resultRelevant - Whether the result of the future is relevant and therefore it should be logged if it is not retrieved.

logger - The logger for logging unhandled results, Exception, RuntimeException or Error.

Method Detail

finalize

protected void finalize()

Overrides:

finalize in class java.lang.Object

getWrappedFutureRunnable

protected java.util.concurrent.RunnableFuture<V> getWrappedFutureRunnable()

Gets the wrapped future runnable. This is useful for subclasses requiring a more specific object.

Returns:

The wrapped future runnable.

run

public void run()

Specified by:

run in interface java.lang.Runnable

Specified by:

run in interface java.util.concurrent.RunnableFuture<V>

cancel

public boolean cancel(boolean mayInterruptIfRunning)

Specified by:

cancel in interface java.util.concurrent.Future<V>

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

equals

public boolean equals(java.lang.Object other)

Overrides:

equals in class java.lang.Object

isCancelled

public boolean isCancelled()

Specified by:

isCancelled in interface java.util.concurrent.Future<V>

isDone

public boolean isDone()

Specified by:

isDone in interface java.util.concurrent.Future<V>

get

public V get()
      throws java.lang.InterruptedException,
             java.util.concurrent.ExecutionException

Specified by:

get in interface java.util.concurrent.Future<V>

Throws:

java.lang.InterruptedException

java.util.concurrent.ExecutionException

get

public V get(long timeout,
             java.util.concurrent.TimeUnit unit)
      throws java.lang.InterruptedException,
             java.util.concurrent.ExecutionException,
             java.util.concurrent.TimeoutException

Specified by:

get in interface java.util.concurrent.Future<V>

Throws:

java.lang.InterruptedException

java.util.concurrent.ExecutionException

java.util.concurrent.TimeoutException