ExecutorBuilder (jarvis-tool-core 1.0.3.RELEASE API)

java.lang.Object
- com.github.jarvisframework.tool.core.thread.ExecutorBuilder

所有已实现的接口:

Builder<ThreadPoolExecutor>, Serializable
```
public class ExecutorBuilder
extends Object
implements Builder<ThreadPoolExecutor>
```
ThreadPoolExecutor 建造者

从以下版本开始:

1.0, 2020-07-29 12:05:06

作者:

Doug Wang

另请参阅:

序列化表格

字段概要

字段
限定符和类型	字段和说明
`private Boolean`	`allowCoreThreadTimeOut` 线程执行超时后是否回收线程
`private int`	`corePoolSize` 初始池大小
`static int`	`DEFAULT_QUEUE_CAPACITY` 默认的等待队列容量
`private RejectedExecutionHandler`	`handler` 当线程阻塞（block）时的异常处理器，所谓线程阻塞即线程池和等待队列已满，无法处理线程时采取的策略
`private long`	`keepAliveTime` 线程存活时间，即当池中线程多于初始大小时，多出的线程保留的时长
`private int`	`maxPoolSize` 最大池大小（允许同时执行的最大线程数）
`private static long`	`serialVersionUID`
`private ThreadFactory`	`threadFactory` 线程工厂，用于自定义线程创建
`private BlockingQueue<Runnable>`	`workQueue` 队列，用于存在未执行的线程

构造器概要

构造器
构造器和说明

ExecutorBuilder()

构造器
构造器和说明
`ExecutorBuilder()`

方法概要

所有方法静态方法实例方法具体方法
限定符和类型	方法和说明
`ThreadPoolExecutor`	`build()` 构建ThreadPoolExecutor
`private static ThreadPoolExecutor`	`build(ExecutorBuilder builder)` 构建ThreadPoolExecutor
`ExecutorService`	`buildFinalizable()` 创建有回收关闭功能的ExecutorService
`static ExecutorBuilder`	`create()` 创建ExecutorBuilder，开始构建
`ExecutorBuilder`	`setAllowCoreThreadTimeOut(boolean allowCoreThreadTimeOut)` 设置线程执行超时后是否回收线程
`ExecutorBuilder`	`setCorePoolSize(int corePoolSize)` 设置初始池大小，默认0
`ExecutorBuilder`	`setHandler(RejectedExecutionHandler handler)` 设置当线程阻塞（block）时的异常处理器，所谓线程阻塞即线程池和等待队列已满，无法处理线程时采取的策略此处可以使用JDK预定义的几种策略，见`RejectPolicy`枚举
`ExecutorBuilder`	`setKeepAliveTime(long keepAliveTime)` 设置线程存活时间，即当池中线程多于初始大小时，多出的线程保留的时长，单位纳秒
`ExecutorBuilder`	`setKeepAliveTime(long keepAliveTime, TimeUnit unit)` 设置线程存活时间，即当池中线程多于初始大小时，多出的线程保留的时长
`ExecutorBuilder`	`setMaxPoolSize(int maxPoolSize)` 设置最大池大小（允许同时执行的最大线程数）
`ExecutorBuilder`	`setThreadFactory(ThreadFactory threadFactory)` 设置线程工厂，用于自定义线程创建
`ExecutorBuilder`	`setWorkQueue(BlockingQueue<Runnable> workQueue)` 设置队列，用于存在未执行的线程可选队列有： 1.
`ExecutorBuilder`	`useArrayBlockingQueue(int capacity)` 使用`ArrayBlockingQueue` 做为等待队列有界队列，相对无界队列有利于控制队列大小，队列满时，运行线程小于maxPoolSize时会创建新线程，否则触发异常策略
`ExecutorBuilder`	`useSynchronousQueue()` 使用`SynchronousQueue` 做为等待队列（非公平策略）它将任务直接提交给线程而不保持它们。
`ExecutorBuilder`	`useSynchronousQueue(boolean fair)` 使用`SynchronousQueue` 做为等待队列它将任务直接提交给线程而不保持它们。

从类继承的方法 java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- 字段详细资料
  - serialVersionUID
```
private static final long serialVersionUID
```
    另请参阅:
    
    常量字段值
  - DEFAULT_QUEUE_CAPACITY
```
public static final int DEFAULT_QUEUE_CAPACITY
```
    默认的等待队列容量
    
    另请参阅:
    
    常量字段值
  - corePoolSize
```
private int corePoolSize
```
    初始池大小
  - maxPoolSize
```
private int maxPoolSize
```
    最大池大小（允许同时执行的最大线程数）
  - keepAliveTime
```
private long keepAliveTime
```
    线程存活时间，即当池中线程多于初始大小时，多出的线程保留的时长
  - workQueue
```
private BlockingQueue<Runnable> workQueue
```
    队列，用于存在未执行的线程
  - threadFactory
```
private ThreadFactory threadFactory
```
    线程工厂，用于自定义线程创建
  - handler
```
private RejectedExecutionHandler handler
```
    当线程阻塞（block）时的异常处理器，所谓线程阻塞即线程池和等待队列已满，无法处理线程时采取的策略
  - allowCoreThreadTimeOut
```
private Boolean allowCoreThreadTimeOut
```
    线程执行超时后是否回收线程
- 构造器详细资料
  - ExecutorBuilder
```
public ExecutorBuilder()
```
- 方法详细资料
  - setCorePoolSize
```
public ExecutorBuilder setCorePoolSize(int corePoolSize)
```
    设置初始池大小，默认0
    
    参数:
    
    corePoolSize - 初始池大小
    
    返回:
    
    this
  - setMaxPoolSize
