ReadWriteLockASTTransformation (Groovy 5.0.6)
Description: declaration: package: org.codehaus.groovy.transform, class: ReadWriteLockASTTransformation

Package org.codehaus.groovy.transform

# Class ReadWriteLockASTTransformation

java.lang.Object
org.codehaus.groovy.transform.AbstractASTTransformation
org.codehaus.groovy.transform.ReadWriteLockASTTransformation

All Implemented Interfaces:
  `ASTTransformation`, `ErrorCollecting`

public class ReadWriteLockASTTransformation extends AbstractASTTransformation
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

  Fields
  Modifier and Type
  Field
  Description
  `static final String`
  `DEFAULT_INSTANCE_LOCKNAME`
  `static final String`
  `DEFAULT_STATIC_LOCKNAME`

  ### Fields inherited from class org.codehaus.groovy.transform.AbstractASTTransformation

  `RETENTION_CLASSNODE, sourceUnit`

- ## Constructor Summary

  Constructors
  Constructor
  Description
  `ReadWriteLockASTTransformation()`

- ## 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 org.codehaus.groovy.transform.AbstractASTTransformation

  `addError, checkIncludeExcludeUndefinedAware, checkIncludeExcludeUndefinedAware, checkNotInterface, checkPropertyList, checkPropertyList, checkPropertyList, copyAnnotatedNodeAnnotations, copyAnnotatedNodeAnnotations, deemedInternalName, getAnnotationName, getMemberClassList, getMemberClassValue, getMemberClassValue, getMemberIntValue, getMemberStringList, getMemberStringValue, getMemberStringValue, getMemberValue, hasAnnotation, init, memberHasValue, shouldSkip, shouldSkip, shouldSkipOnDescriptorUndefinedAware, shouldSkipUndefinedAware, shouldSkipUndefinedAware, tokenize`

  ### Methods inherited from class java.lang.Object

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

- ## Field Details

  - ### DEFAULT_STATIC_LOCKNAME

    public static final String DEFAULT_STATIC_LOCKNAME
    See Also:
      - Constant Field Values

  - ### DEFAULT_INSTANCE_LOCKNAME

    public static final String DEFAULT_INSTANCE_LOCKNAME
    See Also:
      - Constant Field Values

- ## Constructor Details

  - ### ReadWriteLockASTTransformation

    public ReadWriteLockASTTransformation()

- ## 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.
    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.