org.dromara.hutool.cron

Class TaskTable

java.lang.Object

org.dromara.hutool.cron.TaskTable

All Implemented Interfaces:

Serializable

public class TaskTable
extends Object
implements Serializable

定时任务表
任务表将ID、表达式、任务一一对应，定时任务执行过程中，会周期性检查定时任务表中的所有任务表达式匹配情况，从而执行其对应的任务
任务的添加、移除使用读写锁保证线程安全性

Author:

Looly

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static int	DEFAULT_CAPACITY 默认任务表大小：10

Constructor Summary

Constructors

Constructor and Description
TaskTable() 构造
TaskTable(int initialCapacity) 构造

Method Summary

Modifier and Type	Method and Description
TaskTable	add(String id, CronPattern pattern, Task task) 新增Task
void	executeTaskIfMatch(Scheduler scheduler, long millis) 如果时间匹配则执行相应的Task，带读锁
protected void	executeTaskIfMatchInternal(Scheduler scheduler, long millis) 如果时间匹配则执行相应的Task，无锁
List<String>	getIds() 获取所有ID，返回不可变列表，即列表不可修改
CronPattern	getPattern(int index) 获得指定位置的CronPattern
CronPattern	getPattern(String id) 获得指定id的CronPattern
List<CronPattern>	getPatterns() 获取所有定时任务表达式，返回不可变列表，即列表不可修改
Task	getTask(int index) 获得指定位置的Task
Task	getTask(String id) 获得指定id的Task
List<Task>	getTasks() 获取所有定时任务，返回不可变列表，即列表不可修改
boolean	isEmpty() 任务表是否为空
boolean	remove(String id) 移除Task
int	size() 任务表大小，加入的任务数
String	toString()
boolean	updatePattern(String id, CronPattern pattern) 更新某个Task的定时规则

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

DEFAULT_CAPACITY

public static final int DEFAULT_CAPACITY

默认任务表大小：10

See Also:

Constant Field Values

Constructor Detail

TaskTable

public TaskTable()

构造

TaskTable

public TaskTable(int initialCapacity)

构造

Parameters:

initialCapacity - 容量，即预估的最大任务数

Method Detail

add

public TaskTable add(String id,
                     CronPattern pattern,
                     Task task)

新增Task

Parameters:

id - ID

pattern - CronPattern

task - Task

Returns:

this

getIds

public List<String> getIds()

获取所有ID，返回不可变列表，即列表不可修改

Returns:

ID列表

Since:

4.6.7

getPatterns

public List<CronPattern> getPatterns()

获取所有定时任务表达式，返回不可变列表，即列表不可修改

Returns:

定时任务表达式列表

Since:

4.6.7

getTasks

public List<Task> getTasks()

获取所有定时任务，返回不可变列表，即列表不可修改

Returns:

定时任务列表

Since:

4.6.7

remove

public boolean remove(String id)

移除Task

Parameters:

id - Task的ID

Returns:

是否成功移除，false表示未找到对应ID的任务

updatePattern

public boolean updatePattern(String id,
                             CronPattern pattern)

更新某个Task的定时规则

Parameters:

id - Task的ID

pattern - 新的表达式

Returns:

是否更新成功，如果id对应的规则不存在则不更新

Since:

4.0.10

getTask

public Task getTask(int index)

获得指定位置的Task

Parameters:

index - 位置

Returns:

Task

Since:

3.1.1

getTask

public Task getTask(String id)

获得指定id的Task

Parameters:

id - ID

Returns:

Task

Since:

3.1.1

getPattern

public CronPattern getPattern(String id)

获得指定id的CronPattern

Parameters:

id - ID

Returns:

CronPattern

Since:

3.1.1

getPattern

public CronPattern getPattern(int index)

获得指定位置的CronPattern

Parameters:

index - 位置

Returns:

CronPattern

Since:

3.1.1

size

public int size()

任务表大小，加入的任务数

Returns:

任务表大小，加入的任务数

Since:

4.0.2

isEmpty

public boolean isEmpty()

任务表是否为空

Returns:

true为空

Since:

4.0.2

executeTaskIfMatch

public void executeTaskIfMatch(Scheduler scheduler,
                               long millis)

如果时间匹配则执行相应的Task，带读锁

Parameters:

scheduler - Scheduler

millis - 时间毫秒

toString

public String toString()

Overrides:

toString in class Object

executeTaskIfMatchInternal

protected void executeTaskIfMatchInternal(Scheduler scheduler,
                                          long millis)

如果时间匹配则执行相应的Task，无锁

Parameters:

scheduler - Scheduler

millis - 时间毫秒

Since:

3.1.1