org.springframework.scheduling.config.ScheduledTask Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of spring-context Show documentation

Spring Context

There is a newer version: 6.2.2

/*
 * Copyright 2002-2016 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
 *
 *      http://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.util.concurrent.ScheduledFuture;

/**
 * A representation of a scheduled task,
 * used as a return value for scheduling methods.
 *
 * @author Juergen Hoeller
 * @since 4.3
 * @see ScheduledTaskRegistrar#scheduleTriggerTask
 * @see ScheduledTaskRegistrar#scheduleFixedRateTask
 */
public final class ScheduledTask {

	volatile ScheduledFuture future;


	ScheduledTask() {
	}


	/**
	 * Trigger cancellation of this scheduled task.
	 */
	public void cancel() {
		ScheduledFuture future = this.future;
		if (future != null) {
			future.cancel(true);
		}
	}

}