Package org.apache.rat.mp

Class AbstractRatMojo

java.lang.Object
org.apache.maven.plugin.AbstractMojo
org.apache.rat.mp.AbstractRatMojo
All Implemented Interfaces:
org.apache.maven.plugin.ContextEnabled, org.apache.maven.plugin.Mojo
Direct Known Subclasses:
RatCheckMojo, RatReportMojo
public abstract class AbstractRatMojo extends org.apache.maven.plugin.AbstractMojo
Abstract base class for Mojos, which are running Rat.

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    protected org.apache.maven.project.MavenProject
    project
    Holds the maven-internal project to allow resolution of artifact properties during mojo runs.
    protected boolean
    skip
    Will skip the plugin execution, e.g. for technical builds that do not take license compliance into account.

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

    ROLE

  • Constructor Summary

    Constructors
    Constructor
    Description
    AbstractRatMojo()
     

  • Method Summary

    Modifier and Type
    Method
    Description
    protected ReportConfiguration
    getConfiguration()
     
    protected Defaults.Builder
    getDefaultsBuilder()
     
    protected org.apache.maven.project.MavenProject
    getProject()
     
    protected void
    logLicenses​(Collection<ILicense> licenses)
     

    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

    execute

  • Field Details

    • skip

      @Parameter(property="rat.skip", defaultValue="false") protected boolean skip
      Will skip the plugin execution, e.g. for technical builds that do not take license compliance into account.
      Since:
      0.11

    • project

      @Parameter(defaultValue="${project}", required=true, readonly=true) protected org.apache.maven.project.MavenProject project
      Holds the maven-internal project to allow resolution of artifact properties during mojo runs.

  • Constructor Details

    • AbstractRatMojo

      public AbstractRatMojo()

  • Method Details

    • getProject

      protected org.apache.maven.project.MavenProject getProject()
      Returns:
      Returns the Maven project.

    • getDefaultsBuilder

      protected Defaults.Builder getDefaultsBuilder()

    • getConfiguration

      protected ReportConfiguration getConfiguration() throws org.apache.maven.plugin.MojoExecutionException
      Throws:
      org.apache.maven.plugin.MojoExecutionException

    • logLicenses

      protected void logLicenses​(Collection<ILicense> licenses)