org.nuiton.eugene.plugin
Class EugeneAbstractMojo

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

All Implemented Interfaces:

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

Direct Known Subclasses:

CopyVersionFiles, EugenePlugin, Xmi2Model, Zargo2Xmi

public abstract class EugeneAbstractMojo
extends org.apache.maven.plugin.AbstractMojo

La classe de base pour definir des mojos dans eugene.

Since:

1.0.0-rc-8

Author:

chemit

Field Summary

protected java.lang.String	encoding Encoding to be used for generation of files.
protected boolean	overwrite Ecrase les fichiers générés.
protected org.apache.maven.project.MavenProject	project Maven project.
protected org.apache.maven.settings.Settings	settings
protected boolean	testPhase A flag to mark the mojo to be used in a test phase.
protected boolean	verbose Pour activer le mode verbeux.

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

ROLE

Constructor Summary

EugeneAbstractMojo()

Method Summary

protected void	addUrl(java.net.URL url, java.util.List<java.net.URL> urls, java.util.Set<java.lang.String> urlsAsString) Ajout dans la liste des urls et l'ensemble des urls sous forme de string, l'url donné.
void	execute()
protected java.io.File	getFile(java.lang.String... paths) Recupere le fichier donnée à partir de son chemin relatif sur le basedir du projet maven.
protected abstract org.nuiton.util.PluginIOContext	getResources() Note : l'objet peut etre si la configuration ne definit pas la propriété associées dans l'implentation.
protected abstract org.nuiton.util.PluginIOContext	initResources() Initialiser les io du plugins.
protected org.nuiton.util.PluginIOContext	initResources(java.io.File defaultIn, java.io.File defaultOut, java.io.File defaultTestIn, java.io.File defaultTestOut)

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

Field Detail

project

protected org.apache.maven.project.MavenProject project

Maven project.

Since:

1.0.0-rc-8

settings

protected org.apache.maven.settings.Settings settings

Since:

1.0.0-rc-4

overwrite

protected boolean overwrite

Ecrase les fichiers générés.

Since:

0.50

verbose

protected boolean verbose

Pour activer le mode verbeux.

Since:

1.0.0-rc-8

encoding

protected java.lang.String encoding

Encoding to be used for generation of files.

Since:

0.60

testPhase

protected boolean 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.

Since:

0.64

Constructor Detail

EugeneAbstractMojo

public EugeneAbstractMojo()

Method Detail

getResources

protected abstract org.nuiton.util.PluginIOContext getResources()

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

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

Returns:

l'io du plugin ou null si non initialisé

initResources

protected abstract org.nuiton.util.PluginIOContext initResources()

Initialiser les io du plugins.

Returns:

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

execute

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

Throws:

org.apache.maven.plugin.MojoExecutionException

org.apache.maven.plugin.MojoFailureException

initResources

protected org.nuiton.util.PluginIOContext initResources(java.io.File defaultIn,
                                                        java.io.File defaultOut,
                                                        java.io.File defaultTestIn,
                                                        java.io.File defaultTestOut)

getFile

protected java.io.File getFile(java.lang.String... paths)

Recupere le fichier donnée à partir de son chemin relatif sur le basedir du projet maven.

Parameters:

paths - les paths pour atteindre le fichier ou le répertoire

Returns:

le fichier de la destination

addUrl

protected void addUrl(java.net.URL url,
                      java.util.List<java.net.URL> urls,
                      java.util.Set<java.lang.String> urlsAsString)

Ajout dans la liste des urls et l'ensemble des urls sous forme de string, l'url donné. Note : l'utilisation de l'ensemble des urls sous forme de String est utile sinon la comparaison entre url requiere des appels reseaux et cela n'est pas acceptable dans notre cas (mode offline ne marcherait plus...).

Parameters:

url - l'url a rajouter dans la liste

urls - la liste des urls

urlsAsString - l'ensemble des urls sous forme de String