org.nuiton.license.plugin
Class LicensePlugin

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

All Implemented Interfaces:

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

public class LicensePlugin
extends AbstractPlugin

Le goal pour ajouter le fichier LICENSE.txt dans le classpath (et le generer s'il n'existe pas).

Author:

chemit

Field Summary

protected boolean	copyToMETA_INF Un flag pour farie une copie nommé dans META-INF (prefixe avec le nom de l'artifact).
protected java.lang.String	encoding Encoding a utiliser pour lire et ecrire les fichiers.
protected java.lang.String[]	extraResolver La baseURL d'un resolver de license supplementaire
protected boolean	force Un flag pour forcer la generation.
protected boolean	keepBackup Un flag pour conserver un backup des fichiers modifies.
protected License	license
protected java.io.File	licenseFile Fichier de la licence du module.
protected java.lang.String	licenseFilename Repertoire de sortie des classes (classpath).
protected java.lang.String	licenseName Le type de license a appliquer.
protected java.io.File	outputDirectory Repertoire de sortie des sources.
protected org.apache.maven.project.MavenProject	project Dependance du projet.
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

LicensePlugin()

Method Summary

protected void	doAction() Do plugin action.
protected boolean	ensurePackaging()
java.lang.String	getEncoding()
java.lang.String[]	getExtraResolver()
License	getLicense()
java.io.File	getLicenseFile()
java.lang.String	getLicenseName()
java.io.File	getOutputDirectory()
org.apache.maven.project.MavenProject	getProject()
protected boolean	init() la methode qui est lancee au debut de la methode AbstractPlugin.execute() pour preparer l'init du goal.
boolean	isForce()
boolean	isKeepBackup()
boolean	isVerbose()
void	setEncoding(java.lang.String encoding)
void	setExtraResolver(java.lang.String[] extraResolver)
void	setForce(boolean force)
void	setKeepBackup(boolean keepBackup)
void	setLicense(License license)
void	setLicenseFile(java.io.File licenseFile)
void	setLicenseName(java.lang.String licenseName)
void	setOutputDirectory(java.io.File outputDirectory)
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

licenseFile

protected java.io.File licenseFile

Fichier de la licence du module.

Since:

1.0.0

licenseName

protected java.lang.String licenseName

Le type de license a appliquer.

Since:

1.0.0

outputDirectory

protected java.io.File outputDirectory

Repertoire de sortie des sources.

Since:

1.0.0

licenseFilename

protected java.lang.String licenseFilename

Repertoire de sortie des classes (classpath).

Since:

1.0.0

encoding

protected java.lang.String encoding

Encoding a utiliser pour lire et ecrire les fichiers.

Since:

1.0.0

keepBackup

protected boolean keepBackup

Un flag pour conserver un backup des fichiers modifies.

Since:

1.0.0

force

protected boolean force

Un flag pour forcer la generation.

Since:

1.0.0

verbose

protected boolean verbose

Un flag pour activer le mode verbeux.

Since:

1.0.0

copyToMETA_INF

protected boolean copyToMETA_INF

Un flag pour farie une copie nommé dans META-INF (prefixe avec le nom de l'artifact).

Since:

1.0.0

extraResolver

protected java.lang.String[] extraResolver

La baseURL d'un resolver de license supplementaire

Since:

1.0.0

license

protected License license

Constructor Detail

LicensePlugin

public LicensePlugin()

Method Detail

ensurePackaging

protected boolean ensurePackaging()

Specified by:

ensurePackaging in class AbstractPlugin

init

protected boolean init()
                throws java.lang.Exception

Description copied from class: AbstractPlugin

la methode qui est lancee au debut de la methode AbstractPlugin.execute() pour preparer l'init du goal.

Specified by:

init in class AbstractPlugin

Returns:

true if there is something to generate, false otherwise.

Throws:

java.lang.Exception - if any

doAction

protected void doAction()
                 throws java.lang.Exception

Description copied from class: AbstractPlugin

Do plugin action.

The method AbstractPlugin.execute() invoke this method only and only if :

• AbstractPlugin.ensurePackaging() returns false (filtrer project type, for example).
• method AbstractPlugin.init() returns true.

Specified by:

doAction in class AbstractPlugin

Throws:

java.lang.Exception - if any

getLicenseFile

public java.io.File getLicenseFile()

getLicenseName

public java.lang.String getLicenseName()

getLicense

public License getLicense()

getExtraResolver

public java.lang.String[] getExtraResolver()

getEncoding

public java.lang.String getEncoding()

isKeepBackup

public boolean isKeepBackup()

isForce

public boolean isForce()

getOutputDirectory

public java.io.File getOutputDirectory()

setLicenseFile

public void setLicenseFile(java.io.File licenseFile)

setLicenseName

public void setLicenseName(java.lang.String licenseName)

setExtraResolver

public void setExtraResolver(java.lang.String[] extraResolver)

setLicense

public void setLicense(License license)

setEncoding

public void setEncoding(java.lang.String encoding)

setKeepBackup

public void setKeepBackup(boolean keepBackup)

setOutputDirectory

public void setOutputDirectory(java.io.File outputDirectory)

setForce

public void setForce(boolean force)

isVerbose

public boolean isVerbose()

Specified by:

isVerbose in class AbstractPlugin

setVerbose

public void setVerbose(boolean verbose)

Specified by:

setVerbose in class AbstractPlugin

getProject

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

Specified by:

getProject in class AbstractPlugin

setProject

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

Specified by:

setProject in class AbstractPlugin