EventExecutor (java-utils 1.3.1 API)

java.lang.Object
- net.lamgc.utils.event.EventExecutor

public class EventExecutor
extends Object

事件执行器.

构造器概要

构造器
构造器和说明
`EventExecutor(ThreadPoolExecutor threadPoolExecutor)` 构造一个EventExecutor.
`EventExecutor(ThreadPoolExecutor threadPoolExecutor, EventHandlerList eventHandlerList, EventHandlerObjectMap eventHandlerObjectMap)` 构造一个EventExecutor.

方法概要

所有方法静态方法实例方法具体方法
限定符和类型	方法和说明
`void`	`addHandler(EventHandler handler)` 添加EventHandler.
`boolean`	`awaitTermination(long timeout, TimeUnit unit)` 等待线程池内任务执行完成并关闭线程池.
`static boolean`	`checkMethod(Method method)` 检查指定方法是否为合法的事件接收方法
`int`	`executor(EventHandler handler, EventObject eventObject)` 对指定`EventHandler`投递事件
`void`	`executor(EventObject eventObject)` 投递事件.
`void`	`executorSync(EventObject eventObject)` 同步投递事件.
`protected void`	`finalize()`
`Thread.UncaughtExceptionHandler`	`getExceptionHandler()` 获取设定的UncaughtExceptionHandler
`ThreadPoolExecutor`	`getThreadPoolExecutor()` 获取EventExecutor所使用的`ThreadPoolExecutor`
`void`	`removeHandler(EventHandler handler)` 删除EventHandler
`static void`	`resendCurrentEvent()` 重新投递当前任务到当前Handler.
`void`	`setEnableEventResend(boolean enable)` 设置事件重投是否启用.
`void`	`setEventUncaughtExceptionHandler(EventUncaughtExceptionHandler handler)` 设置事件异常捕获处理对象.
`void`	`setUncaughtExceptionHandler(Thread.UncaughtExceptionHandler handler)` 设置线程池异常处理类.
`List<Runnable>`	`shutdown(boolean shutdownNow)` 关闭执行器.

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

- 构造器详细资料
  - EventExecutor
```
public EventExecutor(ThreadPoolExecutor threadPoolExecutor)
```
    构造一个EventExecutor.
    
    参数:
    
    threadPoolExecutor - 事件线程池, 线程池将用于执行Handler中的EventMethod.
  - EventExecutor
```
public EventExecutor(ThreadPoolExecutor threadPoolExecutor,
                     EventHandlerList eventHandlerList,
                     EventHandlerObjectMap eventHandlerObjectMap)
```
    构造一个EventExecutor.
    
    参数:
    
    threadPoolExecutor - 事件线程池, 线程池将用于执行Handler中的EventMethod.
    
    eventHandlerList - 事件列表, 用于存储EventObject对应EventHandlerMethod.
    
    eventHandlerObjectMap - EventHandlerObject存储, 用于存储EventHandler对象.
- 方法详细资料
  - addHandler
```
public void addHandler(EventHandler handler)
                throws IllegalAccessException
```
    添加EventHandler.
    
    参数:
    
    handler - EventHandler对象
    
    抛出:
    
    IllegalAccessException - 当EventHandler内方法不为Public时可能会抛出, 是否抛出由EventHandlerList所使用的实现决定
  - removeHandler
```
public void removeHandler(EventHandler handler)
```
    删除EventHandler
    
    参数:
    
    handler - 要删除的EventHandler对象
  - executor
```
public void executor(EventObject eventObject)
```
    投递事件. 事件将会以方法为单位执行.
    
    参数:
    
    eventObject - 带有事件参数的事件对象
  - executorSync
```
public void executorSync(EventObject eventObject)
                  throws InterruptedException
```
    同步投递事件. 方法将会在事件执行结束后返回.
    
    参数:
    
    eventObject - 需投递的事件对象
    
    抛出:
    
    InterruptedException - 当等待执行完成时发生中断, 则抛出异常.
  - executor
