org.nuiton.license.plugin
Class UpdateHeaderMojo

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

All Implemented Interfaces:

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

Deprecated. since 1.2, use now the update-header-file goal instead.

@Deprecated
public class UpdateHeaderMojo
extends AbstractLicenseMojo

The goal to update (or add) the licence header on some files.

Since:

1.0.1

Author:

tchemit

Is defined by the goal name:

update-header

Requires a Maven project to run:

true

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 Map<String,HeaderGenerator>	_generators Deprecated. All available generators
protected String	boxedLicenseHeaderContent Deprecated. le header complet (avec les balises de commentaires)
protected List<String>	compileSourceRoots Deprecated. Compile source directory roots to inspect.
protected boolean	dryRun Deprecated. A flag to test plugin but modify no file.
protected String	excludes Deprecated. La liste des patterns de fichiers à exclure (séparés par des virgules).
protected Map<File,String[]>	filesToTreate Deprecated. la liste des chemin relatifs des sources java a traiter pour chaque repertoire contenant des sources
protected String	generatorName Deprecated. Le type de générateur a utiliser pour encapsuler le header.
protected String	inceptionYear Deprecated. l'annee de creation du module (sera place dans le header)
protected String	includes Deprecated. La liste des patterns de fichiers à inclure (séparés par des virgules).
protected boolean	keepBackup Deprecated. Un flag pour conserver un backup des fichiers modifies.
protected String	licenseHeaderContent Deprecated. le header a ajouter dans chaque fichier source java
protected String	licenseName Deprecated. Le type de license a appliquer.
protected String	licenseResolver Deprecated. Un resolver externe
protected LicenseStore	licenseStore Deprecated. store of licenses
protected String	organizationName Deprecated. le nom de l'organisation (sera place dans le header)
protected String	projectName Deprecated. le nom du projet (sera place dans le header)
protected boolean	skipUpdateHeader Deprecated. A flag to skip the goal.
protected String	template Deprecated. La template (velocity) a utiliser pour construire le header.
protected Map<String,String>	templateParameters Deprecated. Des paramètres supplémentaires à utiliser dans la template du header.
protected List<String>	testSourceRoots Deprecated. Test source directory roots to inspect.
protected long	timestamp Deprecated. le timestamp utilise pour la generation
protected org.codehaus.plexus.velocity.VelocityComponent	velocity Deprecated. Velocity Component.

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

ROLE

Constructor Summary

UpdateHeaderMojo()
Deprecated.

Method Summary

boolean	checkPackaging() Deprecated.
protected boolean	checkSkip() Deprecated.
protected String	computeHeader(License license, HeaderGenerator generator) Deprecated. Construction du header a utiliser.
protected void	doAction() Deprecated.
void	init() Deprecated.
void	setCompileSourceRoots(List<String> compileSourceRoots) Deprecated.
void	setCompileSourceRoots(String root) Deprecated.
void	setTestSourceRoots(List<String> testSourceRoots) Deprecated.
void	setTestSourceRoots(String root) Deprecated.

Methods inherited from class org.nuiton.license.plugin.AbstractLicenseMojo

createLicenseStore, getEncoding, getProject, hasClassPath, isVerbose, setEncoding, setProject, setVerbose

Methods inherited from class org.nuiton.plugin.AbstractPlugin

acceptPackaging, addCompileSourceRoots, addDirectoryToUrlsList, addResourceDir, addTestCompileSourceRoots, addTestResourceDir, addUrlToUrlsList, afterExecute, backupFile, checkResource, checkRunOnceDone, copyFile, createDirectoryIfNecessary, createNewFile, deleteFile, execute, getBackupFile, getFileFromBasedir, getFilesToTreate, getFilesToTreateForRoots, 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

inceptionYear

protected String inceptionYear

Deprecated.

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

Since:

1.0.0

Is defined by:

expression:

${license.inceptionYear}

default-value:

${project.inceptionYear}

Is required.

organizationName

protected String organizationName

Deprecated.

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

Since:

1.0.0

Is defined by:

expression:

${license.organizationName}

default-value:

${project.organization.name}

Is required.

projectName

protected String projectName

Deprecated.

le nom du projet (sera place dans le header)

Since:

1.0.0

Is defined by:

expression:

${license.projectName}

default-value:

${project.name}

Is required.

licenseName

protected String licenseName

Deprecated.

Le type de license a appliquer.

Since:

1.0.0

Is defined by:

expression:

${license.licenseName}

Is required.

generatorName

protected String generatorName

Deprecated.

Le type de générateur a utiliser pour encapsuler le header.

Par défaut, on veut utiliser le plugin sur des fichiers sources java.

Since:

1.0.1

Is defined by:

expression:

${license.generatorName}

default-value:

license-java

Is required.

includes

protected String includes

Deprecated.

La liste des patterns de fichiers à inclure (séparés par des virgules).

