Processor

java.lang.Object
- java.util.concurrent.AbstractExecutorService
- - java.util.concurrent.ThreadPoolExecutor
  - - icy.system.thread.Processor

All Implemented Interfaces:

java.util.concurrent.Executor, java.util.concurrent.ExecutorService

Direct Known Subclasses:

IdProcessor, InstanceProcessor, SingleProcessor
```
public class Processor
extends java.util.concurrent.ThreadPoolExecutor
```
Processor class.
Allow you to queue and execute tasks on a defined set of thread.

Author:

stephane

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static interface Processor.ProcessorEventListener
Deprecated.
Useless interface
- Nested classes/interfaces inherited from class java.util.concurrent.ThreadPoolExecutor
  java.util.concurrent.ThreadPoolExecutor.AbortPolicy, java.util.concurrent.ThreadPoolExecutor.CallerRunsPolicy, java.util.concurrent.ThreadPoolExecutor.DiscardOldestPolicy, java.util.concurrent.ThreadPoolExecutor.DiscardPolicy

Nested Classes
Modifier and Type	Class and Description
`static interface`	`Processor.ProcessorEventListener` Deprecated. Useless interface

Field Summary

Fields
Modifier and Type	Field and Description
`static int`	`DEFAULT_MAX_PROCESSING`
`static int`	`DEFAULT_MAX_WAITING`
`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
`Processor()` Create a new Processor with default number of maximum waiting and processing tasks.
`Processor(int numThread)` Create a new Processor with specified number of processing thread.
`Processor(int maxWaiting, int numThread)` Create a new Processor with specified number of maximum waiting and processing tasks.
`Processor(int maxWaiting, int numThread, int priority)` Create a new Processor with specified number of maximum waiting and processing tasks.

Method Summary

Methods
Modifier and Type	Method and Description
`void`	`addListener(Processor.ProcessorEventListener listener)` Deprecated. Useless...
`boolean`	`addTask(java.lang.Runnable task)` Deprecated. Use `submit(Runnable)` instead.
`boolean`	`addTask(java.lang.Runnable task, boolean onEDT)` Deprecated. Use `submit(Runnable)` instead.
`boolean`	`addTask(java.lang.Runnable task, boolean onEDT, int id)` Deprecated. Use `submit(Runnable)` instead.
`void`	`execute(java.lang.Runnable task)`
`void`	`fireDoneEvent(icy.system.thread.Processor.FutureTaskAdapter<?> task)` Deprecated. useless
`java.lang.String`	`getDefaultThreadName()` Deprecated. Use `getThreadName()` instead
`int`	`getFreeSlotNumber()` Get the number of free slot in queue
`int`	`getPriority()`
`java.lang.String`	`getThreadName()` Return the thread name.
`int`	`getWaitingTasksCount()` Return the number of waiting task
`int`	`getWaitingTasksCount(java.util.concurrent.Callable<?> task)` Return the number of task waiting in queue for the specified `Callable` instance.
`int`	`getWaitingTasksCount(int id)` Deprecated. Not anymore supported. Use `getWaitingTasksCount(Callable)` or `getWaitingTasksCount(Runnable)` instead.
`int`	`getWaitingTasksCount(java.lang.Runnable task)` Return the number of task waiting in queue for the specified `Runnable` instance.
`boolean`	`hasWaitingTasks()` Return true if we have at least one task waiting in queue
`boolean`	`hasWaitingTasks(java.util.concurrent.Callable<?> task)` Return true if we have at least one task in queue for the specified `Callable` instance.
`boolean`	`hasWaitingTasks(int id)` Deprecated. Not anymore supported. Use `hasWaitingTasks(Callable)` or `hasWaitingTasks(Runnable)` instead.
`boolean`	`hasWaitingTasks(java.lang.Runnable task)` Return true if we have at least one task in queue for the specified `Runnable` instance.
`boolean`	`isFull()` Return true if queue is full
`boolean`	`isProcessing()` Return true if one or more process are executing or we still have waiting tasks.
`boolean`	`limitWaitingTask(int value)` Deprecated. This method is useless.
`void`	`limitWaitingTask(int id, int value)` Deprecated. Not anymore supported !
`void`	`limitWaitingTask(java.lang.Runnable task, int value)` Deprecated. This method is useless.
`boolean`	`remove(java.lang.Runnable task)`
`void`	`removeAllWaitingTasks()` Clear all waiting tasks
`boolean`	`removeFirstWaitingTask(java.util.concurrent.Callable<?> task)` Remove first waiting task for the specified `Callable` instance.
`boolean`	`removeFirstWaitingTask(int id)` Deprecated. Not anymore supported. USe `removeFirstWaitingTask(Runnable)` or `removeFirstWaitingTask(Callable)` instead.
`boolean`	`removeFirstWaitingTask(java.lang.Runnable task)` Remove first waiting task for the specified `Runnable` instance.
`void`	`removeListener(Processor.ProcessorEventListener listener)` Deprecated. Useless...
`boolean`	`removeTask(java.lang.Runnable task)` Deprecated. Use `removeFirstWaitingTask(Runnable)` instead.
`boolean`	`removeWaitingTasks(java.util.concurrent.Callable<?> task)` Remove all waiting tasks for the specified `Callable` instance.
`boolean`	`removeWaitingTasks(int id)` Deprecated. Not anymore supported. USe `removeWaitingTasks(Runnable)` or `removeWaitingTasks(Callable)` instead.
`boolean`	`removeWaitingTasks(java.lang.Runnable task)` Remove all waiting tasks for the specified `Runnable` instance.
`void`	`setDefaultThreadName(java.lang.String defaultThreadName)` Deprecated. Use `setThreadName(String)` instead
`void`	`setPriority(int priority)`
`void`	`setThreadName(java.lang.String defaultThreadName)` Set the wanted thread name.
`void`	`shutdownAndWait()` shutdown and wait current tasks completion
`<T> java.util.concurrent.Future<T>`	`submit(boolean handleException, java.util.concurrent.Callable<T> task)` Submits a value-returning task for execution and returns a Future representing the pending results of the task.
`java.util.concurrent.Future<?>`	`submit(boolean handleException, java.lang.Runnable task)` Submits a Runnable task for execution and returns a Future representing that task.
`<T> java.util.concurrent.Future<T>`	`submit(boolean handleException, java.lang.Runnable task, T result)` Submits a Runnable task for execution and returns a Future representing that task.
`<T> java.util.concurrent.Future<T>`	`submit(java.util.concurrent.Callable<T> task)`
`<T> java.util.concurrent.Future<T>`	`submit(java.util.concurrent.Callable<T> task, boolean onEDT)` Deprecated. Use `submit(Callable)` instead and ThreadUtil.invokeNow(..) where you need it.
`java.util.concurrent.Future<?>`	`submit(java.lang.Runnable task)`
`java.util.concurrent.Future<?>`	`submit(java.lang.Runnable task, boolean onEDT)` Deprecated. Use `submit(Runnable)` instead and ThreadUtil.invokeNow(..) where you need it.
`<T> java.util.concurrent.Future<T>`	`submit(java.lang.Runnable task, T result)`
`<T> java.util.concurrent.Future<T>`	`submit(java.lang.Runnable task, T result, boolean onEDT)` Deprecated. Use `submit(Runnable, Object)` instead and ThreadUtil.invokeNow(..) where you need it.
`void`	`waitAll()` Wait for all tasks completion

Methods inherited from class java.util.concurrent.ThreadPoolExecutor
allowCoreThreadTimeOut, allowsCoreThreadTimeOut, awaitTermination, getActiveCount, getCompletedTaskCount, getCorePoolSize, getKeepAliveTime, getLargestPoolSize, getMaximumPoolSize, getPoolSize, getQueue, getRejectedExecutionHandler, getTaskCount, getThreadFactory, isShutdown, isTerminated, isTerminating, prestartAllCoreThreads, prestartCoreThread, purge, setCorePoolSize, setKeepAliveTime, setMaximumPoolSize, setRejectedExecutionHandler, setThreadFactory, shutdown, shutdownNow, toString

Methods inherited from class java.util.concurrent.AbstractExecutorService
invokeAll, invokeAll, invokeAny, invokeAny

Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Field Detail
  - DEFAULT_MAX_WAITING
```
public static final int DEFAULT_MAX_WAITING
```
    See Also:
    Constant Field Values
  - DEFAULT_MAX_PROCESSING
```
public static final int DEFAULT_MAX_PROCESSING
```
  - 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
  - Processor
```
public Processor(int maxWaiting,
         int numThread,
         int priority)
