Package org.codehaus.groovy.transform

Class FinalASTStubber

java.lang.Object

org.codehaus.groovy.transform.AbstractASTTransformation

org.codehaus.groovy.transform.FinalASTStubber

All Implemented Interfaces:

ASTTransformation, ErrorCollecting

public class FinalASTStubber
extends AbstractASTTransformation

Joint-compilation stubber for Final. Flips the ACC_FINAL modifier on the target class / field / method at CONVERSION so the stub presents the runtime final-ness to javac.

Without this, an @Immutable (or any @Final-composed) Groovy class compiles in joint compilation against a stub that lets Java code declare class JavaSubclass extends ImmutableThing, which the runtime then rejects (or breaks the immutability invariants if it doesn't).

No metadata-key handoff is required: the full FinalASTTransformation ORs ACC_FINAL into the modifiers unconditionally, which is idempotent if the bit was already set by the stubber.

Like LazyASTStubber this stubber adds no new members — it only adjusts modifiers — so the typical addStub* + metadata-key dance from StubberSupport doesn't apply.

Since:

6.0.0

Field Summary

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

RETENTION_CLASSNODE, sourceUnit

Constructor Summary

Constructors

Constructor	Description
FinalASTStubber()

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, deemedInternal, deemedInternalName, getAnnotationName, getMemberClassList, getMemberClassValue, getMemberClassValue, getMemberIntValue, getMemberStringList, getMemberStringValue, getMemberStringValue, getMemberValue, hasAnnotation, init, markAsInternal, memberHasValue, shouldSkip, shouldSkip, shouldSkip, shouldSkipOnDescriptorUndefinedAware, shouldSkipUndefinedAware, shouldSkipUndefinedAware, shouldSkipUndefinedAware, tokenize

Methods inherited from class java.lang.Object

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

Constructor Details

FinalASTStubber

public FinalASTStubber()

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.