org.netbeans.modules.parsing.spi.support

Class CancelSupport

java.lang.Object

org.netbeans.modules.parsing.spi.support.CancelSupport

public final class CancelSupport
extends Object

Provides a thread safe testing of the SchedulerTask canceling.

Recommended usage:

 
 public class MyTask extends ParserResultTask {
     private final CancelSupport cancel = CancelSupport.create(this);

     public void run (T result, SchedulerEvent event) {
         ...
         if (cancel.isCancelled()) {
             return;
         }
         ...
     }
 }
 
 

Since:

1.74

Method Summary

Modifier and Type	Method and Description
static CancelSupport	create(SchedulerTask owner) Creates a new instance of the CancelSupport.
boolean	isCancelled() Returns true if the owning task was canceled.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

isCancelled

public boolean isCancelled()

Returns true if the owning task was canceled.

Returns:

true when the owning task was canceled.

create

@NonNull
public static CancelSupport create(@NonNull
                                            SchedulerTask owner)

Creates a new instance of the CancelSupport.

Parameters:

owner - the owning SchedulerTask

Returns:

the newly created CancelSupport