Package com.github.robtimus.maven.plugins.buildhelper

Class JavadocLicenseMojo

java.lang.Object

org.apache.maven.plugin.AbstractMojo

com.github.robtimus.maven.plugins.buildhelper.AbstractLicenseMojo

com.github.robtimus.maven.plugins.buildhelper.JavadocLicenseMojo

All Implemented Interfaces:

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

@Mojo(name="javadoc-license",
      defaultPhase=PREPARE_PACKAGE,
      requiresProject=true,
      threadSafe=true)
public class JavadocLicenseMojo
extends AbstractLicenseMojo

Add a license file to created Javadoc JAR files.

License files are first resolved relative to the current directory. If it cannot be found there, parent directories are checked until one of the following occurs:

• The parent directory is not part of the Maven project (does not contain a pom.xml file), and is not the root directory of the current Git project.
• The maximum number of parent directories has been reached.

Field Summary

Fields inherited from class com.github.robtimus.maven.plugins.buildhelper.AbstractLicenseMojo

licenseFilename, project, skipLicense

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

ROLE

Constructor Summary

Constructors

Constructor	Description
JavadocLicenseMojo()

Method Summary

Modifier and Type	Method	Description
(package private) void	copyLicenseFile(java.nio.file.Path licenseFile, java.nio.file.Path buildDir)
(package private) void	processLicenseFile(java.nio.file.Path licenseFile)

Methods inherited from class com.github.robtimus.maven.plugins.buildhelper.AbstractLicenseMojo

execute, findLicenseFile

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

Constructor Detail

JavadocLicenseMojo

public JavadocLicenseMojo()

Method Detail

processLicenseFile

void processLicenseFile(java.nio.file.Path licenseFile)
                 throws org.apache.maven.plugin.MojoExecutionException

Specified by:

processLicenseFile in class AbstractLicenseMojo

Throws:

org.apache.maven.plugin.MojoExecutionException

copyLicenseFile

void copyLicenseFile(java.nio.file.Path licenseFile,
                     java.nio.file.Path buildDir)
              throws org.apache.maven.plugin.MojoExecutionException

Throws:

org.apache.maven.plugin.MojoExecutionException