001/* 002 * Copyright 2002-2016 the original author or authors. 003 * 004 * Licensed under the Apache License, Version 2.0 (the "License"); 005 * you may not use this file except in compliance with the License. 006 * You may obtain a copy of the License at 007 * 008 * https://www.apache.org/licenses/LICENSE-2.0 009 * 010 * Unless required by applicable law or agreed to in writing, software 011 * distributed under the License is distributed on an "AS IS" BASIS, 012 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 013 * See the License for the specific language governing permissions and 014 * limitations under the License. 015 */ 016 017package org.springframework.scheduling.config; 018 019import java.util.concurrent.ScheduledFuture; 020 021/** 022 * A representation of a scheduled task, 023 * used as a return value for scheduling methods. 024 * 025 * @author Juergen Hoeller 026 * @since 4.3 027 * @see ScheduledTaskRegistrar#scheduleTriggerTask 028 * @see ScheduledTaskRegistrar#scheduleFixedRateTask 029 */ 030public final class ScheduledTask { 031 032 volatile ScheduledFuture<?> future; 033 034 035 ScheduledTask() { 036 } 037 038 039 /** 040 * Trigger cancellation of this scheduled task. 041 */ 042 public void cancel() { 043 ScheduledFuture<?> future = this.future; 044 if (future != null) { 045 future.cancel(true); 046 } 047 } 048 049}