icy.system.thread

Class ThreadUtil

java.lang.Object

icy.system.thread.ThreadUtil

public class ThreadUtil
extends java.lang.Object

Thread utilities class.

Author:

Stephane

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ThreadUtil.CaughtRunnable This class is used to catch exception in the EDT.

Field Summary

Fields

Modifier and Type	Field and Description
static int	MAX_PRIORITY The maximum priority that a thread can have.
static int	MIN_PRIORITY The minimum priority that a thread can have.
static int	NORM_PRIORITY The default priority that is assigned to a thread.

Constructor Summary

Constructors

Constructor and Description
ThreadUtil()

Method Summary

Methods

Modifier and Type	Method and Description
static <T> java.util.concurrent.Future<T>	bgRun(java.util.concurrent.Callable<T> callable) Adds background processing (low priority) of specified Callable task.
static <T> java.util.concurrent.Future<T>	bgRun(java.util.concurrent.Callable<T> callable, boolean onEDT) Deprecated. Use bgRun(Callable) and invokeNow(Callable) separately instead.
static boolean	bgRun(java.lang.Runnable runnable) Adds background processing (low priority) of specified Runnable.
static boolean	bgRun(java.lang.Runnable runnable, boolean onEDT) Deprecated. Use bgRun(Runnable) instead and invokeNow(Runnable) separately.
static <T> java.util.concurrent.Future<T>	bgRunSingle(java.util.concurrent.Callable<T> callable) Adds single processing (low priority) of specified Callable task.
static <T> java.util.concurrent.Future<T>	bgRunSingle(java.util.concurrent.Callable<T> callable, boolean onEDT) Deprecated. Use runSingle(Callable) and invokeNow(Callable) separately instead.
static boolean	bgRunSingle(java.lang.Runnable runnable) Adds single processing (low priority) of specified Runnable.
static boolean	bgRunSingle(java.lang.Runnable runnable, boolean onEDT) Deprecated. Use runSingle(Runnable) instead and invokeNow(Runnable) separately.
static void	bgRunWait(java.lang.Runnable runnable) Deprecated. Use bgRun(Runnable) instead and check for acceptance.
static java.util.concurrent.ExecutorService	createThreadPool(java.lang.String name) Create a thread pool with the given name.
static int	getActiveBgTaskCount() Return the number of active background tasks.
static boolean	hasWaitingBgSingleTask(java.util.concurrent.Callable<?> callable) Return true if the specified callable is waiting to be processed in single scheme background processing (low priority).
static boolean	hasWaitingBgSingleTask(java.lang.Runnable runnable) Return true if the specified runnable is waiting to be processed in single scheme background processing (low priority).
static boolean	hasWaitingBgTask(java.util.concurrent.Callable<?> callable) Return true if the specified callable is waiting to be processed in background processing.
static boolean	hasWaitingBgTask(java.lang.Runnable runnable) Return true if the specified runnable is waiting to be processed in background processing.
static boolean	hasWaitingSingleTask(java.util.concurrent.Callable<?> callable) Return true if the specified callable is waiting to be processed in single scheme background processing (normal priority).
static boolean	hasWaitingSingleTask(java.lang.Runnable runnable) Return true if the specified runnable is waiting to be processed in single scheme background processing (normal priority).
static void	invoke(java.lang.Runnable runnable, boolean wait) Invoke the specified Runnable on the AWT event dispatching thread.
static void	invokeAndWait(java.lang.Runnable runnable) Deprecated. Use invokeNow(Runnable) instead
static <T> java.util.concurrent.Future<T>	invokeLater(java.util.concurrent.Callable<T> callable, boolean forceLater) Invoke the specified Callable on the AWT event dispatching thread.
static void	invokeLater(java.lang.Runnable runnable) Invoke the specified Runnable on the AWT event dispatching thread.
static void	invokeLater(java.lang.Runnable runnable, boolean forceLater) Invoke the specified Runnable on the AWT event dispatching thread.
static <T> T	invokeNow(java.util.concurrent.Callable<T> callable) Invoke the specified Callable on the AWT event dispatching thread now and return the result.
static void	invokeNow(java.lang.Runnable runnable) Invoke the specified Runnable on the AWT event dispatching thread now and wait until completion.
static boolean	isEventDispatchThread()
static boolean	isShutdownAndTerminated() Return true if all background runner are shutdown and terminated.
static <T> java.util.concurrent.Future<T>	runSingle(java.util.concurrent.Callable<T> callable) Add single processing (normal priority) of specified Callable task.
static boolean	runSingle(java.lang.Runnable runnable) Add single processing (normal priority) of specified Runnable.
static void	shutdown() Shutdown all background runner.
static void	sleep(int milli) Same as Thread.sleep(long) except Exception is caught and ignored.
static void	sleep(long milli) Same as Thread.sleep(long) except Exception is caught and ignored.

