org.nuiton.eugene.plugin
Class EugeneAbstractMojo

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

All Implemented Interfaces:

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

Direct Known Subclasses:

CopyVersionFiles, EugenePlugin, Xmi2Model, Zargo2Xmi

public abstract class EugeneAbstractMojo
extends org.nuiton.plugin.AbstractPlugin

La classe de base pour definir des mojos dans eugene.

Since:

1.0.0-rc-8

Author:

tchemit

Nested Class Summary

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

org.nuiton.plugin.Plugin.InitState, org.nuiton.plugin.Plugin.Packaging

Field Summary

protected 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 Le settings (pour obtenir le mode offline).
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

org.apache.maven.project.MavenProject	getProject()
protected abstract 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 void	init()
protected abstract org.nuiton.plugin.PluginIOContext	initResources() Initialiser les io du plugins.
protected org.nuiton.plugin.PluginIOContext	initResources(File defaultIn, File defaultOut, File defaultTestIn, File defaultTestOut) Build the getResources() data.
boolean	isVerbose()
void	setProject(org.apache.maven.project.MavenProject project)
void	setVerbose(boolean verbose)

Methods inherited from class org.nuiton.plugin.AbstractPlugin

acceptPackaging, addCompileSourceRoots, addDirectoryToUrlsList, addResourceDir, addTestCompileSourceRoots, addTestResourceDir, addUrlToUrlsList, afterExecute, backupFile, checkPackaging, checkResource, checkRunOnceDone, checkSkip, copyFile, createDirectoryIfNecessary, createNewFile, deleteFile, doAction, execute, getBackupFile, getFileFromBasedir, getFilesToTreate, getFilesToTreateForRoots, getRootProject, getTemplate, initClassLoader, isExecutionRoot, isFileNewerThanPomFile, rejectPackaging, removeCompileSourceRoots, removeTestCompileSourceRoots, renameFile, 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

project

protected org.apache.maven.project.MavenProject project

Maven project.

Since:

1.0.0-rc-8

Is defined by:

default-value:

${project}

Is readonly.

settings

protected org.apache.maven.settings.Settings settings

Le settings (pour obtenir le mode offline).

Since:

1.0.0-rc-4

Is defined by:

default-value:

${settings}

Is readonly.

overwrite

protected boolean overwrite

Ecrase les fichiers générés.

Since:

0.50

Is defined by:

expression:

${eugene.overwrite}

default-value:

false

verbose

protected boolean verbose

Pour activer le mode verbeux.

Since:

1.0.0-rc-8

Is defined by:

expression:

${eugene.verbose}

default-value:

${maven.verbose}

encoding

protected String encoding

Encoding to be used for generation of files.

Since:

0.60

Is defined by:

expression:

${eugene.encoding}

default-value:

${project.build.sourceEncoding}

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

Is defined by:

expression:

${eugene.testPhase}

default-value:

false

Constructor Detail

EugeneAbstractMojo

public EugeneAbstractMojo()

Method Detail

getResources

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

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.plugin.PluginIOContext initResources()

Initialiser les io du plugins.

Returns:

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

initResources

protected org.nuiton.plugin.PluginIOContext initResources(File defaultIn,
                                                          File defaultOut,
                                                          File defaultTestIn,
                                                          File defaultTestOut)

Build the getResources() data.

Parameters:

defaultIn - the default input directory

defaultOut - the default output directory

defaultTestIn - the default test input directory

defaultTestOut - the default test output directory

Returns:

the new PluginIOContext to use in the goal

init

protected void init()
             throws Exception

Specified by:

init in class org.nuiton.plugin.AbstractPlugin

Throws:

Exception

getProject

public org.apache.maven.project.MavenProject getProject()

isVerbose

public boolean isVerbose()

setProject

public void setProject(org.apache.maven.project.MavenProject project)

setVerbose

public void setVerbose(boolean verbose)