Package org.apache.groovy.contracts.ast

Class ModifiesEnsuresValidationTransformation

java.lang.Object

org.apache.groovy.contracts.ast.ModifiesEnsuresValidationTransformation

All Implemented Interfaces:

ASTTransformation

public class ModifiesEnsuresValidationTransformation
extends Object
implements ASTTransformation

Validates that @Ensures postconditions on a method only reference fields via old.xxx that are declared as modifiable by @Modifies.

Runs at CompilePhase.INSTRUCTION_SELECTION after both:

• ModifiesASTTransformation has stored the modification set, and
• AnnotationClosureVisitor has recorded the old references

Then simply compares the two metadata sets.

Since:

6.0.0

See Also:

• Modifies

Constructor Summary

Constructors

Constructor	Description
ModifiesEnsuresValidationTransformation()

Method Summary

Modifier and Type	Method	Description
void	visit(ASTNode[] nodes, SourceUnit source)	The method is invoked when an AST Transformation is active.

Methods inherited from class java.lang.Object

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

Constructor Details

ModifiesEnsuresValidationTransformation

public ModifiesEnsuresValidationTransformation()

Method Details

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.