Fork me on GitHub

groovy-template:generate

Full name:

com.summitsystemsinc.maven:groovy-template-maven-plugin:1.0.0:generate

Description:

Generates source code from Groovy Templates

Attributes:

  • Requires a Maven project to be executed.
  • Binds by default to the lifecycle phase: generate-sources.

Required Parameters

Name Type Since Description
groovyTemplateSources File - Source folder for groovy templates
Default value is: ${project.basedir}/src/main/gtemplate/.
User property is: groovyTemplateDir.
groovyTemplateTestSources File - Source folder for velocity test templates
Default value is: ${basedir}/src/test/gtemplate/.
User property is: testGroovyTemplateDir.
sourcePathRoot File - Source folder for velocity templates
Default value is: ${project.basedir}/src/.
User property is: sourcePathRoot.

Optional Parameters

Name Type Since Description
properties Map - Properties to go into Groovy templates
propertiesFiles List - Additional properties files to use. Will be added to the groovy binding. These are expected to be in groovy syntax (we use the groovy slurper)
resourcesOutputDirectory File - Output directory for resources.
Default value is: ${project.build.directory}/generated-resources/.
User property is: resOutput.
sourcesOutputDirectory File - Output directory for generated sources.
Default value is: ${project.build.directory}/generated-sources/main.
User property is: srcOutput.
templateEngineClass String - Classname for the groovy template engine to use.
Default value is: groovy.text.SimpleTemplateEngine.
User property is: templateEngine.
testResourcesOutputDirectory File - Output directory test resources.
Default value is: ${project.build.directory}/generated-test-resources/.
User property is: testResOutput.
testSourcesOutputDirectory File - Output directory for generated test sources.
Default value is: ${project.build.directory}/generated-sources/test.
User property is: testSrcOutput.

Parameter Details

groovyTemplateSources:

Source folder for groovy templates
  • Type: java.io.File
  • Required: Yes
  • User Property: groovyTemplateDir
  • Default: ${project.basedir}/src/main/gtemplate/

groovyTemplateTestSources:

Source folder for velocity test templates
  • Type: java.io.File
  • Required: Yes
  • User Property: testGroovyTemplateDir
  • Default: ${basedir}/src/test/gtemplate/

properties:

Properties to go into Groovy templates
  • Type: java.util.Map
  • Required: No

propertiesFiles:

Additional properties files to use. Will be added to the groovy binding. These are expected to be in groovy syntax (we use the groovy slurper)
  • Type: java.util.List
  • Required: No

resourcesOutputDirectory:

Output directory for resources.
  • Type: java.io.File
  • Required: No
  • User Property: resOutput
  • Default: ${project.build.directory}/generated-resources/

sourcePathRoot:

Source folder for velocity templates
  • Type: java.io.File
  • Required: Yes
  • User Property: sourcePathRoot
  • Default: ${project.basedir}/src/

sourcesOutputDirectory:

Output directory for generated sources.
  • Type: java.io.File
  • Required: No
  • User Property: srcOutput
  • Default: ${project.build.directory}/generated-sources/main

templateEngineClass:

Classname for the groovy template engine to use.
  • Type: java.lang.String
  • Required: No
  • User Property: templateEngine
  • Default: groovy.text.SimpleTemplateEngine

testResourcesOutputDirectory:

Output directory test resources.
  • Type: java.io.File
  • Required: No
  • User Property: testResOutput
  • Default: ${project.build.directory}/generated-test-resources/

testSourcesOutputDirectory:

Output directory for generated test sources.
  • Type: java.io.File
  • Required: No
  • User Property: testSrcOutput
  • Default: ${project.build.directory}/generated-sources/test