de.weltraumschaf.commons.application

Class ShutDownHook

java.lang.Object

java.lang.Thread

de.weltraumschaf.commons.application.ShutDownHook

All Implemented Interfaces:

Runnable

public class ShutDownHook
extends Thread

Holds callbacks to execute them in any order.

Example:

 final ShutDownHook hook = new ShutDownHook();
 hook.register(new Runnable() {

      @Override
      public void  run() {
          // Your shutdown code.
      }

 });
 

Since:

1.0.0

Author:

Sven Strittmatter <weltraumschaf@googlemail.com>

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Thread

Thread.State, Thread.UncaughtExceptionHandler

Field Summary

Fields

Modifier and Type	Field and Description
private Set<Callable<Void>>	callbacks Set of callbacks.
private static Logger	DEFAULT_LOGGER Default logger for this class.
private Logger	logger Logger instance.

Fields inherited from class java.lang.Thread

MAX_PRIORITY, MIN_PRIORITY, NORM_PRIORITY

Constructor Summary

Constructors

Constructor and Description
ShutDownHook() Initializes logger with DEFAULT_LOGGER.
ShutDownHook(Logger logger) Designated constructor.

Method Summary

Modifier and Type	Method and Description
ShutDownHook	register(Callable<Void> callback) Registers a callback.
ShutDownHook	register(Runnable callback) Registers a callback.
void	run() Iterates over all callbacks and run them.

Methods inherited from class java.lang.Thread

activeCount, checkAccess, clone, countStackFrames, currentThread, destroy, dumpStack, enumerate, getAllStackTraces, getContextClassLoader, getDefaultUncaughtExceptionHandler, getId, getName, getPriority, getStackTrace, getState, getThreadGroup, getUncaughtExceptionHandler, holdsLock, interrupt, interrupted, isAlive, isDaemon, isInterrupted, join, join, join, resume, setContextClassLoader, setDaemon, setDefaultUncaughtExceptionHandler, setName, setPriority, setUncaughtExceptionHandler, sleep, sleep, start, stop, stop, suspend, toString, yield

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_LOGGER

private static final Logger DEFAULT_LOGGER

Default logger for this class.

callbacks

private final Set<Callable<Void>> callbacks

Set of callbacks.

logger

private final Logger logger

Logger instance.

Constructor Detail

ShutDownHook

public ShutDownHook()

Initializes logger with DEFAULT_LOGGER.

ShutDownHook

public ShutDownHook(Logger logger)

Designated constructor.

Parameters:

logger - Logger to use by this class.

Method Detail

run

public void run()

Iterates over all callbacks and run them.

Specified by:

run in interface Runnable

Overrides:

run in class Thread

register

public ShutDownHook register(Runnable callback)

Registers a callback.

Parameters:

callback - must not be null

Returns:

never null, self for chaining

register

public ShutDownHook register(Callable<Void> callback)

Registers a callback.

Parameters:

callback - must not be null

Returns:

never null, self for chaining