```
public ExecutorBuilder setMaxPoolSize(int maxPoolSize)
```
    设置最大池大小（允许同时执行的最大线程数）
    
    参数:
    
    maxPoolSize - 最大池大小（允许同时执行的最大线程数）
    
    返回:
    
    this
  - setKeepAliveTime
```
public ExecutorBuilder setKeepAliveTime(long keepAliveTime,
                                        TimeUnit unit)
```
    设置线程存活时间，即当池中线程多于初始大小时，多出的线程保留的时长
    
    参数:
    
    keepAliveTime - 线程存活时间
    
    unit - 单位
    
    返回:
    
    this
  - setKeepAliveTime
```
public ExecutorBuilder setKeepAliveTime(long keepAliveTime)
```
    设置线程存活时间，即当池中线程多于初始大小时，多出的线程保留的时长，单位纳秒
    
    参数:
    
    keepAliveTime - 线程存活时间，单位纳秒
    
    返回:
    
    this
  - setWorkQueue
```
public ExecutorBuilder setWorkQueue(BlockingQueue<Runnable> workQueue)
```
    设置队列，用于存在未执行的线程
    可选队列有：
```
 1. SynchronousQueue    它将任务直接提交给线程而不保持它们。当运行线程小于maxPoolSize时会创建新线程，否则触发异常策略
 2. LinkedBlockingQueue 默认无界队列，当运行线程大于corePoolSize时始终放入此队列，此时maximumPoolSize无效。
                        当构造LinkedBlockingQueue对象时传入参数，变为有界队列，队列满时，运行线程小于maxPoolSize时会创建新线程，否则触发异常策略
 3. ArrayBlockingQueue  有界队列，相对无界队列有利于控制队列大小，队列满时，运行线程小于maxPoolSize时会创建新线程，否则触发异常策略
 
```
    参数:
    
    workQueue - 队列
    
    返回:
    
    this
  - useArrayBlockingQueue
```
public ExecutorBuilder useArrayBlockingQueue(int capacity)
```
    使用ArrayBlockingQueue 做为等待队列
    有界队列，相对无界队列有利于控制队列大小，队列满时，运行线程小于maxPoolSize时会创建新线程，否则触发异常策略
    
    参数:
    
    capacity - 队列容量
    
    返回:
    
    this
    
    从以下版本开始:
    
    5.1.4
  - useSynchronousQueue
```
public ExecutorBuilder useSynchronousQueue()
```
    使用SynchronousQueue 做为等待队列（非公平策略）
    它将任务直接提交给线程而不保持它们。当运行线程小于maxPoolSize时会创建新线程，否则触发异常策略
    
    返回:
    
    this
    
    从以下版本开始:
    
    4.1.11
  - useSynchronousQueue
```
public ExecutorBuilder useSynchronousQueue(boolean fair)
```
    使用SynchronousQueue 做为等待队列
    它将任务直接提交给线程而不保持它们。当运行线程小于maxPoolSize时会创建新线程，否则触发异常策略
    
    参数:
    
    fair - 是否使用公平访问策略
    
    返回:
    
    this
    
    从以下版本开始:
    
    4.5.0
  - setThreadFactory
```
public ExecutorBuilder setThreadFactory(ThreadFactory threadFactory)
```
    设置线程工厂，用于自定义线程创建
    
    参数:
    
    threadFactory - 线程工厂
    
    返回:
    
    this
    
    另请参阅:
    
    ThreadFactoryBuilder
  - setHandler
```
public ExecutorBuilder setHandler(RejectedExecutionHandler handler)
```
    设置当线程阻塞（block）时的异常处理器，所谓线程阻塞即线程池和等待队列已满，无法处理线程时采取的策略
    此处可以使用JDK预定义的几种策略，见RejectPolicy枚举
    
    参数:
    
    handler - RejectedExecutionHandler
    
    返回:
    
    this
    
    另请参阅:
    
    RejectPolicy
  - setAllowCoreThreadTimeOut
```
public ExecutorBuilder setAllowCoreThreadTimeOut(boolean allowCoreThreadTimeOut)
```
    设置线程执行超时后是否回收线程
    
    参数:
    
    allowCoreThreadTimeOut - 线程执行超时后是否回收线程
    
    返回:
    
    this
  - create
```
public static ExecutorBuilder create()
```
    创建ExecutorBuilder，开始构建
    
    返回:
    
    ExecutorBuilder
  - build
```
public ThreadPoolExecutor build()
```
    构建ThreadPoolExecutor
    
    指定者:
    
    build 在接口中 Builder<ThreadPoolExecutor>
    
    返回:
    
    被构建的对象
  - buildFinalizable
```
public ExecutorService buildFinalizable()
```
    创建有回收关闭功能的ExecutorService
    
    返回:
    
    创建有回收关闭功能的ExecutorService
    
    从以下版本开始:
    
    5.1.4
  - build
```
private static ThreadPoolExecutor build(ExecutorBuilder builder)
```
    构建ThreadPoolExecutor
    
    参数:
    
    builder - ExecutorBuilder
    
    返回:
    
    ThreadPoolExecutor

类 ExecutorBuilder

字段概要

构造器概要

方法概要

从类继承的方法 java.lang.Object

字段详细资料

serialVersionUID

DEFAULT_QUEUE_CAPACITY

corePoolSize

maxPoolSize

keepAliveTime

workQueue

threadFactory

handler

allowCoreThreadTimeOut

构造器详细资料

ExecutorBuilder

方法详细资料

setCorePoolSize

setMaxPoolSize

setKeepAliveTime

setKeepAliveTime

setWorkQueue

useArrayBlockingQueue

useSynchronousQueue

useSynchronousQueue

setThreadFactory

setHandler

setAllowCoreThreadTimeOut

create

build

buildFinalizable

build