org.nuiton.license.plugin
Class AddLicenseFilePlugin

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

All Implemented Interfaces:

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

public class AddLicenseFilePlugin
extends org.nuiton.plugin.AbstractPlugin

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

Author:

chemit

Is defined by the goal name:

add-license

Is bound to the specified phase of the standard build lifecycle:

generate-resources

Requires the dependencies in this specified scope:

compile

Requires a Maven project to run:

true

Nested Class Summary

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

org.nuiton.plugin.Plugin.Packaging

Field Summary

protected boolean	copyToMETA_INF Un flag pour faire une copie nommée 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.plugin.AbstractPlugin

skipAfterInitMessage

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

ROLE

Constructor Summary

AddLicenseFilePlugin()

Method Summary

protected void	doAction()
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	hasClassPath()
protected boolean	init()
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.plugin.AbstractPlugin

acceptPackaging, addCompileSourceRoots, addResourceDir, addTestCompileSourceRoots, addTestResourceDir, checkPackaging, checkResource, copyFile, execute, getFilesToTreate, getFilesToTreateForRoots, getTemplate, initClassLoader, 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

project

protected org.apache.maven.project.MavenProject project

Dependance du projet.

Since:

1.0.0

Is defined by:

default-value:

${project}

Is required.

licenseFile

protected java.io.File licenseFile

Fichier de la licence du module.

Since:

1.0.0

Is defined by:

expression:

${helper.licenceFile}

default-value:

${basedir}/LICENSE.txt

Is required.

licenseName

protected java.lang.String licenseName

Le type de license a appliquer.

Pour obtenir la liste des licenses disponibles, utilisez le goal available-licenses

  mvn helper:available-licenses -Ddetail
 

Since:

1.0.0

Is defined by:

expression:

${license.licenseName}

Is required.

outputDirectory

protected java.io.File outputDirectory

Repertoire de sortie des sources.

Since:

1.0.0

Is defined by:

expression:

${helper.outputDirectory}

default-value:

target/generated-sources/resources

Is required.

licenseFilename

protected java.lang.String licenseFilename

Repertoire de sortie des classes (classpath).

Since:

1.0.0

Is defined by:

expression:

${helper.licenceFilename}

default-value:

encoding

protected java.lang.String encoding

Encoding a utiliser pour lire et ecrire les fichiers.

Since:

1.0.0

Is defined by:

expression:

${helper.encoding}

default-value:

${project.build.sourceEncoding}

Is required.

keepBackup

protected boolean keepBackup

Un flag pour conserver un backup des fichiers modifies.

Since:

1.0.0

Is defined by:

expression:

${helper.keepBackup}

default-value:

false

force

protected boolean force

Un flag pour forcer la generation.

Since:

1.0.0

Is defined by:

expression:

${helper.force}

default-value:

false

verbose

protected boolean verbose

Un flag pour activer le mode verbeux.

Since:

1.0.0

Is defined by:

expression:

${helper.verbose}

default-value:

${maven.verbose}

copyToMETA_INF

protected boolean copyToMETA_INF

Un flag pour faire une copie nommée dans META-INF (prefixe avec le nom de l'artifact). Cette option n'est utilisable que sur des modules avec un class-path (pas pour un pom)

Since:

1.0.0

Is defined by:

expression:

${helper.copyToMETA_INF}

default-value:

false

extraResolver

protected java.lang.String[] extraResolver

La baseURL d'un resolver de license supplementaire

Since:

1.0.0

Is defined by:

expression:

${helper.extraResolver}

license

protected License license

Constructor Detail

AddLicenseFilePlugin

public AddLicenseFilePlugin()

Method Detail

hasClassPath

protected boolean hasClassPath()

init

protected boolean init()
                throws java.lang.Exception

Specified by:

init in class org.nuiton.plugin.AbstractPlugin

Throws:

java.lang.Exception

doAction

protected void doAction()
                 throws java.lang.Exception

Specified by:

doAction in class org.nuiton.plugin.AbstractPlugin

Throws:

java.lang.Exception

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()

setVerbose

public void setVerbose(boolean verbose)

getProject

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

setProject

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