Top Description Fields Constructors Methods
org.codehaus.groovy.transform

public Class ReadWriteLockASTTransformation

extends AbstractASTTransformation
Class Inheritance
Annotations
@GroovyASTTransformation
phase:CANONICALIZATION
Imports
groovy.transform.WithReadLock, .WithWriteLock, org.codehaus.groovy.GroovyBugError, org.codehaus.groovy.ast.ASTNode, .AnnotatedNode, .AnnotationNode, .ClassNode, .FieldNode, .MethodNode, org.codehaus.groovy.ast.expr.Expression, .MethodCallExpression, org.codehaus.groovy.ast.stmt.Statement, .TryCatchStatement, org.codehaus.groovy.control.CompilePhase, .SourceUnit, java.util.concurrent.locks.ReentrantReadWriteLock
Handles generation of code for the @WithReadLock and @WithWriteLock annotation.
This transformation adds an instance of ReentrantReadWriteLock to the class.
Any method annotated with @WithReadLock will obtain a read lock and release it in a finally block.
Any method annotated with @WithWriteLock will obtain a write lock and release it in a finally block.
For more information see WithReadLock and WithWriteLock

Field Summary

Modifier and TypeField and Description
public static final String
DEFAULT_INSTANCE_LOCKNAME

public static final String
DEFAULT_STATIC_LOCKNAME

private static final ClassNode
LOCK_TYPE

private static final ClassNode
READ_LOCK_TYPE

private static final ClassNode
WRITE_LOCK_TYPE

Inherited from org.codehaus.groovy.transform.AbstractASTTransformation:
RETENTION_CLASSNODEsourceUnit

Constructor Summary

AccessConstructor and Description
public
ReadWriteLockASTTransformation()

Method Summary

Modifier and TypeMethod and Description
private static Expression
createLockObject()

private FieldNode
determineLock(String value, ClassNode targetClass, boolean isStatic, String myTypeName)

public void
visit(ASTNode[]
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.
nodes, SourceUnit
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.
source)

Implements org.codehaus.groovy.transform.ASTTransformation.visit.

The method is invoked when an AST Transformation is active.
Inherited from org.codehaus.groovy.transform.AbstractASTTransformation:
addErrorcheckIncludeExcludecheckIncludeExcludecheckIncludeExcludeUndefinedAwarecheckIncludeExcludeUndefinedAwarecheckNotInterfacecheckPropertyListcheckPropertyListcheckPropertyListcopyAnnotatedNodeAnnotationscopyAnnotatedNodeAnnotationsdeemedInternalNamegetAnnotationNamegetClassListgetMemberClassListgetMemberClassValuegetMemberClassValuegetMemberIntValuegetMemberListgetMemberStringListgetMemberStringValuegetMemberStringValuegetMemberValuehasAnnotationinitmemberHasValuenonGenericshouldSkipshouldSkipshouldSkipOnDescriptorshouldSkipOnDescriptorUndefinedAwareshouldSkipUndefinedAwareshouldSkipUndefinedAwaretokenize

Field Detail

DEFAULT_INSTANCE_LOCKNAMEback to summary
public static final String DEFAULT_INSTANCE_LOCKNAME
DEFAULT_STATIC_LOCKNAMEback to summary
public static final String DEFAULT_STATIC_LOCKNAME
LOCK_TYPEback to summary
private static final ClassNode LOCK_TYPE
READ_LOCK_TYPEback to summary
private static final ClassNode READ_LOCK_TYPE
WRITE_LOCK_TYPEback to summary
private static final ClassNode WRITE_LOCK_TYPE

Constructor Detail

ReadWriteLockASTTransformationback to summary
public ReadWriteLockASTTransformation()

Method Detail

createLockObjectback to summary
private static Expression createLockObject()
determineLockback to summary
private FieldNode determineLock(String value, ClassNode targetClass, boolean isStatic, String myTypeName)
visitback to summary
public void visit(ASTNode[] nodes, SourceUnit source)

Implements org.codehaus.groovy.transform.ASTTransformation.visit.

Doc from org.codehaus.groovy.transform.ASTTransformation.visit.

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.

Parameters
nodes:ASTNode[]

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:SourceUnit

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.