Thu, 31 Aug 2017 15:18:52 +0800
merge
1 /*
2 * Copyright (c) 1997, 2012, Oracle and/or its affiliates. All rights reserved.
3 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
4 *
5 * This code is free software; you can redistribute it and/or modify it
6 * under the terms of the GNU General Public License version 2 only, as
7 * published by the Free Software Foundation. Oracle designates this
8 * particular file as subject to the "Classpath" exception as provided
9 * by Oracle in the LICENSE file that accompanied this code.
10 *
11 * This code is distributed in the hope that it will be useful, but WITHOUT
12 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
13 * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
14 * version 2 for more details (a copy is included in the LICENSE file that
15 * accompanied this code).
16 *
17 * You should have received a copy of the GNU General Public License version
18 * 2 along with this work; if not, write to the Free Software Foundation,
19 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
20 *
21 * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
22 * or visit www.oracle.com if you need additional information or have any
23 * questions.
24 */
26 package com.sun.xml.internal.ws.api;
28 /**
29 * Interface for tasks that may be cancelled
30 *
31 * @since 2.2.6
32 */
33 public interface Cancelable {
34 /**
35 * Attempts to cancel execution of this task. This attempt will
36 * fail if the task has already completed, has already been cancelled,
37 * or could not be cancelled for some other reason. If successful,
38 * and this task has not started when <tt>cancel</tt> is called,
39 * this task should never run. If the task has already started,
40 * then the <tt>mayInterruptIfRunning</tt> parameter determines
41 * whether the thread executing this task should be interrupted in
42 * an attempt to stop the task.
43 *
44 * @param mayInterruptIfRunning <tt>true</tt> if the thread executing this
45 * task should be interrupted; otherwise, in-progress tasks are allowed
46 * to complete
47 * @return <tt>false</tt> if the task could not be cancelled,
48 * typically because it has already completed normally;
49 * <tt>true</tt> otherwise
50 */
51 public void cancel(boolean mayInterruptIfRunning);
52 }