Built by Maven

modello:xsd

Full name:

org.codehaus.modello:modello-maven-plugin:2.4.0:xsd

Description:

Creates an XML schema 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 XML Schema.
Default: ${project.build.directory}/generated-site/resources/xsd
<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
<enforceMandatoryElements> boolean 2.1.0 Boolean flag to enforce mandatory elements in the XML schema. If set to false the XSD won't enforce mandatory elements in the XML which can be useful if the XML is post processed (e.g. POM merging with parents). The default value is false for backwards compatibility reasons, but should be set to true for most cases.
Default: false
<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.
<xsdFileName> String 1.0-alpha-21 No description.

Parameter Details

<basedir>

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

<enforceMandatoryElements>

Boolean flag to enforce mandatory elements in the XML schema. If set to false the XSD won't enforce mandatory elements in the XML which can be useful if the XML is post processed (e.g. POM merging with parents). The default value is false for backwards compatibility reasons, but should be set to true for most cases.
  • Type: boolean
  • Since: 2.1.0
  • Required: No
  • Default: false

<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 XML Schema.
  • Type: java.io.File
  • Required: Yes
  • Default: ${project.build.directory}/generated-site/resources/xsd

<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

<version>

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

<xsdFileName>

No description.
  • Type: java.lang.String
  • Since: 1.0-alpha-21
  • Required: No