Package org.codehaus.groovy.transform

Class AbstractInterruptibleASTTransformation

java.lang.Object
org.codehaus.groovy.ast.CodeVisitorSupport
org.codehaus.groovy.ast.ClassCodeVisitorSupport
org.codehaus.groovy.transform.AbstractInterruptibleASTTransformation
All Implemented Interfaces:
GroovyClassVisitor, GroovyCodeVisitor, ASTTransformation, ErrorCollecting, org.objectweb.asm.Opcodes
public abstract class AbstractInterruptibleASTTransformation
extends ClassCodeVisitorSupport
implements ASTTransformation, org.objectweb.asm.Opcodes
Base class for AST Transformations which will automatically throw an InterruptedException when some conditions are met.
Since:
1.8.0

  • Field Details

    • CHECK_METHOD_START_MEMBER

      protected static final String CHECK_METHOD_START_MEMBER
      See Also:
      Constant Field Values

    • THROWN_EXCEPTION_TYPE

      protected static final String THROWN_EXCEPTION_TYPE
      See Also:
      Constant Field Values

    • source

      protected SourceUnit source

    • checkOnMethodStart

      protected boolean checkOnMethodStart

    • applyToAllClasses

      protected boolean applyToAllClasses

    • applyToAllMembers

      protected boolean applyToAllMembers

    • thrownExceptionType

      protected ClassNode thrownExceptionType

  • Constructor Details

    • AbstractInterruptibleASTTransformation

      public AbstractInterruptibleASTTransformation()

  • Method Details

    • getSourceUnit

      protected SourceUnit getSourceUnit()
      Specified by:
      getSourceUnit in class ClassCodeVisitorSupport

    • type

      protected abstract ClassNode type()

    • createCondition

      protected abstract Expression createCondition()
      Subclasses should implement this method to set the condition of the interruption statement

    • getErrorMessage

      protected abstract String getErrorMessage()
      Subclasses should implement this method to provide good error resolution.

    • setupTransform

      protected void setupTransform​(AnnotationNode node)

    • visit

      public void visit​(ASTNode[] nodes, SourceUnit source)
      Description copied from interface: ASTTransformation
      The method is invoked when an AST Transformation is active. For local transformations, it is invoked once each time the local annotation is encountered. For global transformations, it is invoked once for every source unit, which is typically a source file.
      Specified by:
      visit in interface ASTTransformation
      Parameters:
      nodes - The ASTnodes when the call was triggered. Element 0 is the AnnotationNode that triggered this annotation to be activated. Element 1 is the AnnotatedNode decorated, such as a MethodNode or ClassNode. For global transformations it is usually safe to ignore this parameter.
      source - The source unit being compiled. The source unit may contain several classes. For global transformations, information about the AST can be retrieved from this object.

    • getBooleanAnnotationParameter

      protected static boolean getBooleanAnnotationParameter​(AnnotationNode node, String parameterName, boolean defaultValue)

    • getClassAnnotationParameter

      protected static ClassNode getClassAnnotationParameter​(AnnotationNode node, String parameterName, ClassNode defaultValue)

    • internalError

      protected static void internalError​(String message)

    • createInterruptStatement

      protected Statement createInterruptStatement()
      Returns:
      Returns the interruption check statement.

    • wrapBlock

      protected final Statement wrapBlock​(Statement statement)
      Takes a statement and wraps it into a block statement which first element is the interruption check statement.
      Parameters:
      statement - the statement to be wrapped
      Returns:
      a block statement which first element is for checking interruption, and the second one the statement to be wrapped.

    • visitForLoop

      public final void visitForLoop​(ForStatement forStatement)
      Specified by:
      visitForLoop in interface GroovyCodeVisitor
      Overrides:
      visitForLoop in class ClassCodeVisitorSupport

    • visitDoWhileLoop

      public final void visitDoWhileLoop​(DoWhileStatement doWhileStatement)
      Specified by:
      visitDoWhileLoop in interface GroovyCodeVisitor
      Overrides:
      visitDoWhileLoop in class ClassCodeVisitorSupport

    • visitWhileLoop

      public final void visitWhileLoop​(WhileStatement whileStatement)
      Specified by:
      visitWhileLoop in interface GroovyCodeVisitor
      Overrides:
      visitWhileLoop in class ClassCodeVisitorSupport