org.nuiton.helper.plugin
Class CheckProjectFilesPlugin

java.lang.Object
  org.apache.maven.plugin.AbstractMojo
      org.nuiton.plugin.AbstractPlugin
          org.nuiton.helper.plugin.CheckProjectFilesPlugin

All Implemented Interfaces:

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

Deprecated. since 1.0.3, reuse just a enforcer plugin to check those files. (removed in 1.1.0)

@Deprecated
public class CheckProjectFilesPlugin
extends AbstractPlugin

Check that : 1) the changelog exists on standalone module or root module of a multi-module project. 2) any project module has a README.txt and LICENSE.txt file

Since:

1.0.2

Author:

chemit

Is defined by the goal name:

check-project-files

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

validate

Requires a Maven project to run:

true

Nested Class Summary

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

Plugin.Packaging

Field Summary

protected org.apache.maven.project.MavenProject	project Deprecated. Dependance du projet.
protected boolean	verbose Deprecated. 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

CheckProjectFilesPlugin()
Deprecated.

Method Summary

protected void	checkChangelogFile() Deprecated.
protected void	checkLicenseFile() Deprecated.
protected void	checkReadmeFile() Deprecated.
protected void	doAction() Deprecated. Do plugin action.
org.apache.maven.project.MavenProject	getProject() Deprecated.
protected boolean	init() Deprecated. Method to initialize the mojo before doing any concrete actions.
boolean	isVerbose() Deprecated.
void	setProject(org.apache.maven.project.MavenProject project) Deprecated.
void	setVerbose(boolean verbose) Deprecated.

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

Deprecated.

Dependance du projet.

Since:

1.0.2

Is defined by:

default-value:

${project}

Is required.

verbose

protected boolean verbose

Deprecated.

Un flag pour activer le mode verbeux.

Since:

1.0.2

Is defined by:

expression:

${helper.verbose}

default-value:

${maven.verbose}

Constructor Detail

CheckProjectFilesPlugin

public CheckProjectFilesPlugin()

Deprecated.

Method Detail

getProject

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

Deprecated.

setProject

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

Deprecated.

isVerbose

public boolean isVerbose()

Deprecated.

setVerbose

public void setVerbose(boolean verbose)

Deprecated.

init

protected boolean init()
                throws Exception

Deprecated.

Description copied from class: AbstractPlugin

Method to initialize the mojo before doing any concrete actions.

Note: The method is invoked before the AbstractPlugin.doAction() method.

Specified by:

init in class AbstractPlugin

Returns:

true if mojo is well initialize and something has to be done in the AbstractPlugin.doAction() method, false otherwise.

Throws:

Exception - if any

doAction

protected void doAction()
                 throws Exception

Deprecated.

Description copied from class: AbstractPlugin

Do plugin action.

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

• AbstractPlugin.checkPackaging() returns true.
• method AbstractPlugin.init() returns true.

Specified by:

doAction in class AbstractPlugin

Throws:

Exception - if any

checkChangelogFile

protected void checkChangelogFile()
                           throws org.apache.maven.plugin.MojoExecutionException

Deprecated.

Throws:

org.apache.maven.plugin.MojoExecutionException

checkReadmeFile

protected void checkReadmeFile()
                        throws org.apache.maven.plugin.MojoExecutionException

Deprecated.

Throws:

org.apache.maven.plugin.MojoExecutionException

checkLicenseFile

protected void checkLicenseFile()
                         throws org.apache.maven.plugin.MojoExecutionException

Deprecated.

Throws:

org.apache.maven.plugin.MojoExecutionException