Methods inherited from class java.lang.Object

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

Field Detail

MIN_PRIORITY

public static final int MIN_PRIORITY

The minimum priority that a thread can have.

See Also:

Constant Field Values

NORM_PRIORITY

public static final int NORM_PRIORITY

The default priority that is assigned to a thread.

See Also:

Constant Field Values

MAX_PRIORITY

public static final int MAX_PRIORITY

The maximum priority that a thread can have.

See Also:

Constant Field Values

Constructor Detail

ThreadUtil

public ThreadUtil()

Method Detail

shutdown

public static void shutdown()

Shutdown all background runner.

isShutdownAndTerminated

public static boolean isShutdownAndTerminated()

Return true if all background runner are shutdown and terminated.

isEventDispatchThread

public static boolean isEventDispatchThread()

Returns:

true if the current thread is an AWT event dispatching thread.

invoke

public static void invoke(java.lang.Runnable runnable,
          boolean wait)

Invoke the specified Runnable on the AWT event dispatching thread.
Any exception is automatically caught by Icy exception handler.

Parameters:

wait - If set to true, the method wait until completion, in this case you have to take attention to not cause any dead lock.

See Also:

invokeLater(Runnable), invokeNow(Runnable)

invokeAndWait

@Deprecated
public static void invokeAndWait(java.lang.Runnable runnable)

Deprecated. Use invokeNow(Runnable) instead

invokeNow

public static void invokeNow(java.lang.Runnable runnable)

Invoke the specified Runnable on the AWT event dispatching thread now and wait until completion.
Any exception is automatically caught by Icy exception handler, if you want to catch them use invokeNow(Callable) instead.
Use this method carefully as it may lead to dead lock.

invokeLater

public static void invokeLater(java.lang.Runnable runnable)

Invoke the specified Runnable on the AWT event dispatching thread.
If we already are on the EDT the Runnable is executed immediately else it will be executed later.

See Also:

invokeLater(Runnable, boolean)

invokeLater

public static void invokeLater(java.lang.Runnable runnable,
               boolean forceLater)

Invoke the specified Runnable on the AWT event dispatching thread.
Depending the forceLater parameter the Runnable can be executed immediately if we are on the EDT.

Parameters:

forceLater - If true the Runnable is forced to execute later even if we are on the Swing EDT.

invokeNow

public static <T> T invokeNow(java.util.concurrent.Callable<T> callable)
                   throws java.lang.Exception

Invoke the specified Callable on the AWT event dispatching thread now and return the result.
The returned result can be null when a Throwable exception happen.
Use this method carefully as it may lead to dead lock.

Throws:

java.lang.InterruptedException - if the current thread was interrupted while waiting

java.lang.Exception - if the computation threw an exception

invokeLater

public static <T> java.util.concurrent.Future<T> invokeLater(java.util.concurrent.Callable<T> callable,
                                             boolean forceLater)

Invoke the specified Callable on the AWT event dispatching thread.
Depending the forceLater parameter the Callable can be executed immediately if we are on the EDT.

Parameters:

forceLater - If true the Callable is forced to execute later even if we are on the EDT.

bgRun

@Deprecated
public static boolean bgRun(java.lang.Runnable runnable,
                       boolean onEDT)

Deprecated. Use bgRun(Runnable) instead and invokeNow(Runnable) separately.

See Also:

bgRun(Runnable)

bgRunWait

@Deprecated
public static void bgRunWait(java.lang.Runnable runnable)

Deprecated. Use bgRun(Runnable) instead and check for acceptance.

bgRun

public static boolean bgRun(java.lang.Runnable runnable)

Adds background processing (low priority) of specified Runnable.
Returns false if background process queue is full.
Don't use this method for long process (more than 1 second) as the number of thread is limited and others processes may be executed too late.

bgRun

