fluent.dsl

Annotation Type Dsl

@Target(value={TYPE,ANNOTATION_TYPE,PACKAGE,FIELD,PARAMETER})
public @interface Dsl

Basic annotation, that has 2 main features: 1. It triggers code generation, when used on standard class or interface (and dsh-hell-compiler annotation processor is available to the compiler). In that case the annotated class / interface serves as the automation "binding", and fluent interface allowing use of all methods but with descriptive fluent java DSL will be generated. 2. When used on an annotation, package, or class / annotation, tha has nested annotations in it, it marks annotations within it's scope as keywords for the DSL. So they can be used in "method binding" signature to instruct the annotation processor, what the DSL sentences should look like.

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element and Description
String	className Applies only to usage #1 (on class / interface) It defines the name, of the root DSL generated interface.
String	delegateMethod Applies only to usage #1 (on class / interface) If defines name of method, using which it's possible to create simple delegate of the DSL.
String	factoryMethod Applies only to usage #1 (on class / interface) It defines name of the factory method, which creates instances of the root DSL.
String	packageName Applies only to usage #1 (on class / interface) It defines the package, in which the generated root DSL interface will be generated.
String	parameterName Applies only to usage #1 (on class / interface) It defines name of the parameter used in the generated factory method, which is used to pass the instance of the DSL binding class / instance.
boolean	staticEntryForStaticBinding Allow static entry methods for a sentence, which is bound to static method.
boolean	useVarargs Applies to both usages (however not yet properly reflected when used in use case #2) Flag indicating, if last parameter of type array in DSL method should be automatically convert to vararg.

Element Detail

packageName

public abstract String packageName

Applies only to usage #1 (on class / interface) It defines the package, in which the generated root DSL interface will be generated.

Returns:

Desired package name. If the value is empty string, then package name from the annotated class / interface is used.

Default:

""

className

public abstract String className

Applies only to usage #1 (on class / interface) It defines the name, of the root DSL generated interface.

Returns:

Desired name. If the value is empty, then simple name of the annotated class / interface with suffix "Dsl" is used.

Default:

""

factoryMethod

public abstract String factoryMethod

Applies only to usage #1 (on class / interface) It defines name of the factory method, which creates instances of the root DSL.

Returns:

Name of the factory method. Default is "create".

Default:

"create"

delegateMethod

public abstract String delegateMethod

Applies only to usage #1 (on class / interface) If defines name of method, using which it's possible to create simple delegate of the DSL.

Returns:

Name of the delegate method. Default is "delegate".

Default:

"delegate"

parameterName

public abstract String parameterName

Applies only to usage #1 (on class / interface) It defines name of the parameter used in the generated factory method, which is used to pass the instance of the DSL binding class / instance.

Returns:

Factory parameter name.

Default:

"impl"

useVarargs

public abstract boolean useVarargs

Applies to both usages (however not yet properly reflected when used in use case #2) Flag indicating, if last parameter of type array in DSL method should be automatically convert to vararg. Varargs in DSL are very convenient, and mostly DSL splits parameters into many methods, each of them can turn into vararg.

Returns:

Flag indicating auto conversion to vararg. Default is to auto-convert.

Default:

true

staticEntryForStaticBinding

public abstract boolean staticEntryForStaticBinding

Allow static entry methods for a sentence, which is bound to static method.

Returns:

Flag indicating allowance of static entry methods.

Default:

true