ohair@286: /*
alanb@368:  * Copyright (c) 1997, 2012, Oracle and/or its affiliates. All rights reserved.
ohair@286:  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
ohair@286:  *
ohair@286:  * This code is free software; you can redistribute it and/or modify it
ohair@286:  * under the terms of the GNU General Public License version 2 only, as
ohair@286:  * published by the Free Software Foundation.  Oracle designates this
ohair@286:  * particular file as subject to the "Classpath" exception as provided
ohair@286:  * by Oracle in the LICENSE file that accompanied this code.
ohair@286:  *
ohair@286:  * This code is distributed in the hope that it will be useful, but WITHOUT
ohair@286:  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
ohair@286:  * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
ohair@286:  * version 2 for more details (a copy is included in the LICENSE file that
ohair@286:  * accompanied this code).
ohair@286:  *
ohair@286:  * You should have received a copy of the GNU General Public License version
ohair@286:  * 2 along with this work; if not, write to the Free Software Foundation,
ohair@286:  * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
ohair@286:  *
ohair@286:  * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
ohair@286:  * or visit www.oracle.com if you need additional information or have any
ohair@286:  * questions.
ohair@286:  */
ohair@286: 
ohair@286: package com.sun.xml.internal.ws.api;
ohair@286: 
ohair@286: /**
ohair@286:  * Interface for tasks that may be cancelled
ohair@286:  *
ohair@286:  * @since 2.2.6
ohair@286:  */
ohair@286: public interface Cancelable {
ohair@286:     /**
ohair@286:      * Attempts to cancel execution of this task.  This attempt will
ohair@286:      * fail if the task has already completed, has already been cancelled,
ohair@286:      * or could not be cancelled for some other reason. If successful,
ohair@286:      * and this task has not started when <tt>cancel</tt> is called,
ohair@286:      * this task should never run.  If the task has already started,
ohair@286:      * then the <tt>mayInterruptIfRunning</tt> parameter determines
ohair@286:      * whether the thread executing this task should be interrupted in
ohair@286:      * an attempt to stop the task.
ohair@286:      *
ohair@286:      * @param mayInterruptIfRunning <tt>true</tt> if the thread executing this
ohair@286:      * task should be interrupted; otherwise, in-progress tasks are allowed
ohair@286:      * to complete
ohair@286:      * @return <tt>false</tt> if the task could not be cancelled,
ohair@286:      * typically because it has already completed normally;
ohair@286:      * <tt>true</tt> otherwise
ohair@286:      */
ohair@286:         public void cancel(boolean mayInterruptIfRunning);
ohair@286: }