Exemple : **\/*.java,**\/*.properties

On recherchera alors les fichiers respectant l'un des patterns dans tous les répertoires de sources et de tests.

Par défaut, on veut utiliser le plugin sur des fichiers sources java.

Since:

1.0.1

Is defined by:

expression:

${license.includes}

default-value:

**\/*.java

Is required.

excludes

protected String excludes

Deprecated.

La liste des patterns de fichiers à exclure (séparés par des virgules).

Exemple : **\/*.java,**\/*.properties

On recherchera alors les fichiers respectant l'un des patterns dans tous les répertoires de sources et de tests.

Par défaut, on n'exclue rien.

Since:

1.0.1

Is defined by:

expression:

${license.excludes}

compileSourceRoots

protected List<String> compileSourceRoots

Deprecated.

Compile source directory roots to inspect.

Can use it a a comma separated string :

<compileSourceRoots>src/site,src.target/extra-site</compileSourceRoots>
 

or a list :

   <compileSourceRoots>
     <root>src/site</root> 

<root>src/target/extra-site</root> </compileSourceRoots>

Note: If not set, will use the build compile roots.

Since:

1.0.0

Is defined by:

expression:

${license.compileSourceRoots}

default-value:

${project.compileSourceRoots}

Is required.

testSourceRoots

protected List<String> testSourceRoots

Deprecated.

Test source directory roots to inspect.

Can use it a a comma separated string :

<testSourceRoots>src/test1,src/test2</testSourceRoots>
 

or a list :

   <testSourceRoots>
     <root>src/site</root> 

<root>src/target/extra-site</root> </testSourceRoots>

Note: If not set, will use the build test roots.

Since:

1.0.0

Is defined by:

expression:

${license.testSourceRoots}

default-value:

${project.testCompileSourceRoots}

Is required.

licenseResolver

protected String licenseResolver

Deprecated.

Un resolver externe

Since:

1.0.0

Is defined by:

expression:

${license.licenseResolver}

template

protected String template

Deprecated.

La template (velocity) a utiliser pour construire le header.

Cette template doit être dans le class-path ou être un fichier existant

Since:

1.0.1

Is defined by:

expression:

${license.template}

default-value:

/license/defaultHeader.vm

templateParameters

protected Map<String,String> templateParameters

Deprecated.

Des paramètres supplémentaires à utiliser dans la template du header.

Since:

1.0.1

Is defined by:

keepBackup

protected boolean keepBackup

Deprecated.

Un flag pour conserver un backup des fichiers modifies.

Since:

1.0.0

Is defined by:

expression:

${license.keepBackup}

default-value:

false

skipUpdateHeader

protected boolean skipUpdateHeader

Deprecated.

A flag to skip the goal.

Since:

1.0.3

Is defined by:

expression:

${skipUpdateLicense}

default-value:

false

dryRun

protected boolean dryRun

Deprecated.

A flag to test plugin but modify no file.

Since:

1.0.3

Is defined by:

expression:

${dryRun}

default-value:

false

velocity

protected org.codehaus.plexus.velocity.VelocityComponent velocity

Deprecated.

Velocity Component.

Since:

2.0.0

Is a Plexus component defined by:

roleHint:

maven-license-plugin

_generators

protected Map<String,HeaderGenerator> _generators

Deprecated.

All available generators

Is a Plexus component defined by:

role:

org.nuiton.license.plugin.header.generator.HeaderGenerator

licenseHeaderContent

protected String licenseHeaderContent

Deprecated.

le header a ajouter dans chaque fichier source java

boxedLicenseHeaderContent

protected String boxedLicenseHeaderContent

Deprecated.

le header complet (avec les balises de commentaires)

filesToTreate

protected Map<File,String[]> filesToTreate

Deprecated.

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

timestamp

protected long timestamp

Deprecated.

le timestamp utilise pour la generation

licenseStore

protected LicenseStore licenseStore

Deprecated.

store of licenses

Constructor Detail

UpdateHeaderMojo

public UpdateHeaderMojo()

Deprecated.

Method Detail

checkPackaging

public boolean checkPackaging()

Deprecated.

Overrides:

checkPackaging in class org.nuiton.plugin.AbstractPlugin

setCompileSourceRoots

public void setCompileSourceRoots(String root)

Deprecated.

setCompileSourceRoots

public void setCompileSourceRoots(List<String> compileSourceRoots)

Deprecated.

setTestSourceRoots

public void setTestSourceRoots(String root)

Deprecated.

setTestSourceRoots

public void setTestSourceRoots(List<String> testSourceRoots)

Deprecated.

checkSkip

protected boolean checkSkip()

Deprecated.

Overrides:

checkSkip in class org.nuiton.plugin.AbstractPlugin

init

public void init()
          throws Exception

Deprecated.

Specified by:

init in class org.nuiton.plugin.AbstractPlugin

Throws:

Exception

doAction

protected void doAction()
                 throws Exception

Deprecated.

Specified by:

doAction in class org.nuiton.plugin.AbstractPlugin

Throws:

Exception

computeHeader

protected String computeHeader(License license,
                               HeaderGenerator generator)
                        throws Exception

Deprecated.

Construction du header a utiliser.

Le header est généré à partir de la template velocity donnée et de la license donnée.

Parameters:

license - the license to use to compute header

generator - the header generator used to compute header

Returns:

le header construit

Throws:

Exception - pour toute erreur pendant la construction du header