Produit par Maven

nuiton-config:generate

Nom complet :

org.nuiton:nuiton-config-maven-plugin:3.5-SNAPSHOT:generate

Description :

Generate application config java files from the option definition class.

Created on 28/08/16.

Attributs :

  • Exige un projet Maven pour être exécuté.
  • Exige une résolution des dépendances des artefacts dans le scope : compile+runtime.
  • Depuis la version : 3.0.
  • S'associe par défaut dans la phase du cycle de vie : generate-sources.

Paramètres requis

Nom Type Depuis Description
<modelDirectory> File 3.0 The source directory where to scan model file.
Valeur par défaut : ${basedir}/src/main/config.
Propriété utilisateur : config.modelDirectory.
<outputDirectory> File 3.0 The root directory where to generated.
Valeur par défaut : ${project.build.directory}/generated-sources/java.
Propriété utilisateur : config.outputDirectory.
<sourceDirectory> File 3.0 The source directory where to scan options java file.
Valeur par défaut : ${basedir}/src/main/java.
Propriété utilisateur : config.sourceDirectory.

Paramètres optionnels

Nom Type Depuis Description
<actionsClassName> String 3.0 The simple name of the actions class.

By default, will use config.modelName + ConfigAction.


Propriété utilisateur : config.actionsClassName.
<format> String 3.0 Configuration description format ini, toml or yaml. Default value is ini.
Valeur par défaut : ini.
Propriété utilisateur : config.format.
<generatePropertyChangeSupport> boolean 3.0 To generate property change support on generated configuration class.
Valeur par défaut : false.
Propriété utilisateur : config.generatePropertyChangeSupport.
<generateProvider> boolean 3.0 To generate configuration provider classes.
Valeur par défaut : true.
Propriété utilisateur : config.generateProvider.
<modelFile> File 3.0 The path of model file.

Default value is

${modelDirectory}/${modelName}.${format}

Propriété utilisateur : config.modelFile.
<modelName> String 3.0 Model name (will prefix the generated files names with it).

By default, will use artifactId in camelCase format ( example: Model name for artifact id nuiton-config-example is NuitonConfigExample ).


Propriété utilisateur : config.modelName.
<optionsClassName> String 3.0 The simple name of the options class.

By default, will use config.modelName + ConfigOption.


Propriété utilisateur : config.optionsClassName.
<packageName> String 3.0 To set the package fully qualified name of the generated class.

By default, will use groupId.artifactId (with - replaced by .) plus .config.

A special case is designed to remove in artifactId the first component if it is the last one of groupId, for example with gav

org.nuiton:nuiton-config

the package name will be org.nuiton.config and not org.nuiton.nuiton.config.


Propriété utilisateur : config.packageName.
<skip> boolean 3.0 To skip generate.
Valeur par défaut : false.
Propriété utilisateur : config.skip.
<useNuitonI18n> boolean 3.0 To use nuiton-i18n API to translate descriptions in generate code.
Propriété utilisateur : config.useNuitonI18n.
<verbose> boolean 3.0 Pour activer le mode verbeux.
Valeur par défaut : ${maven.verbose}.
Propriété utilisateur : config.verbose.

Détails des paramètres

<actionsClassName>

The simple name of the actions class.

By default, will use config.modelName + ConfigAction.

  • Type : java.lang.String
  • Depuis : 3.0
  • Exigé : Non
  • Propriété utilisateur : config.actionsClassName

<format>

Configuration description format ini, toml or yaml. Default value is ini.
  • Type : java.lang.String
  • Depuis : 3.0
  • Exigé : Non
  • Propriété utilisateur : config.format
  • Défaut : ini

<generatePropertyChangeSupport>

To generate property change support on generated configuration class.
  • Type : boolean
  • Depuis : 3.0
  • Exigé : Non
  • Propriété utilisateur : config.generatePropertyChangeSupport
  • Défaut : false

<generateProvider>

To generate configuration provider classes.
  • Type : boolean
  • Depuis : 3.0
  • Exigé : Non
  • Propriété utilisateur : config.generateProvider
  • Défaut : true

<modelDirectory>

The source directory where to scan model file.
  • Type : java.io.File
  • Depuis : 3.0
  • Exigé : Oui
  • Propriété utilisateur : config.modelDirectory
  • Défaut : ${basedir}/src/main/config

<modelFile>

The path of model file.

Default value is

${modelDirectory}/${modelName}.${format}
  • Type : java.io.File
  • Depuis : 3.0
  • Exigé : Non
  • Propriété utilisateur : config.modelFile

<modelName>

Model name (will prefix the generated files names with it).

By default, will use artifactId in camelCase format ( example: Model name for artifact id nuiton-config-example is NuitonConfigExample ).

  • Type : java.lang.String
  • Depuis : 3.0
  • Exigé : Non
  • Propriété utilisateur : config.modelName

<optionsClassName>

The simple name of the options class.

By default, will use config.modelName + ConfigOption.

  • Type : java.lang.String
  • Depuis : 3.0
  • Exigé : Non
  • Propriété utilisateur : config.optionsClassName

<outputDirectory>

The root directory where to generated.
  • Type : java.io.File
  • Depuis : 3.0
  • Exigé : Oui
  • Propriété utilisateur : config.outputDirectory
  • Défaut : ${project.build.directory}/generated-sources/java

<packageName>

To set the package fully qualified name of the generated class.

By default, will use groupId.artifactId (with - replaced by .) plus .config.

A special case is designed to remove in artifactId the first component if it is the last one of groupId, for example with gav

org.nuiton:nuiton-config

the package name will be org.nuiton.config and not org.nuiton.nuiton.config.

  • Type : java.lang.String
  • Depuis : 3.0
  • Exigé : Non
  • Propriété utilisateur : config.packageName

<skip>

To skip generate.
  • Type : boolean
  • Depuis : 3.0
  • Exigé : Non
  • Propriété utilisateur : config.skip
  • Défaut : false

<sourceDirectory>

The source directory where to scan options java file.
  • Type : java.io.File
  • Depuis : 3.0
  • Exigé : Oui
  • Propriété utilisateur : config.sourceDirectory
  • Défaut : ${basedir}/src/main/java

<useNuitonI18n>

To use nuiton-i18n API to translate descriptions in generate code.
  • Type : boolean
  • Depuis : 3.0
  • Exigé : Non
  • Propriété utilisateur : config.useNuitonI18n

<verbose>

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