Package groovy.transform
Annotation Type TupleConstructor
-
@Documented @Retention(RUNTIME) @Target(TYPE) public @interface TupleConstructor
Class annotation used to assist in the creation of tuple constructors in classes. It allows you to write classes in this shortened form:@TupleConstructor
class Customer { String first, last int age Date since Collection favItems } def c1 = new Customer(first:'Tom', last:'Jones', age:21, since:new Date(), favItems:['Books', 'Games']) def c2 = new Customer('Tom', 'Jones', 21, new Date(), ['Books', 'Games']) def c3 = new Customer('Tom', 'Jones')@TupleConstructor
annotation instructs the compiler to execute an AST transformation which adds the necessary constructor method to your class. A tuple constructor is created with a parameter for each property (and optionally field and super properties). A default value is provided (using Java's default values) for all parameters in the constructor. Groovy's normal conventions then allows any number of parameters to be left off the end of the parameter list including all of the parameters - giving a no-arg constructor which can be used with the map-style naming conventions. The order of parameters is given by the properties of any super classes with most super first (ifincludeSuperProperties
is set) followed by the properties of the class followed by the by the fields of the class (ifincludeFields
is set). Within each grouping the order is as attributes appear within the respective class. Limitations: currently not designed to support inner classes.- Since:
- 1.8.0
- Author:
- Paul King
-
-
Optional Element Summary
Optional Elements Modifier and Type Optional Element Description boolean
callSuper
Should super properties be called within a call to the parent constructor rather than set as propertiesjava.lang.String
excludes
Comma separated list of field and/or property names to exclude from the constructor.boolean
force
By default, this annotation becomes a no-op if you provide your own constructor.boolean
includeFields
Include fields in the constructorboolean
includeProperties
Include properties in the constructorjava.lang.String
includes
Comma separated list of field and/or property names to include within the constructor.boolean
includeSuperFields
Include fields from super classes in the constructorboolean
includeSuperProperties
Include properties from super classes in the constructor
-