src/share/jaxws_classes/com/sun/xml/internal/ws/api/Cancelable.java

changeset 286
f50545b5e2f1
child 368
0989ad8c0860
     1.1 --- /dev/null	Thu Jan 01 00:00:00 1970 +0000
     1.2 +++ b/src/share/jaxws_classes/com/sun/xml/internal/ws/api/Cancelable.java	Tue Mar 06 16:09:35 2012 -0800
     1.3 @@ -0,0 +1,52 @@
     1.4 +/*
     1.5 + * Copyright (c) 1997, 2011, Oracle and/or its affiliates. All rights reserved.
     1.6 + * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
     1.7 + *
     1.8 + * This code is free software; you can redistribute it and/or modify it
     1.9 + * under the terms of the GNU General Public License version 2 only, as
    1.10 + * published by the Free Software Foundation.  Oracle designates this
    1.11 + * particular file as subject to the "Classpath" exception as provided
    1.12 + * by Oracle in the LICENSE file that accompanied this code.
    1.13 + *
    1.14 + * This code is distributed in the hope that it will be useful, but WITHOUT
    1.15 + * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
    1.16 + * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
    1.17 + * version 2 for more details (a copy is included in the LICENSE file that
    1.18 + * accompanied this code).
    1.19 + *
    1.20 + * You should have received a copy of the GNU General Public License version
    1.21 + * 2 along with this work; if not, write to the Free Software Foundation,
    1.22 + * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
    1.23 + *
    1.24 + * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
    1.25 + * or visit www.oracle.com if you need additional information or have any
    1.26 + * questions.
    1.27 + */
    1.28 +
    1.29 +package com.sun.xml.internal.ws.api;
    1.30 +
    1.31 +/**
    1.32 + * Interface for tasks that may be cancelled
    1.33 + *
    1.34 + * @since 2.2.6
    1.35 + */
    1.36 +public interface Cancelable {
    1.37 +    /**
    1.38 +     * Attempts to cancel execution of this task.  This attempt will
    1.39 +     * fail if the task has already completed, has already been cancelled,
    1.40 +     * or could not be cancelled for some other reason. If successful,
    1.41 +     * and this task has not started when <tt>cancel</tt> is called,
    1.42 +     * this task should never run.  If the task has already started,
    1.43 +     * then the <tt>mayInterruptIfRunning</tt> parameter determines
    1.44 +     * whether the thread executing this task should be interrupted in
    1.45 +     * an attempt to stop the task.
    1.46 +     *
    1.47 +     * @param mayInterruptIfRunning <tt>true</tt> if the thread executing this
    1.48 +     * task should be interrupted; otherwise, in-progress tasks are allowed
    1.49 +     * to complete
    1.50 +     * @return <tt>false</tt> if the task could not be cancelled,
    1.51 +     * typically because it has already completed normally;
    1.52 +     * <tt>true</tt> otherwise
    1.53 +     */
    1.54 +        public void cancel(boolean mayInterruptIfRunning);
    1.55 +}

mercurial