org.tools4j.nobark.loop

Class ShutdownableThread

java.lang.Object

org.tools4j.nobark.loop.ShutdownableThread

All Implemented Interfaces:

Shutdownable

public class ShutdownableThread
extends java.lang.Object
implements Shutdownable

A thread that performs a main runnable in a new thread and another shutdown runnable the graceful shutdown() phase of the thread. The thread is started immediately upon construction.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	ShutdownableThread(java.util.function.Function<java.util.function.BooleanSupplier,java.lang.Runnable> mainRunnableFactory, java.util.function.Function<java.util.function.BooleanSupplier,java.lang.Runnable> shutdownRunnableFactory, java.util.concurrent.ThreadFactory threadFactory) Constructor for shutdownable thread; it is recommended to use the static start(..) methods instead.

Method Summary

Modifier and Type	Method and Description
boolean	awaitTermination(long timeout, java.util.concurrent.TimeUnit unit) Blocks until all tasks have completed execution after a shutdown request, or the timeout occurs, whichever happens first.
boolean	isShutdown() Returns true if this service has been shut down.
boolean	isTerminated() Returns true if this service has terminated following shut down.
void	shutdown() Initiates an orderly shutdown in which the service will be continue to perform its duties as long as there is work to be done.
void	shutdownNow() Initiates an immediate shutdown in which the service will stop even if there is more work to be done.
static ShutdownableThread	start(java.util.function.Function<java.util.function.BooleanSupplier,java.lang.Runnable> mainRunnableFactory, java.util.function.Function<java.util.function.BooleanSupplier,java.lang.Runnable> shutdownRunnableFactory, java.util.concurrent.ThreadFactory threadFactory) Creates, starts and returns a new shutdownable thread.
java.lang.String	toString() Returns the name of the thread that was created with the thread factory passed to the constructor.

Methods inherited from class java.lang.Object

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

Constructor Detail

ShutdownableThread

protected ShutdownableThread(java.util.function.Function<java.util.function.BooleanSupplier,java.lang.Runnable> mainRunnableFactory,
                             java.util.function.Function<java.util.function.BooleanSupplier,java.lang.Runnable> shutdownRunnableFactory,
                             java.util.concurrent.ThreadFactory threadFactory)

Constructor for shutdownable thread; it is recommended to use the static start(..) methods instead.

Parameters:

mainRunnableFactory - the factory for the main runnable; the isRunning() condition is passed to the factory as lambda

shutdownRunnableFactory - the factory for the shutdown phase runnable; the isShutdownRunning() condition is passed to the factory as lambda

threadFactory - the factory to provide the thread

Method Detail

start

public static ShutdownableThread start(java.util.function.Function<java.util.function.BooleanSupplier,java.lang.Runnable> mainRunnableFactory,
                                       java.util.function.Function<java.util.function.BooleanSupplier,java.lang.Runnable> shutdownRunnableFactory,
                                       java.util.concurrent.ThreadFactory threadFactory)

Creates, starts and returns a new shutdownable thread.

Parameters:

mainRunnableFactory - the factory for the main runnable; the isRunning() condition is passed to the factory as lambda

shutdownRunnableFactory - the factory for the shutdown phase runnable; the isShutdownRunning() condition is passed to the factory as lambda

threadFactory - the factory to provide the thread

Returns:

the newly created and started shutdownable thread

shutdown

public void shutdown()

Description copied from interface: Shutdownable

Initiates an orderly shutdown in which the service will be continue to perform its duties as long as there is work to be done. For instance for a sequence of steps, the service could continue to invoke the steps' perform() methods until all invocations yield false (indicating that no work was done).

This method does not wait for for termination; use awaitTermination to do that.

Invocation has no additional effect if already shut down.

Specified by:

shutdown in interface Shutdownable

shutdownNow

public void shutdownNow()

Description copied from interface: Shutdownable

Initiates an immediate shutdown in which the service will stop even if there is more work to be done. For instance for a sequence of steps, the service could abort invocation of the steps' perform() irrespective of prior invocation results.

This method does not wait for for termination; use awaitTermination to do that.

Invocation has no additional effect if already shut down.

Specified by:

shutdownNow in interface Shutdownable

isShutdown

public boolean isShutdown()

Description copied from interface: Shutdownable

Returns true if this service has been shut down.

Specified by:

isShutdown in interface Shutdownable

Returns:

true if this service has been shut down

isTerminated

public boolean isTerminated()

Description copied from interface: Shutdownable

Returns true if this service has terminated following shut down. Note that isTerminated is never true unless either shutdown or shutdownNow was called first.

Specified by:

isTerminated in interface Shutdownable

Returns:

true if the service has terminated following shut down

awaitTermination

public boolean awaitTermination(long timeout,
                                java.util.concurrent.TimeUnit unit)

Description copied from interface: Shutdownable

Blocks until all tasks have completed execution after a shutdown request, or the timeout occurs, whichever happens first.

Specified by:

awaitTermination in interface Shutdownable

Parameters:

timeout - the maximum time to wait

unit - the time unit of the timeout argument

Returns:

true if this executor terminated and false if the timeout elapsed before termination

toString

public java.lang.String toString()

Returns the name of the thread that was created with the thread factory passed to the constructor.

Overrides:

toString in class java.lang.Object

Returns:

the service thread's name

See Also:

Thread.getName()