模块 wjybxx.commons.concurrent

程序包 cn.wjybxx.concurrent

类 ScheduledTaskBuilder<V>

java.lang.Object

cn.wjybxx.concurrent.TaskOptionBuilder

cn.wjybxx.concurrent.TaskBuilder<V>

cn.wjybxx.concurrent.ScheduledTaskBuilder<V>

@NotThreadSafe
public final class ScheduledTaskBuilder<V>
extends TaskBuilder<V>

该对象为临时对象，应避免共享

作者:

wjybxx date 2023/4/14

字段概要

字段

修饰符和类型	字段	说明
static final byte	SCHEDULE_DYNAMIC_DELAY	动态延迟 -- 每次执行后计算下一次的延迟
static final byte	SCHEDULE_FIXED_DELAY	固定延迟 -- 两次执行的间隔大于等于给定的延迟
static final byte	SCHEDULE_FIXED_RATE	固定频率 -- 执行次数
static final byte	SCHEDULE_ONCE	执行一次

从类继承的字段 cn.wjybxx.concurrent.TaskBuilder

TYPE_ACTION, TYPE_ACTION_CTX, TYPE_FUNC, TYPE_FUNC_CTX, TYPE_TASK, TYPE_TIMESHARING

构造器概要

构造器

构造器	说明
ScheduledTaskBuilder(TaskBuilder<? extends V> taskBuilder)

方法概要

修饰符和类型	方法	说明
ScheduledTaskBuilder<V>	disable(int taskOption)	禁用选项
ScheduledTaskBuilder<V>	enable(int taskOption)	启用选项
long	getInitialDelay()
long	getPeriod()
int	getScheduleType()
long	getTimeout()
TimeUnit	getTimeUnit()
boolean	hasTimeout()	是否设置了超时时间
boolean	isFixedDelay()
boolean	isFixedRate()
boolean	isOnlyOnce()
boolean	isPeriodic()
static ScheduledTaskBuilder<?>	newAction(Runnable task)
static <V> ScheduledTaskBuilder<V>	newAction(Consumer<IContext> task, IContext ctx)
static <V> ScheduledTaskBuilder<V>	newFunc(Callable<? extends V> task)
static <V> ScheduledTaskBuilder<V>	newFunc(Function<IContext,? extends V> task, IContext ctx)
static <V> ScheduledTaskBuilder<V>	newTimeSharing(TimeSharingTask<? super V> task)
static <V> ScheduledTaskBuilder<V>	newTimeSharing(TimeSharingTask<? super V> task, IContext ctx)
TaskBuilder<V>	setCtx(IContext ctx)	任务的上下文 即使用户的任务不接收ctx，executor也可能需要
ScheduledTaskBuilder<V>	setFixedDelay(long initialDelay, long period)
ScheduledTaskBuilder<V>	setFixedDelay(long initialDelay, long period, TimeUnit unit)
ScheduledTaskBuilder<V>	setFixedRate(long initialDelay, long period)
ScheduledTaskBuilder<V>	setFixedRate(long initialDelay, long period, TimeUnit unit)
ScheduledTaskBuilder<V>	setOnlyOnce(long delay)
ScheduledTaskBuilder<V>	setOnlyOnce(long delay, TimeUnit unit)
ScheduledTaskBuilder<V>	setOptions(int options)
ScheduledTaskBuilder<V>	setPriority(int priority)	设置任务的优先级
ScheduledTaskBuilder<V>	setSchedulePhase(int phase)
ScheduledTaskBuilder<V>	setTimeout(long timeout)	设置周期性任务的超时时间（非分时任务也可以）
ScheduledTaskBuilder<V>	setTimeoutByCount(int count)	通过预估执行次数限制超时时间 该方法对于fixedRate类型的任务有帮助
ScheduledTaskBuilder<V>	setTimeUnit(TimeUnit timeUnit)	设置时间单位
static void	validateInitialDelay(long initialDelay)	适用于禁止初始延迟小于0的情况
static void	validatePeriod(long period)

从类继承的方法 cn.wjybxx.concurrent.TaskBuilder

getCtx, getTask, getType, taskType, toScheduledBuilder

从类继承的方法 cn.wjybxx.concurrent.TaskOptionBuilder

getOptions, getPriority, getSchedulePhase

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

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

字段详细资料

SCHEDULE_ONCE

public static final byte SCHEDULE_ONCE

执行一次

另请参阅:

• 常量字段值

SCHEDULE_FIXED_DELAY

public static final byte SCHEDULE_FIXED_DELAY

固定延迟 -- 两次执行的间隔大于等于给定的延迟

另请参阅:

• 常量字段值

SCHEDULE_FIXED_RATE

public static final byte SCHEDULE_FIXED_RATE

固定频率 -- 执行次数

另请参阅:

• 常量字段值

SCHEDULE_DYNAMIC_DELAY

public static final byte SCHEDULE_DYNAMIC_DELAY

动态延迟 -- 每次执行后计算下一次的延迟

另请参阅:

• 常量字段值

构造器详细资料

ScheduledTaskBuilder

public ScheduledTaskBuilder(TaskBuilder<? extends V> taskBuilder)

方法详细资料

newAction

public static ScheduledTaskBuilder<?> newAction(Runnable task)

newAction

public static <V> ScheduledTaskBuilder<V> newAction(Consumer<IContext> task,
 IContext ctx)

newFunc

public static <V> ScheduledTaskBuilder<V> newFunc(Callable<? extends V> task)

newFunc

public static <V> ScheduledTaskBuilder<V> newFunc(Function<IContext,? extends V> task,
 IContext ctx)

newTimeSharing

public static <V> ScheduledTaskBuilder<V> newTimeSharing(TimeSharingTask<? super V> task)

newTimeSharing

public static <V> ScheduledTaskBuilder<V> newTimeSharing(TimeSharingTask<? super V> task,
 IContext ctx)

validateInitialDelay

public static void validateInitialDelay(long initialDelay)

适用于禁止初始延迟小于0的情况

validatePeriod

public static void validatePeriod(long period)

getScheduleType

public int getScheduleType()

getInitialDelay

public long getInitialDelay()

getPeriod

public long getPeriod()

isPeriodic

public boolean isPeriodic()

isOnlyOnce

public boolean isOnlyOnce()

setOnlyOnce

public ScheduledTaskBuilder<V> setOnlyOnce(long delay)

setOnlyOnce

public ScheduledTaskBuilder<V> setOnlyOnce(long delay,
 TimeUnit unit)

isFixedDelay

public boolean isFixedDelay()

setFixedDelay

public ScheduledTaskBuilder<V> setFixedDelay(long initialDelay,
 long period)

setFixedDelay

public ScheduledTaskBuilder<V> setFixedDelay(long initialDelay,
 long period,
 TimeUnit unit)

isFixedRate

public boolean isFixedRate()

setFixedRate

public ScheduledTaskBuilder<V> setFixedRate(long initialDelay,
 long period)

setFixedRate

public ScheduledTaskBuilder<V> setFixedRate(long initialDelay,
 long period,
 TimeUnit unit)

setTimeout

public ScheduledTaskBuilder<V> setTimeout(long timeout)

设置周期性任务的超时时间（非分时任务也可以）

注意： 1. -1表示无限制，大于等于0表示有限制 2. 我们总是在执行任务后检查是否超时，以确保至少会执行一次 3. 超时是一个不准确的调度，不保证超时后能立即结束

setTimeoutByCount

public ScheduledTaskBuilder<V> setTimeoutByCount(int count)

通过预估执行次数限制超时时间 该方法对于fixedRate类型的任务有帮助

参数:

count - 期望的执行次数

getTimeout

public long getTimeout()

hasTimeout

public boolean hasTimeout()

是否设置了超时时间

setTimeUnit

public ScheduledTaskBuilder<V> setTimeUnit(TimeUnit timeUnit)

设置时间单位

getTimeUnit

public TimeUnit getTimeUnit()

enable

public ScheduledTaskBuilder<V> enable(int taskOption)

从类复制的说明: TaskOptionBuilder

启用选项

覆盖:

enable 在类中 TaskBuilder<V>

disable

public ScheduledTaskBuilder<V> disable(int taskOption)

从类复制的说明: TaskOptionBuilder

禁用选项

覆盖:

disable 在类中 TaskBuilder<V>

setSchedulePhase

public ScheduledTaskBuilder<V> setSchedulePhase(int phase)

覆盖:

setSchedulePhase 在类中 TaskBuilder<V>

参数:

phase - 任务的调度阶段

setPriority

public ScheduledTaskBuilder<V> setPriority(int priority)

从类复制的说明: TaskOptionBuilder

设置任务的优先级

覆盖:

setPriority 在类中 TaskBuilder<V>

setOptions

public ScheduledTaskBuilder<V> setOptions(int options)

覆盖:

setOptions 在类中 TaskBuilder<V>

setCtx

public TaskBuilder<V> setCtx(IContext ctx)

从类复制的说明: TaskBuilder

任务的上下文 即使用户的任务不接收ctx，executor也可能需要

覆盖:

setCtx 在类中 TaskBuilder<V>