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 anInterruptedExceptionwhen some conditions are met.- Since:
- 1.8.0
 
- 
- 
Field SummaryFields Modifier and Type Field Description protected booleanapplyToAllClassesprotected booleanapplyToAllMembersprotected static java.lang.StringCHECK_METHOD_START_MEMBERprotected booleancheckOnMethodStartprotected SourceUnitsourceprotected static java.lang.StringTHROWN_EXCEPTION_TYPEprotected ClassNodethrownExceptionType- 
Fields inherited from interface org.objectweb.asm.OpcodesAALOAD, AASTORE, ACC_ABSTRACT, ACC_ANNOTATION, ACC_BRIDGE, ACC_DEPRECATED, ACC_ENUM, ACC_FINAL, ACC_INTERFACE, ACC_MANDATED, ACC_MODULE, ACC_NATIVE, ACC_OPEN, ACC_PRIVATE, ACC_PROTECTED, ACC_PUBLIC, ACC_RECORD, ACC_STATIC, ACC_STATIC_PHASE, ACC_STRICT, ACC_SUPER, ACC_SYNCHRONIZED, ACC_SYNTHETIC, ACC_TRANSIENT, ACC_TRANSITIVE, ACC_VARARGS, ACC_VOLATILE, ACONST_NULL, ALOAD, ANEWARRAY, ARETURN, ARRAYLENGTH, ASM10_EXPERIMENTAL, ASM4, ASM5, ASM6, ASM7, ASM8, ASM9, ASTORE, ATHROW, BALOAD, BASTORE, BIPUSH, CALOAD, CASTORE, CHECKCAST, D2F, D2I, D2L, DADD, DALOAD, DASTORE, DCMPG, DCMPL, DCONST_0, DCONST_1, DDIV, DLOAD, DMUL, DNEG, DOUBLE, DREM, DRETURN, DSTORE, DSUB, DUP, DUP_X1, DUP_X2, DUP2, DUP2_X1, DUP2_X2, F_APPEND, F_CHOP, F_FULL, F_NEW, F_SAME, F_SAME1, F2D, F2I, F2L, FADD, FALOAD, FASTORE, FCMPG, FCMPL, FCONST_0, FCONST_1, FCONST_2, FDIV, FLOAD, FLOAT, FMUL, FNEG, FREM, FRETURN, FSTORE, FSUB, GETFIELD, GETSTATIC, GOTO, H_GETFIELD, H_GETSTATIC, H_INVOKEINTERFACE, H_INVOKESPECIAL, H_INVOKESTATIC, H_INVOKEVIRTUAL, H_NEWINVOKESPECIAL, H_PUTFIELD, H_PUTSTATIC, I2B, I2C, I2D, I2F, I2L, I2S, IADD, IALOAD, IAND, IASTORE, ICONST_0, ICONST_1, ICONST_2, ICONST_3, ICONST_4, ICONST_5, ICONST_M1, IDIV, IF_ACMPEQ, IF_ACMPNE, IF_ICMPEQ, IF_ICMPGE, IF_ICMPGT, IF_ICMPLE, IF_ICMPLT, IF_ICMPNE, IFEQ, IFGE, IFGT, IFLE, IFLT, IFNE, IFNONNULL, IFNULL, IINC, ILOAD, IMUL, INEG, INSTANCEOF, INTEGER, INVOKEDYNAMIC, INVOKEINTERFACE, INVOKESPECIAL, INVOKESTATIC, INVOKEVIRTUAL, IOR, IREM, IRETURN, ISHL, ISHR, ISTORE, ISUB, IUSHR, IXOR, JSR, L2D, L2F, L2I, LADD, LALOAD, LAND, LASTORE, LCMP, LCONST_0, LCONST_1, LDC, LDIV, LLOAD, LMUL, LNEG, LONG, LOOKUPSWITCH, LOR, LREM, LRETURN, LSHL, LSHR, LSTORE, LSUB, LUSHR, LXOR, MONITORENTER, MONITOREXIT, MULTIANEWARRAY, NEW, NEWARRAY, NOP, NULL, POP, POP2, PUTFIELD, PUTSTATIC, RET, RETURN, SALOAD, SASTORE, SIPUSH, SOURCE_DEPRECATED, SOURCE_MASK, SWAP, T_BOOLEAN, T_BYTE, T_CHAR, T_DOUBLE, T_FLOAT, T_INT, T_LONG, T_SHORT, TABLESWITCH, TOP, UNINITIALIZED_THIS, V_PREVIEW, V1_1, V1_2, V1_3, V1_4, V1_5, V1_6, V1_7, V1_8, V10, V11, V12, V13, V14, V15, V16, V17, V18, V19, V20, V21, V9
 
- 
 - 
Constructor SummaryConstructors Constructor Description AbstractInterruptibleASTTransformation()
 - 
