/*
 * Copyright (c) 2011, 2018, 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.
 *
 * 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 org.graalvm.compiler.nodes;

import org.graalvm.compiler.core.common.CancellationBailoutException;

An interface for supporting co-operative cancellation of tasks. An external entity gives a Cancellable to a task and the task polls the Cancellable at regular intervals. If isCancelled returns true, then the task will promptly terminate by means of throwing a CancellationBailoutException.
/** * An interface for supporting co-operative cancellation of tasks. An external entity gives a * Cancellable to a task and the task polls the Cancellable at regular intervals. If * {@link #isCancelled} returns true, then the task will promptly terminate by means of throwing a * {@link CancellationBailoutException}. */
public interface Cancellable {
Determines if this task has been cancelled.
/** * Determines if this task has been cancelled. */
boolean isCancelled(); }