org.tools4j.nobark.run

Class StoppableThread

java.lang.Object

org.tools4j.nobark.run.StoppableThread

All Implemented Interfaces:

java.lang.AutoCloseable, Joinable, Stoppable, ThreadLike, ThreadState

public class StoppableThread
extends java.lang.Object
implements ThreadLike

A thread that performs a runnable in a new thread. The thread is started immediately upon construction and it can be stopped via stop or auto-close method.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	StoppableThread(RunnableFactory runnableFactory, java.util.concurrent.ThreadFactory threadFactory) Constructor for stoppable thread; it is recommended to use the static start(..) methods instead.

Method Summary

Modifier and Type	Method and Description
void	join(long millis) Waits at most millis milliseconds for this Joinable to die.
static StoppableThread	start(RunnableFactory runnableFactory, java.util.concurrent.ThreadFactory threadFactory) Creates, starts and returns a new shutdownable thread.
void	stop() Stops the service.
java.lang.Thread.State	threadState() Returns the state of the underlying thread.
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.tools4j.nobark.run.ThreadState

isRunning, isTerminated

Methods inherited from interface org.tools4j.nobark.run.Stoppable

close

Methods inherited from interface org.tools4j.nobark.run.Joinable

join

Constructor Detail

StoppableThread

protected StoppableThread(RunnableFactory runnableFactory,
                          java.util.concurrent.ThreadFactory threadFactory)

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

Parameters:

runnableFactory - the factory for the runnable; the keepRunning() condition is passed to the factory as lambda

threadFactory - the factory to provide the thread

Method Detail

start

public static StoppableThread start(RunnableFactory runnableFactory,
                                    java.util.concurrent.ThreadFactory threadFactory)

Creates, starts and returns a new shutdownable thread.

Parameters:

runnableFactory - the factory for the runnable; the keepRunning() condition is passed to the factory as lambda

threadFactory - the factory to provide the thread

Returns:

the newly created and started stoppable thread

threadState

public java.lang.Thread.State threadState()

Description copied from interface: ThreadState

Returns the state of the underlying thread.

Specified by:

threadState in interface ThreadState

Returns:

the underlying thread's state

See Also:

Thread.getState()

stop

public void stop()

Description copied from interface: Stoppable

Stops the service.

Invocation has no additional effect if already stopped.

Specified by:

stop in interface Stoppable

join

public void join(long millis)

Description copied from interface: Joinable

Waits at most millis milliseconds for this Joinable to die. A timeout of 0 means to wait forever.

Specified by:

join in interface Joinable

Parameters:

millis - the time to wait in milliseconds

See Also:

Thread.join(long)

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object