```
    Create a new Processor with specified number of maximum waiting and processing tasks.
    
    Parameters:
    maxWaiting - The length of waiting queue.
    numThread - The maximum number of processing thread.
    priority - Processor priority
    Processor.MIN_PRIORITY
    Processor.NORM_PRIORITY
    Processor.MAX_PRIORITY
  - Processor
```
public Processor(int maxWaiting,
         int numThread)
```
    Create a new Processor with specified number of maximum waiting and processing tasks.
    
    Parameters:
    maxWaiting - The length of waiting queue.
    numThread - The maximum number of processing thread.
  - Processor
```
public Processor(int numThread)
```
    Create a new Processor with specified number of processing thread.
    
    Parameters:
    numThread - The maximum number of processing thread.
  - Processor
```
public Processor()
```
    Create a new Processor with default number of maximum waiting and processing tasks.
- Method Detail
  - removeTask
```
@Deprecated
public boolean removeTask(java.lang.Runnable task)
```
    Deprecated. Use removeFirstWaitingTask(Runnable) instead.
  - addTask
```
@Deprecated
public boolean addTask(java.lang.Runnable task,
                         boolean onEDT,
                         int id)
```
    Deprecated. Use submit(Runnable) instead.
  - addTask
```
@Deprecated
public boolean addTask(java.lang.Runnable task,
                         boolean onEDT)
