Class ExecutorQueue

java.lang.Object
org.simpleframework.common.thread.ExecutorQueue

class ExecutorQueue extends Object
The ExecutorQueue object is used to queue tasks in a thread pool. This creates a thread pool with no limit to the number of tasks that can be enqueued, which ensures that any system requesting a task to be executed will not block when handing it over, it also means the user must use caution.
See Also:
  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    private final ThreadPoolExecutor
    This is the actual thread pool implementation used.
    private final ThreadFactory
    This is used to create the pool worker threads.
    private final BlockingQueue<Runnable>
    This is the task queue that contains tasks due to execute.
  • Constructor Summary

    Constructors
    Constructor
    Description
    ExecutorQueue(Class type, int rest, int active)
    Constructor for the ExecutorQueue object.
    ExecutorQueue(Class type, int rest, int active, long duration, TimeUnit unit)
    Constructor for the ExecutorQueue object.
  • Method Summary

    Modifier and Type
    Method
    Description
    void
    The execute method is used to queue the task for execution.
    void
    This is used to stop the executor by interrupting all running tasks and shutting down the threads within the pool.
    void
    stop(long wait)
    This is used to stop the executor by interrupting all running tasks and shutting down the threads within the pool.

    Methods inherited from class java.lang.Object

    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
  • Field Details

    • queue

      private final BlockingQueue<Runnable> queue
      This is the task queue that contains tasks due to execute.
    • executor

      private final ThreadPoolExecutor executor
      This is the actual thread pool implementation used.
    • factory

      private final ThreadFactory factory
      This is used to create the pool worker threads.
  • Constructor Details

    • ExecutorQueue

      public ExecutorQueue(Class type, int rest, int active)
      Constructor for the ExecutorQueue object. This is used to create a pool of threads that can be used to execute arbitrary Runnable tasks. If the threads are busy this will simply enqueue the tasks and return.
      Parameters:
      type - this is the type of runnable that this accepts
      rest - this is the number of threads to use in the pool
      active - this is the maximum size the pool can grow to
    • ExecutorQueue

      public ExecutorQueue(Class type, int rest, int active, long duration, TimeUnit unit)
      Constructor for the ExecutorQueue object. This is used to create a pool of threads that can be used to execute arbitrary Runnable tasks. If the threads are busy this will simply enqueue the tasks and return.
      Parameters:
      type - this is the type of runnable that this accepts
      rest - this is the number of threads to use in the pool
      active - this is the maximum size the pool can grow to
      duration - the duration active threads remain idle for
      unit - this is the time unit used for the duration
  • Method Details

    • execute

      public void execute(Runnable task)
      The execute method is used to queue the task for execution. If all threads are busy the provided task is queued and waits until all current and outstanding tasks are finished.
      Parameters:
      task - this is the task to be queued for execution
    • stop

      public void stop()
      This is used to stop the executor by interrupting all running tasks and shutting down the threads within the pool. This will return once it has been stopped, and no further tasks will be accepted by this pool for execution.
    • stop

      public void stop(long wait)
      This is used to stop the executor by interrupting all running tasks and shutting down the threads within the pool. This will return once it has been stopped, and no further tasks will be accepted by this pool for execution.
      Parameters:
      wait - the number of milliseconds to wait for it to stop