com.mycila.maven.plugin.license

Class LicenseCheckMojo

java.lang.Object

org.apache.maven.plugin.AbstractMojo

com.mycila.maven.plugin.license.AbstractLicenseMojo

com.mycila.maven.plugin.license.LicenseCheckMojo

All Implemented Interfaces:

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

@Mojo(name="check",
      defaultPhase=VERIFY,
      threadSafe=true)
public final class LicenseCheckMojo
extends AbstractLicenseMojo

Check if the source files of the project have a valid license header

Author:

Mathieu Carbou (mathieu.carbou@gmail.com)

Nested Class Summary

Nested classes/interfaces inherited from class com.mycila.maven.plugin.license.AbstractLicenseMojo

AbstractLicenseMojo.AbstractCallback

Field Summary

Fields

Modifier and Type	Field and Description
String	errorMessage
Collection<File>	missingHeaders

Fields inherited from class com.mycila.maven.plugin.license.AbstractLicenseMojo

aggregate, basedir, concurrencyFactor, dryRun, encoding, excludes, failIfMissing, failIfUnknown, header, headerDefinitions, headerSections, includes, inlineHeader, keywords, mapping, project, properties, quiet, skip, skipExistingHeaders, strictCheck, useDefaultExcludes, useDefaultMapping, validHeaders

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

ROLE

Constructor Summary

Constructors

Constructor and Description
LicenseCheckMojo()

Method Summary

Modifier and Type	Method and Description
void	execute()

Methods inherited from class com.mycila.maven.plugin.license.AbstractLicenseMojo

debug, execute, findCredentials, info, warn

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

errorMessage

@Parameter(property="license.error.message",
           defaultValue="Some files do not have the expected license header")
public String errorMessage

missingHeaders

public final Collection<File> missingHeaders

Constructor Detail

LicenseCheckMojo

public LicenseCheckMojo()

Method Detail

execute

public void execute()
             throws org.apache.maven.plugin.MojoExecutionException,
                    org.apache.maven.plugin.MojoFailureException

Throws:

org.apache.maven.plugin.MojoExecutionException

org.apache.maven.plugin.MojoFailureException