Package org.apache.maven.plugins.dependency.analyze

Class AnalyzeReportMojo

  • All Implemented Interfaces:
    org.apache.maven.plugin.ContextEnabled, org.apache.maven.plugin.Mojo, org.apache.maven.reporting.MavenMultiPageReport, org.apache.maven.reporting.MavenReport
    @Mojo(name="analyze-report",
      requiresDependencyResolution=TEST,
      threadSafe=true)
@Execute(phase=TEST_COMPILE)
public class AnalyzeReportMojo
extends org.apache.maven.reporting.AbstractMavenReport
    Analyzes the dependencies of this project and produces a report that summarizes which are: used and declared; used and undeclared; unused and declared.
    Since:
    2.0-alpha-5

    • Field Summary

      Fields 
      Modifier and Type Field Description
      private org.apache.maven.shared.dependency.analyzer.ProjectDependencyAnalyzer analyzer
      The Maven project dependency analyzer to use.
      private boolean ignoreNonCompile
      Ignore Runtime/Provided/Test/System scopes for unused dependency analysis
      private java.io.File outputDirectory
      Target folder
      private org.apache.maven.project.MavenProject project
      The Maven project to analyze.
      private org.apache.maven.doxia.siterenderer.Renderer siteRenderer  
      private boolean skip
      Skip plugin execution completely.
      private java.lang.String[] usedDependencies
      Force dependencies as used, to override incomplete result caused by bytecode-level analysis.

      • Fields inherited from interface org.apache.maven.reporting.MavenReport

        CATEGORY_PROJECT_INFORMATION, CATEGORY_PROJECT_REPORTS, ROLE

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

        ROLE

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      void executeReport​(java.util.Locale locale)  
      protected java.util.ResourceBundle getBundle​(java.util.Locale locale)  
      java.lang.String getDescription​(java.util.Locale locale)  
      java.lang.String getName​(java.util.Locale locale)  
      protected java.lang.String getOutputDirectory()  
      java.lang.String getOutputName()  
      protected org.apache.maven.project.MavenProject getProject()  
      protected org.apache.maven.doxia.siterenderer.Renderer getSiteRenderer()  

      • Methods inherited from class org.apache.maven.reporting.AbstractMavenReport

        canGenerateReport, closeReport, execute, generate, generate, generate, getCategoryName, getInputEncoding, getOutputEncoding, getReportOutputDirectory, getSink, getSinkFactory, isExternalReport, setReportOutputDirectory

      • 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

      • project

        @Parameter(defaultValue="${project}",
           readonly=true,
           required=true)
private org.apache.maven.project.MavenProject project
        The Maven project to analyze.

      • analyzer

        @Component
private org.apache.maven.shared.dependency.analyzer.ProjectDependencyAnalyzer analyzer
        The Maven project dependency analyzer to use.

      • siteRenderer

        @Component
private org.apache.maven.doxia.siterenderer.Renderer siteRenderer

      • outputDirectory

        @Parameter(defaultValue="${project.build.directory}",
           readonly=true)
private java.io.File outputDirectory
        Target folder
        Since:
        2.0-alpha-5

      • ignoreNonCompile

        @Parameter(property="ignoreNonCompile",
           defaultValue="false")
private boolean ignoreNonCompile
        Ignore Runtime/Provided/Test/System scopes for unused dependency analysis
        Since:
        2.2

      • usedDependencies

        @Parameter
private java.lang.String[] usedDependencies
        Force dependencies as used, to override incomplete result caused by bytecode-level analysis. Dependency format is groupId:artifactId.
        Since:
        2.6

      • skip

        @Parameter(property="mdep.analyze.skip",
           defaultValue="false")
private boolean skip
        Skip plugin execution completely.
        Since:
        2.7

    • Constructor Detail

      • AnalyzeReportMojo

        public AnalyzeReportMojo()

    • Method Detail

      • executeReport

        public void executeReport​(java.util.Locale locale)
                   throws org.apache.maven.reporting.MavenReportException
        Specified by:
        executeReport in class org.apache.maven.reporting.AbstractMavenReport
        Throws:
        org.apache.maven.reporting.MavenReportException

      • getOutputName

        public java.lang.String getOutputName()

      • getName

        public java.lang.String getName​(java.util.Locale locale)

      • getDescription

        public java.lang.String getDescription​(java.util.Locale locale)

      • getProject

        protected org.apache.maven.project.MavenProject getProject()
        Overrides:
        getProject in class org.apache.maven.reporting.AbstractMavenReport

      • getOutputDirectory

        protected java.lang.String getOutputDirectory()
        Overrides:
        getOutputDirectory in class org.apache.maven.reporting.AbstractMavenReport

      • getSiteRenderer

        protected org.apache.maven.doxia.siterenderer.Renderer getSiteRenderer()
        Overrides:
        getSiteRenderer in class org.apache.maven.reporting.AbstractMavenReport

      • getBundle

        protected java.util.ResourceBundle getBundle​(java.util.Locale locale)
        Parameters:
        locale - the current locale
        Returns:
        The resource bundle ResourceBundle