@Deprecated
public static <T> java.util.concurrent.Future<T> bgRun(java.util.concurrent.Callable<T> callable,
                                                  boolean onEDT)

Deprecated. Use bgRun(Callable) and invokeNow(Callable) separately instead.

See Also:

bgRun(Callable)

bgRun

public static <T> java.util.concurrent.Future<T> bgRun(java.util.concurrent.Callable<T> callable)

Adds background processing (low priority) of specified Callable task.
Returns a Future representing the pending result of the task or null if background process queue is full.
Don't use this method for long process (more than 1 second) as the number of thread is limited and others processes may be executed too late.

bgRunSingle

@Deprecated
public static boolean bgRunSingle(java.lang.Runnable runnable,
                             boolean onEDT)

Deprecated. Use runSingle(Runnable) instead and invokeNow(Runnable) separately.

See Also:

bgRunSingle(Runnable)

bgRunSingle

@Deprecated
public static <T> java.util.concurrent.Future<T> bgRunSingle(java.util.concurrent.Callable<T> callable,
                                                        boolean onEDT)

Deprecated. Use runSingle(Callable) and invokeNow(Callable) separately instead.

See Also:

bgRunSingle(Callable)

bgRunSingle

public static boolean bgRunSingle(java.lang.Runnable runnable)

Adds single processing (low priority) of specified Runnable.
If this Runnable instance is already pending in single processes queue then nothing is done.
Returns false if single processes queue is full.
Don't use this method for long process (more than 1 second) as the number of thread is limited and others processes may be executed too late.

bgRunSingle

public static <T> java.util.concurrent.Future<T> bgRunSingle(java.util.concurrent.Callable<T> callable)

Adds single processing (low priority) of specified Callable task.
If this Callable instance is already pending in single processes queue then nothing is done.
Returns a Future representing the pending result of the task or null if single processes queue is full.
Don't use this method for long process (more than 1 second) as the number of thread is limited and others processes may be executed too late.

runSingle

public static boolean runSingle(java.lang.Runnable runnable)

Add single processing (normal priority) of specified Runnable.
If this Runnable instance is already pending in single processes queue then nothing is done.
Return false if single processes queue is full.
Don't use this method for long process (more than 1 second) as the number of thread is limited and others processes may be executed too late.

runSingle

public static <T> java.util.concurrent.Future<T> runSingle(java.util.concurrent.Callable<T> callable)

Add single processing (normal priority) of specified Callable task.
If this Callable instance is already pending in single processes queue then nothing is done.
Return a Future representing the pending result of the task or null if single processes queue is full.
Don't use this method for long process (more than 1 second) as the number of thread is limited and others processes may be executed too late.

hasWaitingBgTask

public static boolean hasWaitingBgTask(java.lang.Runnable runnable)

Return true if the specified runnable is waiting to be processed in background processing.

hasWaitingBgTask

public static boolean hasWaitingBgTask(java.util.concurrent.Callable<?> callable)

Return true if the specified callable is waiting to be processed in background processing.

hasWaitingBgSingleTask

public static boolean hasWaitingBgSingleTask(java.lang.Runnable runnable)

Return true if the specified runnable is waiting to be processed
in single scheme background processing (low priority).

hasWaitingBgSingleTask

public static boolean hasWaitingBgSingleTask(java.util.concurrent.Callable<?> callable)

Return true if the specified callable is waiting to be processed
in single scheme background processing (low priority).

hasWaitingSingleTask

public static boolean hasWaitingSingleTask(java.lang.Runnable runnable)

Return true if the specified runnable is waiting to be processed
in single scheme background processing (normal priority).

hasWaitingSingleTask

public static boolean hasWaitingSingleTask(java.util.concurrent.Callable<?> callable)

Return true if the specified callable is waiting to be processed
in single scheme background processing (normal priority).

getActiveBgTaskCount

public static int getActiveBgTaskCount()

Return the number of active background tasks.

createThreadPool

public static java.util.concurrent.ExecutorService createThreadPool(java.lang.String name)

Create a thread pool with the given name.
The number of processing thread is automatically calculated given the number of core of the system.

See Also:

Processor.Processor(int, int, int)

sleep

public static void sleep(long milli)

Same as Thread.sleep(long) except Exception is caught and ignored.

sleep

public static void sleep(int milli)

Same as Thread.sleep(long) except Exception is caught and ignored.