modello:generate

Full name:

org.codehaus.modello:modello-maven-plugin:1.9.0-SNAPSHOT:generate

Description:

A dynamic way to use generators and Modello plugins.

Example Usage:

  <plugin>
    <groupId>org.codehaus.modello</groupId>
    <artifactId>modello-maven-plugin</artifactId>
    <version>1.3</version>
    <dependencies>
      <dependency>
        <groupId>org.codehaus.modello</groupId>
        <artifactId>modello-plugin-jpa</artifactId>
        <version>1.0.0-SNAPSHOT</version>
      </dependency>
    </dependencies>
    <configuration>
      <version>1.0.0</version>
      <packageWithVersion>false</packageWithVersion>
      <models>
        <model>src/main/mdo/project-model.xml</model>
      </models>
    </configuration>
    <executions>
      <execution>
        <id>java</id>
        <goals>
          <goal>generate</goal>
        </goals>
        <configuration>
          <generatorId>java</generatorId>
        </configuration>
      </execution>
      <execution>
        <id>jpa</id>
        <goals>
          <goal>generate</goal>
        </goals>
        <configuration>
          <generatorId>jpa-mapping</generatorId>
        </configuration>
      </execution>
    </executions>
  </plugin>

Attributes:

  • Requires a Maven project to be executed.
  • The goal is thread-safe and supports parallel builds.
  • Binds by default to the lifecycle phase: generate-sources.

Required Parameters

Name Type Since Description
models String[] - List of relative paths to mdo files containing the models.
outputDirectory File - The output directory of the generated Java beans.
Default value is: ${project.build.directory}/generated-sources/modello.
packageWithVersion boolean - True if the generated package names should include the version.
Default value is: false.
User property is: packageWithVersion.
version String - The version of the model we will be working on.
User property is: version.

Optional Parameters

Name Type Since Description
domAsXpp3 boolean 1.6 Generate DOM content as plexus-utils Xpp3Dom objects instead of org.w3c.dom.Element.
Default value is: true.
User property is: domAsXpp3.
encoding String 1.0-alpha-19 The encoding to use when generating Java source files.
Default value is: ${project.build.sourceEncoding}.
User property is: encoding.
generatorId String - (no description)
Default value is: java.
User property is: modello.generator.id.
packagedVersions List - Additional historical versions to generate, each being packaged with the version regardless of the packageWithVersion setting.
useJava5 boolean 1.0 Generate Java 5 sources, with generic collections.
Default value is: false.
User property is: useJava5.

Parameter Details

domAsXpp3:

Generate DOM content as plexus-utils Xpp3Dom objects instead of org.w3c.dom.Element.
  • Type: boolean
  • Since: 1.6
  • Required: No
  • User Property: domAsXpp3
  • Default: true

encoding:

The encoding to use when generating Java source files.
  • Type: java.lang.String
  • Since: 1.0-alpha-19
  • Required: No
  • User Property: encoding
  • Default: ${project.build.sourceEncoding}

generatorId:

(no description)
  • Type: java.lang.String
  • Required: No
  • User Property: modello.generator.id
  • Default: java

models:

List of relative paths to mdo files containing the models.
  • Type: java.lang.String[]
  • Required: Yes

outputDirectory:

The output directory of the generated Java beans.
  • Type: java.io.File
  • Required: Yes
  • Default: ${project.build.directory}/generated-sources/modello

packageWithVersion:

True if the generated package names should include the version.
  • Type: boolean
  • Required: Yes
  • User Property: packageWithVersion
  • Default: false

packagedVersions:

Additional historical versions to generate, each being packaged with the version regardless of the packageWithVersion setting.
  • Type: java.util.List
  • Required: No

useJava5:

Generate Java 5 sources, with generic collections.
  • Type: boolean
  • Since: 1.0
  • Required: No
  • User Property: useJava5
  • Default: false

version:

The version of the model we will be working on.
  • Type: java.lang.String
  • Required: Yes
  • User Property: version