io.sundr.transform.annotations

Annotation Type VelocityTransformation

@Target(value=TYPE)
 @Retention(value=SOURCE)
public @interface VelocityTransformation

Annotation, that marks that we want to transform the annotated class using a Velocity template.

Required Element Summary

Required Elements

Modifier and Type	Required Element and Description
java.lang.String	value

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element and Description
boolean	gather
java.lang.String	outputPath
java.lang.String[]	paremters

Element Detail

value

public abstract java.lang.String value

Returns:

the name of a classpath resource containing the template.

outputPath

public abstract java.lang.String outputPath

Returns:

the relative path of the file that will be generated. When this option is omitted the output file is determined by the fully qualified name of the generated class. Apparently, the option is required for resources (where fqcn is not available).

Default:

""

gather

public abstract boolean gather

Returns:

a flag to mark that the the specified template will gather all annotated resources, instead of being applied individually to every single one of them. When gather is used the model feed to the template will be a map FQCN to TypeDef (where TypeDef is the representation of the class).

Default:

false

paremters

public abstract java.lang.String[] paremters

Returns:

an external array of parameters, to pass to the transformation.

Default:

{}