Package org.apache.maven.plugin.plugin

Class PluginReport.PluginOverviewRenderer

java.lang.Object
org.apache.maven.reporting.AbstractMavenReportRenderer
org.apache.maven.plugin.plugin.PluginReport.PluginOverviewRenderer
All Implemented Interfaces:
org.apache.maven.reporting.MavenReportRenderer
Enclosing class:
PluginReport
static class PluginReport.PluginOverviewRenderer extends org.apache.maven.reporting.AbstractMavenReportRenderer
Generates an overview page with the list of goals and a link to the goal's page.

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    private final Locale
    locale
     
    private final org.apache.maven.plugin.descriptor.PluginDescriptor
    pluginDescriptor
     
    private final org.apache.maven.project.MavenProject
    project
     
    private final Requirements
    requirements
     

    Fields inherited from class org.apache.maven.reporting.AbstractMavenReportRenderer

    sink

  • Constructor Summary

    Constructors
    Constructor
    Description
    PluginOverviewRenderer(org.apache.maven.project.MavenProject project, Requirements requirements, org.apache.maven.doxia.sink.Sink sink, org.apache.maven.plugin.descriptor.PluginDescriptor pluginDescriptor, Locale locale)
     

  • Method Summary

    Modifier and Type
    Method
    Description
    private static String
    discoverJdkRequirement(org.apache.maven.project.MavenProject project, Requirements requirements)
    use configured jdk requirement use target configuration of org.apache.maven.plugins:maven-compiler-plugin use target configuration of org.apache.maven.plugins:maven-compiler-plugin in pluginManagement use maven.compiler.target property
    private static String
    discoverMavenRequirement(org.apache.maven.project.MavenProject project, Requirements requirements)
    Try to lookup on the Maven prerequisites property.
    private static org.apache.maven.model.Plugin
    getCompilerPlugin(Map<String,org.apache.maven.model.Plugin> pluginsAsMap)
     
    private static String
    getPluginParameter(org.apache.maven.model.Plugin plugin, String parameter)
     
    String
    getTitle()
    void
    renderBody()
    private void
    renderUsageSection(boolean hasMavenReport)
    Render the section about the usage of the plugin.

    Methods inherited from class org.apache.maven.reporting.AbstractMavenReportRenderer

    createLinkPatternedText, endSection, endTable, javaScript, link, linkPatternedText, paragraph, propertiesToString, render, startSection, startTable, startTable, tableCaption, tableCell, tableCell, tableHeader, tableHeaderCell, tableRow, text, verbatimLink, verbatimText

    Methods inherited from class java.lang.Object

    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

  • Field Details

    • project

      private final org.apache.maven.project.MavenProject project

    • requirements

      private final Requirements requirements

    • pluginDescriptor

      private final org.apache.maven.plugin.descriptor.PluginDescriptor pluginDescriptor

    • locale

      private final Locale locale

  • Constructor Details

    • PluginOverviewRenderer

      PluginOverviewRenderer(org.apache.maven.project.MavenProject project, Requirements requirements, org.apache.maven.doxia.sink.Sink sink, org.apache.maven.plugin.descriptor.PluginDescriptor pluginDescriptor, Locale locale)
      Parameters:
      project - not null
      requirements - not null
      sink - not null
      pluginDescriptor - not null
      locale - not null

  • Method Details

    • getTitle

      public String getTitle()
      Specified by:
      getTitle in interface org.apache.maven.reporting.MavenReportRenderer
      Specified by:
      getTitle in class org.apache.maven.reporting.AbstractMavenReportRenderer

    • renderBody

      public void renderBody()
      Specified by:
      renderBody in class org.apache.maven.reporting.AbstractMavenReportRenderer

    • renderUsageSection

      private void renderUsageSection(boolean hasMavenReport)
      Render the section about the usage of the plugin.
      Parameters:
      hasMavenReport - If the plugin has a report or not

    • discoverMavenRequirement

      private static String discoverMavenRequirement(org.apache.maven.project.MavenProject project, Requirements requirements)
      Try to lookup on the Maven prerequisites property. If not specified, uses the value defined by the user.
      Parameters:
      project - not null
      requirements - not null
      Returns:
      the Maven version

    • discoverJdkRequirement

      private static String discoverJdkRequirement(org.apache.maven.project.MavenProject project, Requirements requirements)
      1. use configured jdk requirement
      2. use target configuration of org.apache.maven.plugins:maven-compiler-plugin
      3. use target configuration of org.apache.maven.plugins:maven-compiler-plugin in pluginManagement
      4. use maven.compiler.target property
      Parameters:
      project - not null
      requirements - not null
      Returns:
      the JDK version

    • getCompilerPlugin

      private static org.apache.maven.model.Plugin getCompilerPlugin(Map<String,org.apache.maven.model.Plugin> pluginsAsMap)

    • getPluginParameter

      private static String getPluginParameter(org.apache.maven.model.Plugin plugin, String parameter)