```
    Deprecated. Use submit(Runnable) instead.
  - addTask
```
@Deprecated
public boolean addTask(java.lang.Runnable task)
```
    Deprecated. Use submit(Runnable) instead.
  - remove
```
public boolean remove(java.lang.Runnable task)
```
    Overrides:
    
    remove in class java.util.concurrent.ThreadPoolExecutor
  - execute
```
public void execute(java.lang.Runnable task)
```
    Specified by:
    
    execute in interface java.util.concurrent.Executor
    
    Overrides:
    
    execute in class java.util.concurrent.ThreadPoolExecutor
  - submit
```
public java.util.concurrent.Future<?> submit(java.lang.Runnable task)
```
    Specified by:
    
    submit in interface java.util.concurrent.ExecutorService
    
    Overrides:
    
    submit in class java.util.concurrent.AbstractExecutorService
  - submit
```
public <T> java.util.concurrent.Future<T> submit(java.lang.Runnable task,
                                        T result)
```
    Specified by:
    
    submit in interface java.util.concurrent.ExecutorService
    
    Overrides:
    
    submit in class java.util.concurrent.AbstractExecutorService
  - submit
```
public <T> java.util.concurrent.Future<T> submit(java.util.concurrent.Callable<T> task)
```
    Specified by:
    
    submit in interface java.util.concurrent.ExecutorService
    
    Overrides:
    
    submit in class java.util.concurrent.AbstractExecutorService
  - submit
```
public java.util.concurrent.Future<?> submit(boolean handleException,
                                    java.lang.Runnable task)
```
    Submits a Runnable task for execution and returns a Future representing that task. The Future's get method will return null upon successful completion.
    
    Parameters:
    handleException - if set to true then any occurring exception during the runnable processing will be catch by IcyExceptionHandler.
    task - the task to submit
    
    Returns:
    a Future representing pending completion of the task
    
    Throws:
    
    java.util.concurrent.RejectedExecutionException - if the task cannot be scheduled for execution
    
    java.lang.NullPointerException - if the task is null
  - submit
```
public <T> java.util.concurrent.Future<T> submit(boolean handleException,
                                        java.lang.Runnable task,
                                        T result)
