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

Class AnalyzeReport

java.lang.Object
org.apache.maven.plugin.AbstractMojo
org.apache.maven.reporting.AbstractMavenReport
org.apache.maven.plugins.dependency.analyze.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 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

    Modifier and Type
    Method
    Description
    boolean
    canGenerateReport()
     
    void
    executeReport(Locale locale)
     
    String
    getDescription(Locale locale)
    protected String
    getI18nString(Locale locale, String key)
     
    String
    getName(Locale locale)
    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

  • Constructor Details

    • AnalyzeReport

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

  • Method Details

    • executeReport

      public void executeReport(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 String getOutputName()

    • getName

      public String getName(Locale locale)

    • getDescription

      public String getDescription(Locale locale)

    • getI18nString

      protected String getI18nString(Locale locale, String key)
      Parameters:
      locale - the locale
      key - the key to search for
      Returns:
      the text appropriate for the locale