```
public int executor(EventHandler handler,
                    EventObject eventObject)
             throws IllegalAccessException
```
    对指定EventHandler投递事件
    
    参数:
    
    handler - 要进行事件投递的EventHandler
    
    eventObject - 事件对象
    
    返回:
    
    返回已处理事件方法数量
    
    抛出:
    
    IllegalAccessException - 当EventHandler访问权不为public时抛出异常.
  - setEnableEventResend
```
public void setEnableEventResend(boolean enable)
```
    设置事件重投是否启用.
    事件重新投递(事件重投, EventResend)可以将当前EventHandler的方法处理的事件再次投递给当前EventHandler再次进行处理, 通过事件重投, 可以做到例如让事件延迟处理的能力.
    
    参数:
    
    enable - 如果启用, 则EventHandler内的事件处理方法将可以调用resendCurrentEvent()重新投递当前任务到该EventHandler.
  - awaitTermination
```
public boolean awaitTermination(long timeout,
                                TimeUnit unit)
                         throws InterruptedException
```
    等待线程池内任务执行完成并关闭线程池.
    
    参数:
    
    timeout - 时间
    
    unit - 时间单位
    
    返回:
    
    如果在设置时间内线程池任务执行完成并关闭返回true, 否则返回false.
    
    抛出:
    
    InterruptedException - 当发生中断时抛出
  - setUncaughtExceptionHandler
```
public void setUncaughtExceptionHandler(Thread.UncaughtExceptionHandler handler)
```
    设置线程池异常处理类. EventExecutor在内部经过处理, 可以动态更改UncaughtExceptionHandler而不用担心设置后需要等线程重新建立后才生效. 注意: 如需捕获EventHandler方法抛出的异常请使用setEventUncaughtExceptionHandler(EventUncaughtExceptionHandler), 设置捕获EventHandler抛出的异常, 因EventExecutor内部处理, UncaughtExceptionHandler无法捕获InvocationTargetException异常来获取事件方法抛出的异常.
    
    参数:
    
    handler - 处理类对象
  - getThreadPoolExecutor
```
public ThreadPoolExecutor getThreadPoolExecutor()
```
    获取EventExecutor所使用的ThreadPoolExecutor
    
    返回:
    
    ThreadPoolExecutor对象
  - getExceptionHandler
```
public Thread.UncaughtExceptionHandler getExceptionHandler()
```
    获取设定的UncaughtExceptionHandler
    
    返回:
    
    返回设置的UncaughtExceptionHandler, 如无设置则返回null
  - shutdown
```
public List<Runnable> shutdown(boolean shutdownNow)
```
    关闭执行器.
    
    参数:
    
    shutdownNow - 是否立刻关闭
    
    返回:
    
    如果 shutdownNow为 true, 则返回线程池内未完成的事件任务.
  - setEventUncaughtExceptionHandler
```
public void setEventUncaughtExceptionHandler(EventUncaughtExceptionHandler handler)
```
    设置事件异常捕获处理对象. 该对象能详细获得
    
    参数:
    
    handler - 事件异常捕获处理对象
  - resendCurrentEvent
```
public static void resendCurrentEvent()
```
    重新投递当前任务到当前Handler.
    该操作不会将任务投递到其他Handler.
    注意: 该方法本身并不会阻止多次调用, 故事件处理方法需自行控制重新投递操作.
  - checkMethod
```
public static boolean checkMethod(Method method)
```
    检查指定方法是否为合法的事件接收方法
    
    参数:
    
    method - 待检查的方法
    
    返回:
    
    如果是合法的事件接收方法, 返回true
  - finalize
```
protected void finalize()
```
    覆盖:
    
    finalize 在类中 Object

类 EventExecutor

构造器概要

方法概要

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

构造器详细资料

EventExecutor

EventExecutor

方法详细资料

addHandler

removeHandler

executor

executorSync

executor

setEnableEventResend

awaitTermination

setUncaughtExceptionHandler

getThreadPoolExecutor

getExceptionHandler

shutdown

setEventUncaughtExceptionHandler

resendCurrentEvent

checkMethod

finalize