Package groovy.transform.builder
Class DefaultStrategy
- java.lang.Object
-
- org.codehaus.groovy.transform.BuilderASTTransformation.AbstractBuilderStrategy
-
- groovy.transform.builder.DefaultStrategy
-
- All Implemented Interfaces:
BuilderASTTransformation.BuilderStrategy
public class DefaultStrategy extends BuilderASTTransformation.AbstractBuilderStrategy
This strategy is used with theBuilderAST transform to create a builder helper class for the fluent creation of instances of a specified class. It can be used at the class, static method or constructor levels. You use it as follows:import groovy.transform.builder.*
The@Builderclass Person { String firstName String lastName int age } def person = Person.builder().firstName("Robert").lastName("Lewandowski").age(21).build() assert person.firstName == "Robert" assert person.lastName == "Lewandowski" assert person.age == 21prefixannotation attribute can be used to create setters with a different naming convention. The default is the empty string but you could change that to "set" as follows:
or using a prefix of 'with' would result in usage like this:@groovy.transform.builder.Builder(prefix='set') class Person { String firstName String lastName int age } def p2 = Person.builder().setFirstName("Robert").setLastName("Lewandowski").setAge(21).build()def p3 = Person.builder().withFirstName("Robert").withLastName("Lewandowski").withAge(21).build()You can also use the@Builderannotation in combination with this strategy on one or more constructor or static method instead of or in addition to using it at the class level. An example with a constructor follows:import groovy.transform.ToString import groovy.transform.builder.Builder
In this case, the parameter(s) for the constructor or static method become the properties available in the builder. For the case of a static method, the return type of the static method becomes the class of the instance being created. For static factory methods, this is normally the class containing the static method but in general it can be any class. Note: if using more than one@ToStringclass Person { String first, last int born@BuilderPerson(String roleName) { if (roleName == 'Jack Sparrow') { first = 'Johnny'; last = 'Depp'; born = 1963 } } } assert Person.builder().roleName("Jack Sparrow").build().toString() == 'Person(Johnny, Depp, 1963)'@Builderannotation, which is only possible when using static method or constructor variants, it is up to you to ensure that any generated helper classes or builder methods have unique names. E.g. we can modify the previous example to have three builders. At least two of the builders in our case will need to set the 'builderClassName' and 'builderMethodName' annotation attributes to ensure we have unique names. This is shown in the following example:import groovy.transform.builder.* import groovy.transform.*
The 'forClass' annotation attribute for the@ToString@Builderclass Person { String first, last int born Person(){} // required to retain no-arg constructor@Builder(builderClassName='MovieBuilder', builderMethodName='byRoleBuilder') Person(String roleName) { if (roleName == 'Jack Sparrow') { this.first = 'Johnny'; this.last = 'Depp'; this.born = 1963 } }@Builder(builderClassName='SplitBuilder', builderMethodName='splitBuilder') static Person split(String name, int year) { def parts = name.split(' ') new Person(first: parts[0], last: parts[1], born: year) } } assert Person.splitBuilder().name("Johnny Depp").year(1963).build().toString() == 'Person(Johnny, Depp, 1963)' assert Person.byRoleBuilder().roleName("Jack Sparrow").build().toString() == 'Person(Johnny, Depp, 1963)' assert Person.builder().first("Johnny").last('Depp').born(1963).build().toString() == 'Person(Johnny, Depp, 1963)'@Buildertransform isn't applicable for this strategy. The 'useSetters' annotation attribute for the@Buildertransform is ignored by this strategy which always uses setters.
-
-
Nested Class Summary
-
Nested classes/interfaces inherited from class org.codehaus.groovy.transform.BuilderASTTransformation.AbstractBuilderStrategy
BuilderASTTransformation.AbstractBuilderStrategy.PropertyInfo
-
-
Constructor Summary
Constructors Constructor Description DefaultStrategy()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description voidbuild(BuilderASTTransformation transform, AnnotatedNode annotatedNode, AnnotationNode anno)voidbuildClass(BuilderASTTransformation transform, ClassNode buildee, AnnotationNode anno)voidbuildMethod(BuilderASTTransformation transform, MethodNode mNode, AnnotationNode anno)-
Methods inherited from class org.codehaus.groovy.transform.BuilderASTTransformation.AbstractBuilderStrategy
checkKnownField, checkKnownProperty, getFields, getIncludeExclude, getPropertyInfoFromBeanInfo, getPropertyInfoFromClassNode, getPropertyInfoFromClassNode, getPropertyInfoFromClassNode, getPropertyInfos, getSetterName, unsupportedAttribute, unsupportedAttribute
-
-
-
-
Method Detail
-
build
public void build(BuilderASTTransformation transform, AnnotatedNode annotatedNode, AnnotationNode anno)
-
buildMethod
public void buildMethod(BuilderASTTransformation transform, MethodNode mNode, AnnotationNode anno)
-
buildClass
public void buildClass(BuilderASTTransformation transform, ClassNode buildee, AnnotationNode anno)
-
-