Method SummaryAll Methods Static Methods Instance Methods Abstract Methods Concrete Methods Modifier and Type Method Description protected abstract ExpressioncreateCondition()Subclasses should implement this method to set the condition of the interruption statementprotected StatementcreateInterruptStatement()protected static booleangetBooleanAnnotationParameter(AnnotationNode node, java.lang.String parameterName, boolean defaultValue)protected static ClassNodegetClassAnnotationParameter(AnnotationNode node, java.lang.String parameterName, ClassNode defaultValue)protected abstract java.lang.StringgetErrorMessage()Subclasses should implement this method to provide good error resolution.protected SourceUnitgetSourceUnit()protected static voidinternalError(java.lang.String message)protected voidsetupTransform(AnnotationNode node)protected abstract ClassNodetype()voidvisit(ASTNode[] nodes, SourceUnit source)The method is invoked when an AST Transformation is active.voidvisitDoWhileLoop(DoWhileStatement doWhileStatement)voidvisitForLoop(ForStatement forStatement)voidvisitWhileLoop(WhileStatement whileStatement)protected StatementwrapBlock(Statement statement)Takes a statement and wraps it into a block statement which first element is the interruption check statement.- 
Methods inherited from class org.codehaus.groovy.ast.ClassCodeVisitorSupportaddError, visitAnnotations, visitAssertStatement, visitBlockStatement, visitBreakStatement, visitCaseStatement, visitCatchStatement, visitClass, visitClassCodeContainer, visitConstructor, visitConstructorOrMethod, visitContinueStatement, visitDeclarationExpression, visitExpressionStatement, visitField, visitIfElse, visitImports, visitMethod, visitObjectInitializerStatements, visitPackage, visitProperty, visitReturnStatement, visitStatement, visitSwitch, visitSynchronizedStatement, visitThrowStatement, visitTryCatchFinally
 - 
Methods inherited from class org.codehaus.groovy.ast.CodeVisitorSupportvisitArgumentlistExpression, visitArrayExpression, visitAttributeExpression, visitBinaryExpression, visitBitwiseNegationExpression, visitBooleanExpression, visitBytecodeExpression, visitCastExpression, visitClassExpression, visitClosureExpression, visitClosureListExpression, visitConstantExpression, visitConstructorCallExpression, visitEmptyStatement, visitFieldExpression, visitGStringExpression, visitListExpression, visitListOfExpressions, visitMapEntryExpression, visitMapExpression, visitMethodCallExpression, visitMethodPointerExpression, visitNotExpression, visitPostfixExpression, visitPrefixExpression, visitPropertyExpression, visitRangeExpression, visitShortTernaryExpression, visitSpreadExpression, visitSpreadMapExpression, visitStaticMethodCallExpression, visitTernaryExpression, visitTupleExpression, visitUnaryMinusExpression, visitUnaryPlusExpression, visitVariableExpression
 
- 
 
- 
- 
- 
Field Detail- 
CHECK_METHOD_START_MEMBERprotected static final java.lang.String CHECK_METHOD_START_MEMBER - See Also:
- Constant Field Values
 
 - 
THROWN_EXCEPTION_TYPEprotected static final java.lang.String THROWN_EXCEPTION_TYPE - See Also:
- Constant Field Values
 
 - 
sourceprotected SourceUnit source 
 - 
checkOnMethodStartprotected boolean checkOnMethodStart 
 - 
applyToAllClassesprotected boolean applyToAllClasses 
 - 
applyToAllMembersprotected boolean applyToAllMembers 
 - 
thrownExceptionTypeprotected ClassNode thrownExceptionType 
 
- 
 - 
Method Detail- 
getSourceUnitprotected SourceUnit getSourceUnit() - Specified by:
- getSourceUnitin class- ClassCodeVisitorSupport
 
 - 
typeprotected abstract ClassNode type() 
 - 
createConditionprotected abstract Expression createCondition() Subclasses should implement this method to set the condition of the interruption statement
 - 
getErrorMessageprotected abstract java.lang.String getErrorMessage() Subclasses should implement this method to provide good error resolution.
 - 
setupTransformprotected void setupTransform(AnnotationNode node) 
 - 
visitpublic void visit(ASTNode[] nodes, SourceUnit source) Description copied from interface:ASTTransformationThe 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:
- visitin 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.
 
 - 
getBooleanAnnotationParameterprotected static boolean getBooleanAnnotationParameter(AnnotationNode node, java.lang.String parameterName, boolean defaultValue) 
 - 
getClassAnnotationParameterprotected static ClassNode getClassAnnotationParameter(AnnotationNode node, java.lang.String parameterName, ClassNode defaultValue) 
 - 
internalErrorprotected static void internalError(java.lang.String message) 
 - 
createInterruptStatementprotected Statement createInterruptStatement() - Returns:
- Returns the interruption check statement.
 
 - 
wrapBlockprotected 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 statementwhich first element is for checking interruption, and the second one the statement to be wrapped.
 
 - 
visitForLooppublic final void visitForLoop(ForStatement forStatement) - Specified by:
- visitForLoopin interface- GroovyCodeVisitor
- Overrides:
- visitForLoopin class- ClassCodeVisitorSupport
 
 - 
visitDoWhileLooppublic final void visitDoWhileLoop(DoWhileStatement doWhileStatement) - Specified by:
- visitDoWhileLoopin interface- GroovyCodeVisitor
- Overrides:
- visitDoWhileLoopin class- ClassCodeVisitorSupport
 
 - 
visitWhileLooppublic final void visitWhileLoop(WhileStatement whileStatement) - Specified by:
- visitWhileLoopin interface- GroovyCodeVisitor
- Overrides:
- visitWhileLoopin class- ClassCodeVisitorSupport
 
 
- 
 
-