Package org.codehaus.groovy.transform
Class ImmutableASTTransformation
java.lang.Object
org.codehaus.groovy.transform.AbstractASTTransformation
org.codehaus.groovy.transform.ImmutableASTTransformation
- All Implemented Interfaces:
CompilationUnitAware,ASTTransformation,ErrorCollecting
public class ImmutableASTTransformation
extends AbstractASTTransformation
implements CompilationUnitAware
Handles generation of code for the @Immutable annotation.
-
Field Summary
FieldsFields inherited from class org.codehaus.groovy.transform.AbstractASTTransformation
RETENTION_CLASSNODE, sourceUnit -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionstatic ObjectcheckImmutable(Class<?> clazz, String fieldName, Object field) For compatibility with pre 2.5 compiled classesstatic ObjectcheckImmutable(Class<?> clazz, String fieldName, Object field, List<String> knownImmutableFieldNames, List<Class> knownImmutableClasses) static ObjectcheckImmutable(String className, String fieldName, Object field) This method exists to be binary compatible with 1.7 - 1.8.6 compiled code.static voidcheckPropNames(Object instance, Map<String, Object> args) Called during named-arguments constructor execution to check given names.If the transform is associated with a single annotation, returns a name suitable for displaying in error messages.voidvoidvisit(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, getMemberClassList, getMemberClassValue, getMemberClassValue, getMemberIntValue, getMemberStringList, getMemberStringValue, getMemberStringValue, getMemberValue, hasAnnotation, init, memberHasValue, shouldSkip, shouldSkip, shouldSkipOnDescriptorUndefinedAware, shouldSkipUndefinedAware, shouldSkipUndefinedAware, tokenize
-
Field Details
-
MY_TYPE
-
IMMUTABLE_BREADCRUMB
- See Also:
-
-
Constructor Details
-
ImmutableASTTransformation
public ImmutableASTTransformation()
-
-
Method Details
-
getAnnotationName
Description copied from class:AbstractASTTransformationIf the transform is associated with a single annotation, returns a name suitable for displaying in error messages.- Overrides:
getAnnotationNamein classAbstractASTTransformation- Returns:
- The simple name of the annotation including the "@" or null if no such name is defined
-
setCompilationUnit
- Specified by:
setCompilationUnitin interfaceCompilationUnitAware
-
visit
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 interfaceASTTransformation- 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.
-
checkImmutable
This method exists to be binary compatible with 1.7 - 1.8.6 compiled code. -
checkImmutable
For compatibility with pre 2.5 compiled classes -
checkImmutable
-
checkPropNames
Called during named-arguments constructor execution to check given names.
-