org.rvpf.service

Class ServiceThread

Object

Thread

ServiceThread

All Implemented Interfaces:

Runnable

public class ServiceThread
extends Thread

Service thread.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ServiceThread.SilentException Silent exception.
static interface	ServiceThread.Target Target.

Nested classes/interfaces inherited from class Thread

Thread.State, Thread.UncaughtExceptionHandler

Field Summary

Fields inherited from class Thread

MAX_PRIORITY, MIN_PRIORITY, NORM_PRIORITY

Constructor Summary

Constructors

Constructor and Description
ServiceThread(ServiceThread.Target target, String name) Constructs an instance.
ServiceThread(String name) Constructs an instance.

Method Summary

Modifier and Type	Method and Description
void	execute(ServiceThread.Target target) Exeecutes a target.
static void	failed() Called by run() to indicate failure.
Optional<Throwable>	getThrowable() Gets the throwable.
boolean	hasFailed() Asks if this thread has failed.
boolean	interruptAndJoin(Logger logger, long joinTimeout) Interrupts this thread and waits for its death.
boolean	join(Logger logger, long timeout) Waits for the death of this thread.
static void	ready() Called to allow a waiting start(boolean) to complete.
void	run()
void	setLogger(Logger logger) Sets the logger.
void	setQuiet(boolean quiet) Sets the quiet indicator.
void	start()
boolean	start(boolean wait) Starts this thread.
boolean	waitForReady() Waits for a call to ready().
static void	yieldAll() Yields control to other threads, including those of lower priority.

Methods inherited from class 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, stop, stop, suspend, toString, yield

Methods inherited from class Object

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

Constructor Detail

ServiceThread

public ServiceThread(@Nonnull
                     String name)

Constructs an instance.

Parameters:

name - The thread name.

ServiceThread

public ServiceThread(@Nonnull
                     ServiceThread.Target target,
                     @Nonnull
                     String name)

Constructs an instance.

Parameters:

target - The service thread target.

name - The thread name.

Method Detail

failed

public static void failed()

Called by run() to indicate failure.

ready

public static void ready()

Called to allow a waiting start(boolean) to complete.

yieldAll

public static void yieldAll()

Yields control to other threads, including those of lower priority.

execute

public void execute(@Nonnull
                    ServiceThread.Target target)

Exeecutes a target.

Parameters:

target - The target.

getThrowable

@Nonnull
 @CheckReturnValue
public Optional<Throwable> getThrowable()

Gets the throwable.

Returns:

The throwable (may be empty).

hasFailed

@CheckReturnValue
public boolean hasFailed()

Asks if this thread has failed.

Returns:

True if this thread has failed.

interruptAndJoin

@CheckReturnValue
public boolean interruptAndJoin(@Nonnull
                                                   Logger logger,
                                                   long joinTimeout)

Interrupts this thread and waits for its death.

Parameters:

logger - A logger.

joinTimeout - The join timeout in millis (0 means infinite).

Returns:

False on interrupt or timeout (the thread may still be alive).

join

@CheckReturnValue
public boolean join(@Nonnull
                                       Logger logger,
                                       long timeout)

Waits for the death of this thread.

Parameters:

logger - A logger.

timeout - The timeout in millis (0 means infinite).

Returns:

False on interrupt or timeout (the thread may still be alive).

run

public void run()

Specified by:

run in interface Runnable

Overrides:

run in class Thread

setLogger

public void setLogger(@Nonnull
                      Logger logger)

Sets the logger.

Parameters:

logger - The logger.

setQuiet

public void setQuiet(boolean quiet)

Sets the quiet indicator.

Parameters:

quiet - The quiet indicator.

start

public void start()

Overrides:

start in class Thread

start

@CheckReturnValue
public boolean start(boolean wait)

Starts this thread.

Parameters:

wait - True waits for a call by run() to ready().

Returns:

True on success.

waitForReady

@CheckReturnValue
public boolean waitForReady()

Waits for a call to ready().

Returns:

True unless hasFailed() or interrupted.