```
    Submits a Runnable task for execution and returns a Future representing that task. The Future's get method will return the given result upon successful completion.
    
    Parameters:
    handleException - if set to true then any occurring exception during the runnable processing will be catch by IcyExceptionHandler.
    task - the task to submit
    result - the result to return
    
    Returns:
    a Future representing pending completion of the task
    
    Throws:
    
    java.util.concurrent.RejectedExecutionException - if the task cannot be scheduled for execution
    
    java.lang.NullPointerException - if the task is null
  - submit
```
public <T> java.util.concurrent.Future<T> submit(boolean handleException,
                                        java.util.concurrent.Callable<T> task)
```
    Submits a value-returning task for execution and returns a Future representing the pending results of the task. The Future's get method will return the task's result upon successful completion.
    If you would like to immediately block waiting for a task, you can use constructions of the form result = exec.submit(aCallable).get();
    Note: The Executors class includes a set of methods that can convert some other common closure-like objects, for example, PrivilegedAction to Callable form so they can be submitted.
    
    Parameters:
    handleException - if set to true then any occurring exception during the runnable processing will be catch by IcyExceptionHandler.
    task - the task to submit
    
    Returns:
    a Future representing pending completion of the task
    
    Throws:
    
    java.util.concurrent.RejectedExecutionException - if the task cannot be scheduled for execution
    
    java.lang.NullPointerException - if the task is null
  - submit
```
@Deprecated
public java.util.concurrent.Future<?> submit(java.lang.Runnable task,
                                               boolean onEDT)
```
    Deprecated. Use submit(Runnable) instead and ThreadUtil.invokeNow(..) where you need it.
  - submit
```
@Deprecated
public <T> java.util.concurrent.Future<T> submit(java.lang.Runnable task,
                                                   T result,
                                                   boolean onEDT)
```
    Deprecated. Use submit(Runnable, Object) instead and ThreadUtil.invokeNow(..) where you need it.
  - submit
```
@Deprecated
public <T> java.util.concurrent.Future<T> submit(java.util.concurrent.Callable<T> task,
                                                   boolean onEDT)
```
    Deprecated. Use submit(Callable) instead and ThreadUtil.invokeNow(..) where you need it.
  - isProcessing
```
public boolean isProcessing()
```
    Return true if one or more process are executing or we still have waiting tasks.
  - waitAll
```
public void waitAll()
```
    Wait for all tasks completion
  - shutdownAndWait
```
public void shutdownAndWait()
```
    shutdown and wait current tasks completion
  - getPriority
```
public int getPriority()
```
    Returns:
    the priority
  - setPriority
```
public void setPriority(int priority)
```
    Parameters:
    priority - the priority to set
  - getDefaultThreadName
```
@Deprecated
public java.lang.String getDefaultThreadName()
```
    Deprecated. Use getThreadName() instead
  - setDefaultThreadName
```
@Deprecated
public void setDefaultThreadName(java.lang.String defaultThreadName)
```
    Deprecated. Use setThreadName(String) instead
  - getThreadName
```
public java.lang.String getThreadName()
```
    Return the thread name.
  - setThreadName
```
public void setThreadName(java.lang.String defaultThreadName)
```
    Set the wanted thread name.
  - getFreeSlotNumber
```
public int getFreeSlotNumber()
```
    Get the number of free slot in queue
  - isFull
```
public boolean isFull()
```
    Return true if queue is full
  - getWaitingTasksCount
```
public int getWaitingTasksCount()
```
    Return the number of waiting task
  - getWaitingTasksCount
```
@Deprecated
public int getWaitingTasksCount(int id)
```
    Deprecated. Not anymore supported.
    Use getWaitingTasksCount(Callable) or getWaitingTasksCount(Runnable) instead.
  - getWaitingTasksCount
```
public int getWaitingTasksCount(java.lang.Runnable task)
```
    Return the number of task waiting in queue for the specified Runnable instance.
  - getWaitingTasksCount
```
public int getWaitingTasksCount(java.util.concurrent.Callable<?> task)
```
    Return the number of task waiting in queue for the specified Callable instance.
  - hasWaitingTasks
```
public boolean hasWaitingTasks()
```
    Return true if we have at least one task waiting in queue
  - hasWaitingTasks
```
@Deprecated
public boolean hasWaitingTasks(int id)
```
    Deprecated. Not anymore supported.
    Use hasWaitingTasks(Callable) or hasWaitingTasks(Runnable) instead.
  - hasWaitingTasks
```
public boolean hasWaitingTasks(java.lang.Runnable task)
```
    Return true if we have at least one task in queue for the specified Runnable instance.
  - hasWaitingTasks
```
public boolean hasWaitingTasks(java.util.concurrent.Callable<?> task)
```
    Return true if we have at least one task in queue for the specified Callable instance.
  - removeFirstWaitingTask
```
@Deprecated
public boolean removeFirstWaitingTask(int id)
```
    Deprecated. Not anymore supported.
    USe removeFirstWaitingTask(Runnable) or removeFirstWaitingTask(Callable) instead.
  - removeFirstWaitingTask
```
public boolean removeFirstWaitingTask(java.lang.Runnable task)
```
    Remove first waiting task for the specified Runnable instance.
  - removeFirstWaitingTask
```
public boolean removeFirstWaitingTask(java.util.concurrent.Callable<?> task)
```
    Remove first waiting task for the specified Callable instance.
  - removeWaitingTasks
```
@Deprecated
public boolean removeWaitingTasks(int id)
```
    Deprecated. Not anymore supported.
    USe removeWaitingTasks(Runnable) or removeWaitingTasks(Callable) instead.
  - removeWaitingTasks
```
public boolean removeWaitingTasks(java.lang.Runnable task)
```
    Remove all waiting tasks for the specified Runnable instance.
  - removeWaitingTasks
```
public boolean removeWaitingTasks(java.util.concurrent.Callable<?> task)
```
    Remove all waiting tasks for the specified Callable instance.
  - removeAllWaitingTasks
```
public void removeAllWaitingTasks()
```
    Clear all waiting tasks
  - limitWaitingTask
```
@Deprecated
public void limitWaitingTask(java.lang.Runnable task,
                               int value)
