All Implemented Interfaces and Traits:

Annotation

@DocumentedDocumented
@RetentionRetention
@TargetTarget
@GroovyASTTransformationClassGroovyASTTransformationClass
@interface ThreadInterrupt

Allows "interrupt-safe" executions of scripts by adding Thread.currentThread().isInterrupted() checks into loops (for, while) and at the start of closures and methods.

This is especially useful when executing foreign scripts that you do not have control over. Inject this transformation into a script that you need to interrupt.

Annotating anything in a script will cause for loops, while loops, methods, and closures to make an isInterruptedCheck and throw a InterruptedException if the check yields true. The annotation by default will apply to any classes defined in the script as well. Annotated a class will cause (by default) all classes in the entire file ('Compilation Unit') to be enhanced. You can fine tune what is enhanced using the annotation parameters.

The following is sample usage of the annotation:

 @groovy.transform.ThreadInterrupt
 def scriptMethod() {
   4.times {
     println 'executing script method...'
   }
 }

 class MyClass {
   def myMethod() {
     for (i in (1..10)) {
       println 'executing method...'
     }
   }
 }

 scriptMethod()
 new MyClass().myMethod()
 

 public class script1290627909406 extends groovy.lang.Script {

     public java.lang.Object scriptMethod() {
         if (java.lang.Thread.currentThread().isInterrupted()) {
             throw new java.lang.InterruptedException('Execution Interrupted')
         }
         4.times({
             if (java.lang.Thread.currentThread().isInterrupted()) {
                 throw new java.lang.InterruptedException('Execution Interrupted')
             }
             this.println('executing script method...')
         })
     }
 }
 public class MyClass extends java.lang.Object {

   public java.lang.Object myMethod() {
     if (java.lang.Thread.currentThread().isInterrupted()) {
       throw new java.lang.InterruptedException('Execution Interrupted')
     }
     for (java.lang.Object i : (1..10)) {
       if (java.lang.Thread.currentThread().isInterrupted()) {
         throw new java.lang.InterruptedException('Execution Interrupted')
       }
       this.println('executing method...')
     }
   }
 }

 this.scriptMethod()
 new MyClass().myMethod()
 

See Also:

TimedInterrupt

ConditionalInterrupt

Since:

1.8.0