org.nuiton.eugene.plugin
Class EugenePlugin

java.lang.Object
  org.apache.maven.plugin.AbstractMojo
      org.nuiton.plugin.AbstractPlugin
          org.nuiton.eugene.plugin.EugeneAbstractMojo
              org.nuiton.eugene.plugin.EugenePlugin

All Implemented Interfaces:

org.apache.maven.plugin.ContextEnabled, org.apache.maven.plugin.Mojo, org.nuiton.plugin.Plugin

public class EugenePlugin
extends EugeneAbstractMojo

Effectue toutes les générations et copie les fichiers générés dans le répertoire de compilation

Version:

$Revision: 640 $ Last update: $Date: 2009-10-16 14:36:06 +0200 (ven., 16 oct. 2009) $ by : $Author: tchemit $

Author:

ruchaud

Is defined by the goal name:

generate

Nested Class Summary

Nested classes/interfaces inherited from interface org.nuiton.plugin.Plugin

org.nuiton.plugin.Plugin.Packaging

Field Summary

protected java.lang.String	defaultPackage Nom par défaut du paquetage généré.
protected java.lang.String[]	excludeTemplates Templates à ne pas utiliser.
protected java.io.File	extraClassPathDirectory An extra directory to be added to the classpath.
protected java.lang.String	generatedPackages List of packages to generate (comma separated).
protected org.nuiton.plugin.PluginIOContext	generateResources Les entrées sorties du plugin.
protected java.lang.String	includes Fichier à inclure.
protected java.lang.String	templates Templates à utiliser, séparés par des virgules.

Fields inherited from class org.nuiton.eugene.plugin.EugeneAbstractMojo

encoding, overwrite, project, settings, testPhase, verbose

Fields inherited from class org.nuiton.plugin.AbstractPlugin

skipAfterInitMessage

Fields inherited from interface org.apache.maven.plugin.Mojo

ROLE

Constructor Summary

EugenePlugin()

Method Summary

void	doAction()
protected java.lang.ClassLoader	fixClassLoader() Prepare le classLoader a utiliser dans le generateur.
protected void	fixCompileSourceRoots() permet d'ajout le répertoire de génération des fichiers java dans les répertoires de compilation du projet Maven.
protected java.util.List<Generator>	getGenerators(java.util.List<java.lang.String> generatedPackagesAsList)
protected java.io.File[]	getModelFiles() Recuperation de la liste des fichiers de modele a traite.
protected java.util.List<java.lang.String>	getPackagesToGenerate()
protected org.nuiton.plugin.PluginIOContext	getResources() Note : l'objet peut etre null si la configuration ne definit pas la propriété associées dans l'implentation.
protected org.nuiton.plugin.PluginIOContext	initResources() Initialiser les io du plugins.

Methods inherited from class org.nuiton.eugene.plugin.EugeneAbstractMojo

getProject, init, initResources, isVerbose, setProject, setVerbose

Methods inherited from class org.nuiton.plugin.AbstractPlugin

acceptPackaging, addCompileSourceRoots, addDirectoryToUrlsList, addResourceDir, addTestCompileSourceRoots, addTestResourceDir, addUrlToUrlsList, checkPackaging, checkResource, checkRunOnceDone, copyFile, execute, getFileFromBasedir, getFilesToTreate, getFilesToTreateForRoots, getTemplate, initClassLoader, isExecutionRoot, isFileNewerThanPomFile, rejectPackaging, removeCompileSourceRoots, removeTestCompileSourceRoots, writeFile

Methods inherited from class org.apache.maven.plugin.AbstractMojo

getLog, getPluginContext, setLog, setPluginContext

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.apache.maven.plugin.Mojo

getLog, setLog

Field Detail

generateResources

protected org.nuiton.plugin.PluginIOContext generateResources

Les entrées sorties du plugin.

En entrée on demande des répertoires où chercher les fichiers objectmodel a convertir.

En sortie on demande le répertoire ou generer les classes java.