```
    Deprecated. This method is useless.
  - limitWaitingTask
```
@Deprecated
public void limitWaitingTask(int id,
                               int value)
```
    Deprecated. Not anymore supported !
  - limitWaitingTask
```
@Deprecated
public boolean limitWaitingTask(int value)
```
    Deprecated. This method is useless.
  - addListener
```
@Deprecated
public void addListener(Processor.ProcessorEventListener listener)
```
    Deprecated. Useless...
  - removeListener
```
@Deprecated
public void removeListener(Processor.ProcessorEventListener listener)
```
    Deprecated. Useless...
  - fireDoneEvent
```
@Deprecated
public void fireDoneEvent(icy.system.thread.Processor.FutureTaskAdapter<?> task)
```
    Deprecated. useless

Class Processor

Nested Class Summary

Nested classes/interfaces inherited from class java.util.concurrent.ThreadPoolExecutor

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.util.concurrent.ThreadPoolExecutor

Methods inherited from class java.util.concurrent.AbstractExecutorService

Methods inherited from class java.lang.Object

Field Detail

DEFAULT_MAX_WAITING

DEFAULT_MAX_PROCESSING

MIN_PRIORITY

NORM_PRIORITY

MAX_PRIORITY

Constructor Detail

Processor

Processor

Processor

Processor

Method Detail

removeTask

addTask

addTask

addTask

remove

execute

submit

submit

submit

submit

submit

submit

submit

submit

submit

isProcessing

waitAll

shutdownAndWait

getPriority

setPriority

getDefaultThreadName

setDefaultThreadName

getThreadName

setThreadName

getFreeSlotNumber

isFull

getWaitingTasksCount

getWaitingTasksCount

getWaitingTasksCount

getWaitingTasksCount

hasWaitingTasks

hasWaitingTasks

hasWaitingTasks

hasWaitingTasks

removeFirstWaitingTask

removeFirstWaitingTask

removeFirstWaitingTask

removeWaitingTasks

removeWaitingTasks

removeWaitingTasks

removeAllWaitingTasks

limitWaitingTask

limitWaitingTask

limitWaitingTask

addListener

removeListener

fireDoneEvent