Produit par Maven

nuiton-config:describe

Nom complet :

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

Description :

Describe application config from java files to the description configuration format.

Created on 28/08/16.

Attributs :

  • Exige un projet Maven pour être exécuté.
  • S'exécute par l'invocation directe seulement.
  • 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 : compile.
  • Appelle l'exécution de la phase du cycle de vie compile avant de s'exécuter.

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.

Paramètres optionnels

Nom Type Depuis Description
<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.
<modelFile> File 3.0 The path of model file.

Default value is

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

Propriété utilisateur : config.modelFile.
<providerName> String 3.0 The name of provider to describe.

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


Propriété utilisateur : providerName.
<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

<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

<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

<providerName>

The name of provider to describe.

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

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

<verbose>

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