https://openjdk.java.net/ 
/*
 * Copyright (c) 2020, Oracle and/or its affiliates. All rights reserved.
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
 *
 * This code is free software; you can redistribute it and/or modify it
 * under the terms of the GNU General Public License version 2 only, as
 * published by the Free Software Foundation.  Oracle designates this
 * particular file as subject to the "Classpath" exception as provided
 * by Oracle in the LICENSE file that accompanied this code.
 *
 * This code is distributed in the hope that it will be useful, but WITHOUT
 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
 * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
 * version 2 for more details (a copy is included in the LICENSE file that
 * accompanied this code).
 *
 * You should have received a copy of the GNU General Public License version
 * 2 along with this work; if not, write to the Free Software Foundation,
 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
 *
 * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
 * or visit www.oracle.com if you need additional information or have any
 * questions.
 */
package jdk.internal.net.http.common;


A functional interface that allows to request cancellation
of a task - which may or may not have already started.

/**
 * A functional interface that allows to request cancellation
 * of a task - which may or may not have already started.
 */
@FunctionalInterface
public interface Cancelable {
    
Attempts to cancel execution of a task.  This attempt may not
succeed if the task has already completed, has already been cancelled,
or could not be cancelled for some other reason.

Params:
  • mayInterruptIfRunning – true if an attempt to stop the task should be made even if the task has already started; otherwise, in-progress tasks are allowed to complete.
Returns:false if the task could not be cancelled, typically because it has already completed normally; true otherwise
/**
     * Attempts to cancel execution of a task.  This attempt may not
     * succeed if the task has already completed, has already been cancelled,
     * or could not be cancelled for some other reason.
     *
     * @param mayInterruptIfRunning {@code true} if an attempt to stop the
     * task should be made even if the task has already started; otherwise,
     * in-progress tasks are allowed to complete.
     *
     * @return {@code false} if the task could not be cancelled,
     * typically because it has already completed normally;
     * {@code true} otherwise
     */
    boolean cancel(boolean mayInterruptIfRunning);
}