Built by Maven

modello:stax-reader

Full name:

org.codehaus.modello:modello-maven-plugin:2.5.0:stax-reader

Description:

Creates an StAX reader from the model.

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
<basedir> String - Base directory of the project, from where the Modello models are loaded.
Default: ${basedir}
<models> String[] - List of relative paths to mdo files containing the models.
<outputDirectory> File - The output directory of the generated Java beans.
Default: ${project.build.directory}/generated-sources/modello
<packageWithVersion> boolean - True if the generated package names should include the version.
Default: false
User Property: packageWithVersion
<version> String - The version of the model we will be working on.
User Property: 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: true
<encoding> String 1.0-alpha-19 The encoding to use when generating Java source files.
Default: ${project.build.sourceEncoding}
<javaSource> String 1.0 The java source level used for generating outputs classes.

Will be discovered from project properties, in order:
  • maven.compiler.release
  • maven.compiler.source
  • maven.compiler.target
If all of above properties was not be set, default value as 8 will be used.
<licenseFile> File 2.3.1 The file that contains license header text. If both configured, the licenseText prevails.
<licenseText> String 2.3.1 The contents of license header text, verbatim.
<packagedVersions> List<String> - Additional historical versions to generate, each being packaged with the version regardless of the packageWithVersion setting.
<pluralExceptions> Map<String,String> 2.5.0 Additional exceptions to the singularization rules, changing plural noun to singular.

As a kay we provide plural noun and as value we provide singular noun, eg:

    kiss

Parameter Details

<basedir>

Base directory of the project, from where the Modello models are loaded.
  • Type: java.lang.String
  • Required: Yes
  • Default: ${basedir}

<domAsXpp3>

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

<encoding>

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

<javaSource>

The java source level used for generating outputs classes.

Will be discovered from project properties, in order:
  • maven.compiler.release
  • maven.compiler.source
  • maven.compiler.target
If all of above properties was not be set, default value as 8 will be used.
  • Type: java.lang.String
  • Since: 1.0
  • Required: No

<licenseFile>

The file that contains license header text. If both configured, the licenseText prevails.
  • Type: java.io.File
  • Since: 2.3.1
  • Required: No

<licenseText>

The contents of license header text, verbatim.
  • Type: java.lang.String
  • Since: 2.3.1
  • Required: No

<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<java.lang.String>
  • Required: No

<pluralExceptions>

Additional exceptions to the singularization rules, changing plural noun to singular.

As a kay we provide plural noun and as value we provide singular noun, eg:

    kiss
  • Type: java.util.Map<java.lang.String, java.lang.String>
  • Since: 2.5.0
  • Required: No

<version>

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