Top Interfaces Annotations Classes Enums
[default module]

Package groovy.transform

Interface Summary

Modifier and TypeInterface and Description
public interface
CompilationUnitAware

This interface is for AST transformations which must be aware of the compilation unit where they are applied.

Annotation Summary

Modifier and TypeAnnotation and Description
public @interface
AnnotationCollector

The AnnotationCollector can be used to define aliases for groups of annotations.

public @interface
ASTTest

This AST transformation aims at helping in debugging other AST transformations.

public @interface
AutoClone

Class annotation used to assist in the creation of Cloneable classes.

public @interface
AutoFinal

Annotation to automatically add the final qualifier to method, constructor, and closure parameters.

public @interface
AutoImplement

Class annotation used to provide default dummy methods for a class extending an abstract super class or implementing one or more interfaces.

public @interface
BaseScript

Variable annotation used for changing the base script class of the current script.

public @interface
CompileStatic

This will let the Groovy compiler use compile time checks in the style of Java then perform static compilation, thus bypassing the Groovy meta object protocol.

public @interface
EqualsAndHashCode

Class annotation used to assist in creating appropriate equals() and hashCode() methods.

public @interface
ExternalizeMethods

Class annotation used to assist in the creation of Externalizable classes.

public @interface
ExternalizeVerifier

Class annotation used to assist in the creation of Externalizable classes.

public @interface
Field

Variable annotation used for changing the scope of a variable within a script from being within the run method of the script to being at the class level for the script.

public @interface
Generated

The Generated annotation is used to mark members that have been generated.

public @interface
ImmutableBase

Class annotation used to assist in the creation of immutable classes.

public @interface
ImmutableOptions

Class annotation used to assist in the creation of immutable classes.

public @interface
IndexedProperty

Field annotation used with properties to provide an indexed getter and setter for the property.

public @interface
InheritConstructors

Class annotation to make constructors from a super class available in a sub class.

public @interface
Internal

The Internal annotation is used to mark members that are internal.

public @interface
KnownImmutable

Class annotation used as a marker for immutable classes.

public @interface
MapConstructor

Class annotation used to assist in the creation of map constructors in classes.

public @interface
Memoized

Method annotation that creates a cache for the results of the execution of the annotated method.

public @interface
NamedDelegate

Marker interface used to indicate that the property names of the annotated parameter represent valid key names when using named arguments and that the property types are applicable for type checking purposes.

public @interface
NamedParam

Marker interface used to indicate that the name of the annotated parameter (or specified optional name) is a valid key name when using named arguments and that the parameter type is applicable for type checking purposes.

public @interface
NamedParams

Collector annotation for NamedParam.

public @interface
NamedVariant

Allows construction of a named-arg equivalent method or constructor.

public @interface
NullCheck

Class, method or constructor annotation which indicates that each parameter should be checked to ensure it isn't null.

public @interface
PackageScope

Annotation used for turning off Groovy's auto visibility conventions.

public @interface
PropertyOptions

Marker annotation used to indicate that special property handling code will be generated for this class.

public @interface
SelfType

This annotation can be added on a trait to declare the list of types that a class implementing that trait is supposed to extend.

public @interface
Sortable

A class annotation used to make a class Comparable by (potentially) multiple Comparators.

public @interface
SourceURI

Variable annotation used for getting the URI of the current script.

public @interface
Synchronized

Method annotation to make a method call synchronized for concurrency handling with some useful baked-in conventions.

public @interface
ToString

Class annotation used to assist in the creation of toString() methods in classes.

public @interface
Trait

Used to mark a class as being a trait.

public @interface
TupleConstructor

Class annotation used to assist in the creation of tuple constructors in classes.

public @interface
TypeChecked

This will let the Groovy compiler use compile time checks in the style of Java.

public @interface
VisibilityOptions

Marker annotation used in the context of AST transformations to provide a custom visibility.

public @interface
WithReadLock

This annotation is used in conjunction with WithWriteLock to support read and write synchronization on a method.

public @interface
WithWriteLock

This annotation is used in conjunction with WithReadLock to support read and write synchronization on a method.

Class Summary

Modifier and TypeClass and Description
public class
Undefined

Java doesn't allow you to have null as an attribute value.

Enum Summary

Modifier and TypeEnum and Description
public enum
AnnotationCollectorMode

public enum
AutoCloneStyle

Intended style to use for cloning when using the @AutoClone annotation.

public enum
PackageScopeTarget

Intended target when @PackageScope is placed at the class level.

public enum
TypeCheckingMode

This enumeration can be used whenever it is preferred to annotate a class as TypeChecked in general, but where only one or more methods are "dynamic".