com.jcabi.log

Class VerboseRunnable

java.lang.Object

com.jcabi.log.VerboseRunnable

All Implemented Interfaces:

Runnable

public final class VerboseRunnable
extends Object
implements Runnable

Wrapper of Runnable, that logs all uncaught runtime exceptions.

You can use it with scheduled executor, for example:

 Executors.newScheduledThreadPool(2).scheduleAtFixedRate(
   new VerboseRunnable(runnable, true), 1L, 1L, TimeUnit.SECONDS
 );

Now, every runtime exception that is not caught inside your Runnable will be reported to log (using Logger). Two-arguments constructor can be used when you need to instruct the class about what to do with the exception: either swallow it or escalate. Sometimes it's very important to swallow exceptions. Otherwise an entire thread may get stuck (like in the example above).

Since version 0.7.16, besides just swallowing exceptions the class also clears the interrupted status. That means that the thread with the runnable can be interrupted but will never expose its interrupted status.

This class is thread-safe.

Since:

0.1.3

Version:

$Id$

Author:

Yegor Bugayenko (yegor@tpc2.com)

See Also:

VerboseThreads

Constructor Summary

Constructors

Constructor and Description
VerboseRunnable(Callable<?> callable) Default constructor, doesn't swallow exceptions.
VerboseRunnable(Callable<?> callable, boolean swallowexceptions) Default constructor, doesn't swallow exceptions.
VerboseRunnable(Callable<?> callable, boolean swallowexceptions, boolean fullstacktrace) Default constructor.
VerboseRunnable(Runnable runnable) Default constructor, doesn't swallow exceptions.
VerboseRunnable(Runnable runnable, boolean swallowexceptions) Default constructor, with configurable behavior for exceptions.
VerboseRunnable(Runnable runnable, boolean swallowexceptions, boolean fullstacktrace) Default constructor, with fully configurable behavior.

Method Summary

Methods

Modifier and Type	Method and Description
void	run()

Methods inherited from class java.lang.Object

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

Constructor Detail

VerboseRunnable

public VerboseRunnable(@NotNull
               Runnable runnable)

Default constructor, doesn't swallow exceptions.

Parameters:

runnable - Runnable to wrap

VerboseRunnable

public VerboseRunnable(@NotNull
               Callable<?> callable)

Default constructor, doesn't swallow exceptions.

Parameters:

callable - Callable to wrap

Since:

0.7.17

VerboseRunnable

public VerboseRunnable(@NotNull
               Callable<?> callable,
               boolean swallowexceptions)

Default constructor, doesn't swallow exceptions.

Parameters:

callable - Callable to wrap

swallowexceptions - Shall we swallow exceptions (TRUE) or re-throw (FALSE)? Exception swallowing means that run() will never throw any exceptions (in any case all exceptions are logged using Logger.

Since:

0.1.10

VerboseRunnable

public VerboseRunnable(@NotNull
               Callable<?> callable,
               boolean swallowexceptions,
               boolean fullstacktrace)

Default constructor.

Parameters:

callable - Callable to wrap

swallowexceptions - Shall we swallow exceptions (TRUE) or re-throw (FALSE)? Exception swallowing means that run() will never throw any exceptions (in any case all exceptions are logged using Logger.

fullstacktrace - Shall we report the entire stacktrace of the exception (TRUE) or just its message in one line (FALSE)

Since:

0.7.17

VerboseRunnable

public VerboseRunnable(@NotNull
               Runnable runnable,
               boolean swallowexceptions)

Default constructor, with configurable behavior for exceptions.

Parameters:

runnable - Runnable to wrap

swallowexceptions - Shall we swallow exceptions (TRUE) or re-throw (FALSE)? Exception swallowing means that run() will never throw any exceptions (in any case all exceptions are logged using Logger.

Since:

0.1.4

VerboseRunnable

public VerboseRunnable(@NotNull
               Runnable runnable,
               boolean swallowexceptions,
               boolean fullstacktrace)

Default constructor, with fully configurable behavior.

Parameters:

runnable - Runnable to wrap

swallowexceptions - Shall we swallow exceptions (TRUE) or re-throw (FALSE)? Exception swallowing means that run() will never throw any exceptions (in any case all exceptions are logged using Logger.

fullstacktrace - Shall we report the entire stacktrace of the exception (TRUE) or just its message in one line (FALSE)

Since:

0.7.17

Method Detail

run

public void run()

We catch RuntimeException and Error here. All other types of exceptions are "checked exceptions" and won't be thrown out of Runnable#run() method.

Specified by:

run in interface Runnable