fluent.api.generator.validation

Annotation Type FluentCheck

@Retention(value=RUNTIME)
 @Target(value=PARAMETER)
public @interface FluentCheck

Annotation, that triggers code generator to create a fluent builder for an existing factory method with many arguments. E.g. for method: public MyClass(String a, String b, int c, Object d) { } it will generate fluent API, which can be used like following: MyClass myClass = new MyClassBuilder().a("a").b("b").c(4).d(new Object()).build();

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element and Description
String	className Specify the generated class name.
String	factoryMethod Specify factory method used to create instances of the fluent parameters builder instead of constructor.
String	getterNameGroup Specify regex group, which should contain the name of the getter within the original method name.
String	getterPattern Specify prefixes of getter methods.
String	packageName Specify package name, where to create the generated class.

Element Detail

packageName

public abstract String packageName

Specify package name, where to create the generated class. If not defined, it will be the same as the class with the annotated method/constructor.

Returns:

Target package name.

Default:

""

className

public abstract String className

Specify the generated class name. If not specified, it will be auto-generated by the convention: {Declaring class name}{Annotated method name}{target method name}er E.g. MyClassMyMethodBuilder

Returns:

Generated class name.

Default:

""

factoryMethod

public abstract String factoryMethod

Specify factory method used to create instances of the fluent parameters builder instead of constructor.

Returns:

Name of the factory method.

Default:

""

getterPattern

public abstract String getterPattern

Specify prefixes of getter methods.

Returns:

All prefixes, by which we can identify getter method.

Default:

"(get|is)(.+)"

getterNameGroup

public abstract String getterNameGroup

Specify regex group, which should contain the name of the getter within the original method name.

Returns:

Group in Java regex notation (e.g. $1, $2 etc.)

Default:

"$2"