Package org.codehaus.mojo.versions

Class AbstractPluginUpdatesReport

java.lang.Object
org.apache.maven.plugin.AbstractMojo
org.apache.maven.reporting.AbstractMavenReport
org.codehaus.mojo.versions.AbstractVersionsReport<PluginUpdatesModel>
org.codehaus.mojo.versions.AbstractPluginUpdatesReport
All Implemented Interfaces:
org.apache.maven.plugin.ContextEnabled, org.apache.maven.plugin.Mojo, org.apache.maven.reporting.MavenMultiPageReport, org.apache.maven.reporting.MavenReport
Direct Known Subclasses:
PluginUpdatesAggregateReport, PluginUpdatesReport
public abstract class AbstractPluginUpdatesReport extends AbstractVersionsReport<PluginUpdatesModel>
Generates a report of available updates for the plugins of a project.

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    protected boolean
    onlyProjectPlugins
    If true, only shows the subsection of the pluginManagement artifacts that are actually used in the project's plugin graph.
    protected boolean
    onlyUpgradable
    If true, only shows upgradable plugins in the report.

    Fields inherited from class org.codehaus.mojo.versions.AbstractVersionsReport

    allowSnapshots, artifactHandlerManager, comparisonMethod, i18n, ignoredVersions, rendererFactory, repositorySystem, ruleSet, session, wagonMap

    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
    Modifier
    Constructor
    Description
    protected
    AbstractPluginUpdatesReport(org.codehaus.plexus.i18n.I18N i18n, org.apache.maven.artifact.handler.manager.ArtifactHandlerManager artifactHandlerManager, org.eclipse.aether.RepositorySystem repositorySystem, Map<String,org.apache.maven.wagon.Wagon> wagonMap, ReportRendererFactory rendererFactory)
     

  • Method Summary

    Modifier and Type
    Method
    Description
    boolean
    canGenerateReport()
    protected void
    doGenerateReport(Locale locale, org.apache.maven.doxia.sink.Sink sink)
    generates an empty report in case there are no sources to generate a report with
    protected boolean
    haveBuildPluginManagementPlugins(org.apache.maven.project.MavenProject project)
     
    protected boolean
    haveBuildPlugins(org.apache.maven.project.MavenProject project)
     
    boolean
    isExternalReport()
    protected abstract void
    populatePluginManagement(Set<org.apache.maven.model.Plugin> pluginManagementCollector)
    Implementations of AbstractPluginUpdatesReport may use this to supply the main processing logic with desired pluginManagement data, which will be used in the creation of the report.
    protected abstract void
    populatePlugins(Set<org.apache.maven.model.Plugin> pluginsCollector)
    Implementations of AbstractPluginUpdatesReport may use this to supply the main processing logic with desired build plugin information, which will be used to create the report.

    Methods inherited from class org.codehaus.mojo.versions.AbstractVersionsReport

    executeReport, getAllowSnapshots, getComparisonMethod, getDescription, getHelper, getI18n, getName, getText

    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, 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

    getOutputName, getOutputPath

  • Field Details

    • onlyProjectPlugins

      @Parameter(property="onlyProjectPlugins", defaultValue="false") protected boolean onlyProjectPlugins
      If true, only shows the subsection of the pluginManagement artifacts that are actually used in the project's plugin graph. false by default.
      Since:
      2.12

    • onlyUpgradable

      @Parameter(property="onlyUpgradable", defaultValue="false") protected boolean onlyUpgradable
      If true, only shows upgradable plugins in the report. false by default.
      Since:
      2.12

  • Constructor Details

    • AbstractPluginUpdatesReport

      protected AbstractPluginUpdatesReport(org.codehaus.plexus.i18n.I18N i18n, org.apache.maven.artifact.handler.manager.ArtifactHandlerManager artifactHandlerManager, org.eclipse.aether.RepositorySystem repositorySystem, Map<String,org.apache.maven.wagon.Wagon> wagonMap, ReportRendererFactory rendererFactory)

  • Method Details

    • isExternalReport

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

    • canGenerateReport

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

    • haveBuildPluginManagementPlugins

      protected boolean haveBuildPluginManagementPlugins(org.apache.maven.project.MavenProject project)

    • haveBuildPlugins

      protected boolean haveBuildPlugins(org.apache.maven.project.MavenProject project)

    • doGenerateReport

      protected void doGenerateReport(Locale locale, org.apache.maven.doxia.sink.Sink sink) throws org.apache.maven.reporting.MavenReportException
      generates an empty report in case there are no sources to generate a report with
      Specified by:
      doGenerateReport in class AbstractVersionsReport<PluginUpdatesModel>
      Parameters:
      locale - the locale to generate the report for.
      sink - the report formatting tool
      Throws:
      org.apache.maven.reporting.MavenReportException - when things go wrong.

    • populatePluginManagement

      protected abstract void populatePluginManagement(Set<org.apache.maven.model.Plugin> pluginManagementCollector)
      Implementations of AbstractPluginUpdatesReport may use this to supply the main processing logic with desired pluginManagement data, which will be used in the creation of the report.
      Parameters:
      pluginManagementCollector - , a set initialized with a PluginComparator comparator.

    • populatePlugins

      protected abstract void populatePlugins(Set<org.apache.maven.model.Plugin> pluginsCollector)
      Implementations of AbstractPluginUpdatesReport may use this to supply the main processing logic with desired build plugin information, which will be used to create the report.
      Parameters:
      pluginsCollector - , a set initialized with a PluginComparator comparator.