Par défaut on a les valeurs suivantes :

 <generateResources>
 

   <input>target/generated-sources/models</input>
 

   <output>target/generated-sources/java</output>
 

 </generateResources>
 

Note: si EugeneAbstractMojo.testPhase est activée, les valeurs par défaut sont :

 <generateResources>
 

   <input>target/generated-sources/test-models</input>
 

   <output>target/generated-sources/test-java</output>
 

 </generateResources>
 

Since:

1.0.0-rc-8

Is defined by:

templates

protected java.lang.String templates

Templates à utiliser, séparés par des virgules.

Since:

0.50

Is defined by:

expression:

${eugene.templates}

Is required.

excludeTemplates

protected java.lang.String[] excludeTemplates

Templates à ne pas utiliser.

Since:

0.63

Is defined by:

expression:

${eugene.excludeTemplates}

includes

protected java.lang.String includes

Fichier à inclure.

Since:

0.50

Is defined by:

expression:

${eugene.includes}

default-value:

*.*model

defaultPackage

protected java.lang.String defaultPackage

Nom par défaut du paquetage généré.

Since:

0.50

Is defined by:

expression:

${eugene.defaultPackage}

default-value:

${project.groupId}.${project.artifactId}

extraClassPathDirectory

protected java.io.File extraClassPathDirectory

An extra directory to be added to the classpath.

Since:

0.63

Is defined by:

expression:

${eugene.extraClassPathDirectory}

generatedPackages

protected java.lang.String generatedPackages

List of packages to generate (comma separated). If the parameter is not filled, will generate all packages.

Since:

1.0.0-rc-8

Is defined by:

expression:

${eugene.generatedPackages}

Constructor Detail

EugenePlugin

public EugenePlugin()

Method Detail

doAction

public void doAction()
              throws org.apache.maven.plugin.MojoExecutionException,
                     org.apache.maven.plugin.MojoFailureException

Specified by:

doAction in class org.nuiton.plugin.AbstractPlugin

Throws:

org.apache.maven.plugin.MojoExecutionException

org.apache.maven.plugin.MojoFailureException

getResources

protected org.nuiton.plugin.PluginIOContext getResources()

Description copied from class: EugeneAbstractMojo

Note : l'objet peut etre null si la configuration ne definit pas la propriété associées dans l'implentation.

Dans tous les cas, une fois la methode EugeneAbstractMojo.initResources() appele, l'objet devrait ne plus être null!

Specified by:

getResources in class EugeneAbstractMojo

Returns:

l'io du plugin ou null si non initialisé

initResources

protected org.nuiton.plugin.PluginIOContext initResources()

Description copied from class: EugeneAbstractMojo

Initialiser les io du plugins.

Specified by:

initResources in class EugeneAbstractMojo

Returns:

l'io intialisé (avec les valeurs par défaut, là où rien n'a été renseigné).

getPackagesToGenerate

protected java.util.List<java.lang.String> getPackagesToGenerate()

getModelFiles

protected java.io.File[] getModelFiles()

Recuperation de la liste des fichiers de modele a traite.

Returns:

la liste des modeles a utiliser

getGenerators

protected java.util.List<Generator> getGenerators(java.util.List<java.lang.String> generatedPackagesAsList)
                                           throws org.apache.maven.plugin.MojoFailureException,
                                                  org.apache.maven.plugin.MojoExecutionException

Throws:

org.apache.maven.plugin.MojoFailureException

org.apache.maven.plugin.MojoExecutionException

fixCompileSourceRoots

protected void fixCompileSourceRoots()

permet d'ajout le répertoire de génération des fichiers java dans les répertoires de compilation du projet Maven.

fixClassLoader

protected java.lang.ClassLoader fixClassLoader()
                                        throws org.apache.maven.plugin.MojoExecutionException

Prepare le classLoader a utiliser dans le generateur.

Si un extraClassPathDirectory a été renseigné, il est rajouté.

Si des références à des sibling modules, ils seront rajoutés aussi.

Returns:

le class loader modifie

Throws:

org.apache.maven.plugin.MojoExecutionException - if any pb