Produit par Maven

eugene:generate

Nom complet :

org.nuiton.eugene:eugene-maven-plugin:3.1-SNAPSHOT:generate

Description :

Eugene generator plugin (a.k.a generate mojo) Fill inputs and mojo will chained needed writer.

Attributs :

  • Exige un projet Maven pour être exécuté.
  • Exige une résolution des dépendances des artefacts dans le scope : compile.
  • Depuis la version : 2.5.

Paramètres requis

Nom Type Depuis Description
<extractDirectory> File 2.1.3 Where to copy extracted files (when using class-path data).
Valeur par défaut : target/extracted-sources.
Propriété utilisateur : eugene.extractDirectory.
<inputs> String[] 2.0.0 Inputs files to used to generate the required model files. An include has the following pattern : 
 writer:
when you want to use a specific writer with his default io values. Can also write : 
 [writer:]directory:includes
where includes is the pattern to find files from the directory given and must be terminated by the extension of files. Specifying the writer can be usefull when you want to use a writer for an unknown extension by any writer. Example : 
<inputs>
    <input>zargo:</input>
    <input>src/main/xmi2:**\/*.zargo</input>
    <input>zargo:src/main/xmi:**\/*.zargo2</input>
</inputs>
Note: If your using a single input, you can just write : 
<inputs>zargo</inputs>

Propriété utilisateur : eugene.inputs.
<modelType> String 2.0.0 The type of model to be used. By default, use an objectmodel.
Valeur par défaut : objectmodel.
Propriété utilisateur : eugene.modelType.
<outputDirectory> File 2.0.0 Where to generate files.
Valeur par défaut : target/generated-sources.
Propriété utilisateur : eugene.outputDirectory.

Paramètres optionnels

Nom Type Depuis Description
<defaultPackage> String 0.50 Nom par défaut du paquetage généré (model input specific).
Valeur par défaut : ${project.groupId}.${project.artifactId}.
Propriété utilisateur : eugene.defaultPackage.
<dryRun> boolean 2.0.0 Ne génère rien, analyse juste la configuration.
Valeur par défaut : false.
Propriété utilisateur : eugene.dryRun.
<encoding> String 2.0.0 Encoding to be used for generation of files. Note: If nothing is filled here, we will use the system property file.encoding.
Valeur par défaut : ${project.build.sourceEncoding}.
Propriété utilisateur : eugene.encoding.
<excludeTemplates> String[] 0.63 Templates à ne pas utiliser lors de la transformations des models (model input sepcific).
Propriété utilisateur : eugene.excludeTemplates.
<extractedPackages> String 1.0.0-rc-8 List of package to extract from xmi to models. (model input specific). If the parameter is not filled, will extract all packages.
Valeur par défaut : ${project.groupId}.${project.artifactId}.
Propriété utilisateur : eugene.extractedPackages.
<failIfUnsafe> boolean 2.9 A flag to fail if model properties is not safe (means some tagValues or stereotypes are not correct). Note: since version 3.0, the default value is true.
Valeur par défaut : true.
Propriété utilisateur : eugene.failIfUnsafe.
<fullPackagePath> String 2.0.0 Nom du paquetage pour les fichiers générés (xmi input sepcific).
Valeur par défaut : ${project.groupId}.${project.artifactId}.
Propriété utilisateur : generator.fullPackagePath.
<generatedPackages> String 1.0.0-rc-8 List of packages to generate (comma separated). (model input specific). If the parameter is not filled, will generate all packages.
Propriété utilisateur : eugene.generatedPackages.
<modelExtensionFile> File 3.0 To use a new object model extension file.
Propriété utilisateur : eugene.modelExtensionFile.
<overwrite> boolean 2.0.0 Ecrase les fichiers générés.
Valeur par défaut : false.
Propriété utilisateur : eugene.overwrite.
<properties> Map 2.0.0 Properties to pass to writer.
<resolver> String 2.0.0 Nom du resolver a utiliser pour les transformations xmi vers model (xmi input sepcific).
Valeur par défaut : org.nuiton.util.ResourceResolver.
Propriété utilisateur : generator.resolver.
<skipInputs> String 2.0.0 List of input (protocol) not to treate separated by comma. Example : 
<skipInputs>xmi</skipInputs>
<skipInputs>xmi,model</skipInputs>

Propriété utilisateur : eugene.skipInputs.
<templates> String 0.50 Templates à utiliser, séparés par des virgules pour les transformations depuis les models (model input sepcific).
Propriété utilisateur : eugene.templates.
<testPhase> boolean 2.0.0 A flag to mark the mojo to be used in a test phase. This will permits to add generated sources in test compile roots.
Valeur par défaut : false.
Propriété utilisateur : eugene.testPhase.
<verbose> boolean 2.0.0 Pour activer le mode verbeux.
Valeur par défaut : ${maven.verbose}.
Propriété utilisateur : eugene.verbose.

Détails des paramètres

<defaultPackage>

Nom par défaut du paquetage généré (model input specific).
  • Type : java.lang.String
  • Depuis : 0.50
  • Exigé : Non
  • Propriété utilisateur : eugene.defaultPackage
  • Défaut : ${project.groupId}.${project.artifactId}

<dryRun>

Ne génère rien, analyse juste la configuration.
  • Type : boolean
  • Depuis : 2.0.0
  • Exigé : Non
  • Propriété utilisateur : eugene.dryRun
  • Défaut : false

<encoding>

Encoding to be used for generation of files. Note: If nothing is filled here, we will use the system property file.encoding.
  • Type : java.lang.String
  • Depuis : 2.0.0
  • Exigé : Non
  • Propriété utilisateur : eugene.encoding
  • Défaut : ${project.build.sourceEncoding}

<excludeTemplates>

Templates à ne pas utiliser lors de la transformations des models (model input sepcific).
  • Type : java.lang.String[]
  • Depuis : 0.63
  • Exigé : Non
  • Propriété utilisateur : eugene.excludeTemplates

<extractDirectory>

Where to copy extracted files (when using class-path data).
  • Type : java.io.File
  • Depuis : 2.1.3
  • Exigé : Oui
  • Propriété utilisateur : eugene.extractDirectory
  • Défaut : target/extracted-sources

<extractedPackages>

List of package to extract from xmi to models. (model input specific). If the parameter is not filled, will extract all packages.
  • Type : java.lang.String
  • Depuis : 1.0.0-rc-8
  • Exigé : Non
  • Propriété utilisateur : eugene.extractedPackages
  • Défaut : ${project.groupId}.${project.artifactId}

<failIfUnsafe>

A flag to fail if model properties is not safe (means some tagValues or stereotypes are not correct). Note: since version 3.0, the default value is true.
  • Type : boolean
  • Depuis : 2.9
  • Exigé : Non
  • Propriété utilisateur : eugene.failIfUnsafe
  • Défaut : true

<fullPackagePath>

Nom du paquetage pour les fichiers générés (xmi input sepcific).
  • Type : java.lang.String
  • Depuis : 2.0.0
  • Exigé : Non
  • Propriété utilisateur : generator.fullPackagePath
  • Défaut : ${project.groupId}.${project.artifactId}

<generatedPackages>

List of packages to generate (comma separated). (model input specific). If the parameter is not filled, will generate all packages.
  • Type : java.lang.String
  • Depuis : 1.0.0-rc-8
  • Exigé : Non
  • Propriété utilisateur : eugene.generatedPackages

<inputs>

Inputs files to used to generate the required model files. An include has the following pattern : 
 writer:
when you want to use a specific writer with his default io values. Can also write : 
 [writer:]directory:includes
where includes is the pattern to find files from the directory given and must be terminated by the extension of files. Specifying the writer can be usefull when you want to use a writer for an unknown extension by any writer. Example : 
<inputs>
    <input>zargo:</input>
    <input>src/main/xmi2:**\/*.zargo</input>
    <input>zargo:src/main/xmi:**\/*.zargo2</input>
</inputs>
Note: If your using a single input, you can just write : 
<inputs>zargo</inputs>
  • Type : java.lang.String[]
  • Depuis : 2.0.0
  • Exigé : Oui
  • Propriété utilisateur : eugene.inputs

<modelExtensionFile>

To use a new object model extension file.
  • Type : java.io.File
  • Depuis : 3.0
  • Exigé : Non
  • Propriété utilisateur : eugene.modelExtensionFile

<modelType>

The type of model to be used. By default, use an objectmodel.
  • Type : java.lang.String
  • Depuis : 2.0.0
  • Exigé : Oui
  • Propriété utilisateur : eugene.modelType
  • Défaut : objectmodel

<outputDirectory>

Where to generate files.
  • Type : java.io.File
  • Depuis : 2.0.0
  • Exigé : Oui
  • Propriété utilisateur : eugene.outputDirectory
  • Défaut : target/generated-sources

<overwrite>

Ecrase les fichiers générés.
  • Type : boolean
  • Depuis : 2.0.0
  • Exigé : Non
  • Propriété utilisateur : eugene.overwrite
  • Défaut : false

<properties>

Properties to pass to writer.
  • Type : java.util.Map
  • Depuis : 2.0.0
  • Exigé : Non

<resolver>

Nom du resolver a utiliser pour les transformations xmi vers model (xmi input sepcific).
  • Type : java.lang.String
  • Depuis : 2.0.0
  • Exigé : Non
  • Propriété utilisateur : generator.resolver
  • Défaut : org.nuiton.util.ResourceResolver

<skipInputs>

List of input (protocol) not to treate separated by comma. Example : 
<skipInputs>xmi</skipInputs>
<skipInputs>xmi,model</skipInputs>
  • Type : java.lang.String
  • Depuis : 2.0.0
  • Exigé : Non
  • Propriété utilisateur : eugene.skipInputs

<templates>

Templates à utiliser, séparés par des virgules pour les transformations depuis les models (model input sepcific).
  • Type : java.lang.String
  • Depuis : 0.50
  • Exigé : Non
  • Propriété utilisateur : eugene.templates

<testPhase>

A flag to mark the mojo to be used in a test phase. This will permits to add generated sources in test compile roots.
  • Type : boolean
  • Depuis : 2.0.0
  • Exigé : Non
  • Propriété utilisateur : eugene.testPhase
  • Défaut : false

<verbose>

Pour activer le mode verbeux.
  • Type : boolean
  • Depuis : 2.0.0
  • Exigé : Non
  • Propriété utilisateur : eugene.verbose
  • Défaut : ${maven.verbose}