org.nuiton.license.plugin
Class AbstractUpdateHeaderPlugin

java.lang.Object
  org.apache.maven.plugin.AbstractMojo
      org.nuiton.AbstractPlugin
          org.nuiton.license.plugin.AbstractUpdateHeaderPlugin

All Implemented Interfaces:

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

Direct Known Subclasses:

JavaUpdateHeaderPlugin, JaxxUpdateHeaderPlugin

public abstract class AbstractUpdateHeaderPlugin
extends org.nuiton.AbstractPlugin

Le modele de goal a utiliser pour mettre a jour l'entete d'un fichier. Une implantation pour les fichiers java est disponible : {@link Jav

Since:

1.0.0

Author:

chemit

Field Summary

protected java.util.List<java.lang.String>	compileSourceRoots Repertoires des fichiers sources a traiter.
protected java.lang.String	encoding Encoding a utiliser pour lire et ecrire les fichiers.
protected java.lang.String	extraIncludes Pour ajouter d'autres fichiers a traiter (separer par des virgules).
protected java.lang.String[]	extraResolver Un resolver externe
protected java.util.Map<java.io.File,java.lang.String[]>	filesToTreate la liste des chemin relatifs des sources java a traiter pour chaque repertoire contenant des sources
protected boolean	force Un flag pour forcer la generation.
protected HeaderGenerator	generator le generateur d'en-tete a utiliser
protected java.lang.String	inceptionYear l'annee de creation du module (sera place dans le header)
protected boolean	keepBackup Un flag pour conserver un backup des fichiers modifies.
protected java.lang.String	licenseHeaderContent le header a ajouter dans chaque fichier source java
protected java.lang.String	licenseName Le type de license a appliquer.
protected java.lang.String	organizationName le nom de l'organisation (sera place dans le header)
protected java.io.File	outputDirectory Repertoire de sortie des classes (classpath).
protected org.apache.maven.project.MavenProject	project Dependance du projet.
protected java.lang.String	projectName le nom du projet (sera place dans le header)
protected java.util.List<java.lang.String>	testCompileSourceRoots Repertoires des fichiers sources de test a traiter.
protected java.io.File	testOutputDirectory Repertoire du build des tests
protected long	timestamp
protected boolean	verbose Un flag pour activer le mode verbeux.

Fields inherited from class org.nuiton.AbstractPlugin

skipAfterInitMessage

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

ROLE

Constructor Summary

AbstractUpdateHeaderPlugin()

Method Summary

protected void	addHeaderToFile(java.io.File sourceFile, java.io.File processFile)
protected java.lang.String	computeHeader(org.nuiton.license.License license)
protected void	doAction()
boolean	ensurePackaging()
protected void	getExtraFilesToTreate(java.util.Map<java.io.File,java.lang.String[]> files)
protected abstract java.util.Map<java.io.File,java.lang.String[]>	getFilesToTreate()
HeaderGenerator	getGenerator()
org.apache.maven.project.MavenProject	getProject()
boolean	init()
boolean	isVerbose()
protected abstract HeaderGenerator	newHeaderGenerator()
protected void	processFile(org.nuiton.processor.LicenseProcessor p, java.io.File file)
void	setProject(org.apache.maven.project.MavenProject project)
void	setVerbose(boolean verbose)

Methods inherited from class org.nuiton.AbstractPlugin

addCompileSourceRoots, addResourceDir, addTestCompileSourceRoots, addTestResourceDir, copyFile, copyFile, execute, getFilesToTreate, getFilesToTreateForRoots, initClassLoader, isFileNewerThanPomFile, 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

Field Detail

project

protected org.apache.maven.project.MavenProject project

Dependance du projet.

Since:

1.0.0

encoding

protected java.lang.String encoding

Encoding a utiliser pour lire et ecrire les fichiers.

Since:

1.0.0

force

protected boolean force

Un flag pour forcer la generation.

Since:

1.0.0

inceptionYear

protected java.lang.String inceptionYear

l'annee de creation du module (sera place dans le header)

Since:

1.0.0

organizationName

protected java.lang.String organizationName

le nom de l'organisation (sera place dans le header)

Since:

1.0.0

projectName

protected java.lang.String projectName

le nom du projet (sera place dans le header)

Since:

1.0.0

licenseName

protected java.lang.String licenseName

Le type de license a appliquer.

Since:

1.0.0

compileSourceRoots

protected java.util.List<java.lang.String> compileSourceRoots

Repertoires des fichiers sources a traiter.

Since:

1.0.0

testCompileSourceRoots

protected java.util.List<java.lang.String> testCompileSourceRoots

Repertoires des fichiers sources de test a traiter.

Since:

1.0.0

outputDirectory

protected java.io.File outputDirectory

Repertoire de sortie des classes (classpath).

Since:

1.0.0

testOutputDirectory

protected java.io.File testOutputDirectory

Repertoire du build des tests

Since:

1.0.0

extraResolver

protected java.lang.String[] extraResolver

Un resolver externe

Since:

1.0.0

extraIncludes

protected java.lang.String extraIncludes

Pour ajouter d'autres fichiers a traiter (separer par des virgules). Exemple : *\*\/*.css,*\*\/*.properties

Since:

1.0.0

keepBackup

protected boolean keepBackup

Un flag pour conserver un backup des fichiers modifies.

Since:

1.0.0

verbose

protected boolean verbose

Un flag pour activer le mode verbeux.

Since:

1.0.0

licenseHeaderContent

protected java.lang.String licenseHeaderContent

le header a ajouter dans chaque fichier source java

filesToTreate

protected java.util.Map<java.io.File,java.lang.String[]> filesToTreate

la liste des chemin relatifs des sources java a traiter pour chaque repertoire contenant des sources

generator

protected HeaderGenerator generator

le generateur d'en-tete a utiliser

timestamp

protected long timestamp

Constructor Detail

AbstractUpdateHeaderPlugin

public AbstractUpdateHeaderPlugin()

Method Detail

getFilesToTreate

protected abstract java.util.Map<java.io.File,java.lang.String[]> getFilesToTreate()

newHeaderGenerator

protected abstract HeaderGenerator newHeaderGenerator()

getGenerator

public HeaderGenerator getGenerator()

ensurePackaging

public boolean ensurePackaging()

Specified by:

ensurePackaging in class org.nuiton.AbstractPlugin

init

public boolean init()
             throws java.io.IOException

Specified by:

init in class org.nuiton.AbstractPlugin

Throws:

java.io.IOException

doAction

protected void doAction()
                 throws java.lang.Exception

Specified by:

doAction in class org.nuiton.AbstractPlugin

Throws:

java.lang.Exception

computeHeader

protected java.lang.String computeHeader(org.nuiton.license.License license)
                                  throws java.io.IOException

Throws:

java.io.IOException

processFile

protected void processFile(org.nuiton.processor.LicenseProcessor p,
                           java.io.File file)
                    throws java.lang.Exception

Parameters:

p - license processor

file - the file to process

Throws:

java.lang.Exception - if IO pb

addHeaderToFile

protected void addHeaderToFile(java.io.File sourceFile,
                               java.io.File processFile)
                        throws java.io.IOException

Throws:

java.io.IOException

isVerbose

public boolean isVerbose()

Specified by:

isVerbose in class org.nuiton.AbstractPlugin

setVerbose

public void setVerbose(boolean verbose)

Specified by:

setVerbose in class org.nuiton.AbstractPlugin

getProject

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

Specified by:

getProject in class org.nuiton.AbstractPlugin

setProject

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

Specified by:

setProject in class org.nuiton.AbstractPlugin

getExtraFilesToTreate

protected void getExtraFilesToTreate(java.util.Map<java.io.File,java.lang.String[]> files)