org.springframework.scheduling.config.ScheduledTask Maven / Gradle / Ivy
/*
* Copyright 2002-2024 the original author or authors.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* https://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package org.springframework.scheduling.config;
import java.time.Instant;
import java.util.concurrent.ScheduledFuture;
import java.util.concurrent.TimeUnit;
import org.springframework.lang.Nullable;
/**
* A representation of a scheduled task at runtime,
* used as a return value for scheduling methods.
*
* @author Juergen Hoeller
* @author Brian Clozel
* @since 4.3
* @see ScheduledTaskRegistrar#scheduleCronTask(CronTask)
* @see ScheduledTaskRegistrar#scheduleFixedRateTask(FixedRateTask)
* @see ScheduledTaskRegistrar#scheduleFixedDelayTask(FixedDelayTask)
* @see ScheduledFuture
*/
public final class ScheduledTask {
private final Task task;
@Nullable
volatile ScheduledFuture future;
ScheduledTask(Task task) {
this.task = task;
}
/**
* Return the underlying task (typically a {@link CronTask},
* {@link FixedRateTask} or {@link FixedDelayTask}).
* @since 5.0.2
*/
public Task getTask() {
return this.task;
}
/**
* Trigger cancellation of this scheduled task.
* This variant will force interruption of the task if still running.
* @see #cancel(boolean)
*/
public void cancel() {
cancel(true);
}
/**
* Trigger cancellation of this scheduled task.
* @param mayInterruptIfRunning whether to force interruption of the task
* if still running (specify {@code false} to allow the task to complete)
* @since 5.3.18
* @see ScheduledFuture#cancel(boolean)
*/
public void cancel(boolean mayInterruptIfRunning) {
ScheduledFuture future = this.future;
if (future != null) {
future.cancel(mayInterruptIfRunning);
}
}
/**
* Return the next scheduled execution of the task, or {@code null}
* if the task has been cancelled or no new execution is scheduled.
* @since 6.2
*/
@Nullable
public Instant nextExecution() {
ScheduledFuture future = this.future;
if (future != null && !future.isCancelled()) {
long delay = future.getDelay(TimeUnit.MILLISECONDS);
if (delay > 0) {
return Instant.now().plusMillis(delay);
}
}
return null;
}
@Override
public String toString() {
return this.task.toString();
}
}