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

Class AnalyzeReport

  • 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 AnalyzeReport
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 java.util.Set<java.lang.String> excludedClasses
      List Excluded classes patterns from analyze.
      private org.codehaus.plexus.i18n.I18N i18n
      Internationalization component.
      private boolean ignoreNonCompile
      Ignore Runtime/Provided/Test/System scopes for unused dependency analysis.
      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 class org.apache.maven.reporting.AbstractMavenReport

        locale, mojoExecution, outputDirectory, outputFormat, outputTimestamp, project, reactorProjects, remoteProjectRepositories, repoSession, siteDirectory, siteRenderer, siteTool

      • 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

    • Constructor Summary

      Constructors 
      Constructor Description
      AnalyzeReport​(org.apache.maven.shared.dependency.analyzer.ProjectDependencyAnalyzer analyzer, org.codehaus.plexus.i18n.I18N i18n)  

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      boolean canGenerateReport()  
      void executeReport​(java.util.Locale locale)  
      java.lang.String getDescription​(java.util.Locale locale)
      protected java.lang.String getI18nString​(java.util.Locale locale, java.lang.String key)  
      java.lang.String getName​(java.util.Locale locale)
      java.lang.String getOutputName()

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

        closeReport, constructXrefLocation, execute, generate, generate, getCategoryName, getInputEncoding, getLocale, getOutputDirectory, getOutputEncoding, getProject, getReportOutputDirectory, getSink, getSinkFactory, getSiteRenderer, getXrefLocation, 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

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

        getOutputPath

    • Field Detail

      • analyzer

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

      • i18n

        private final org.codehaus.plexus.i18n.I18N i18n
        Internationalization component.

      • 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

      • excludedClasses

        @Parameter(property="mdep.analyze.excludedClasses")
private java.util.Set<java.lang.String> excludedClasses
        List Excluded classes patterns from analyze. Java regular expression pattern is applied to full class name.
        Since:
        3.7.0

    • Constructor Detail

      • AnalyzeReport

        @Inject
public AnalyzeReport​(org.apache.maven.shared.dependency.analyzer.ProjectDependencyAnalyzer analyzer,
                     org.codehaus.plexus.i18n.I18N i18n)

    • 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

      • canGenerateReport

        public boolean canGenerateReport()
        Specified by:
        canGenerateReport in interface org.apache.maven.reporting.MavenReport
        Overrides:
        canGenerateReport in class org.apache.maven.reporting.AbstractMavenReport

      • 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)

      • getI18nString

        protected java.lang.String getI18nString​(java.util.Locale locale,
                                         java.lang.String key)
        Parameters:
        locale - the locale
        key - the key to search for
        Returns:
        the text appropriate for the locale