< prev index next >

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

Print this page




  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  */
  25 
  26 package com.sun.xml.internal.ws.api;
  27 
  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 }


  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  */
  25 
  26 package com.sun.xml.internal.ws.api;
  27 
  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 {@code cancel} is called,
  39      * this task should never run.  If the task has already started,
  40      * then the {@code mayInterruptIfRunning} parameter determines
  41      * whether the thread executing this task should be interrupted in
  42      * an attempt to stop the task.
  43      *
  44      * @param mayInterruptIfRunning {@code true} if the thread executing this
  45      * task should be interrupted; otherwise, in-progress tasks are allowed
  46      * to complete
  47      * @return {@code false} if the task could not be cancelled,
  48      * typically because it has already completed normally;
  49      * {@code true} otherwise
  50      */
  51         public void cancel(boolean mayInterruptIfRunning);
  52 }
< prev index next >