Class ReportPlugin

java.lang.Object
org.apache.maven.model.ConfigurationContainer
org.apache.maven.model.ReportPlugin
All Implemented Interfaces:
Serializable, Cloneable, InputLocationTracker
public class ReportPlugin extends ConfigurationContainer implements Serializable, Cloneable
The <plugin> element in <reporting><plugins> contains informations required for a report plugin.
Version:
$Revision$ $Date$
See Also:

  • Constructor Details

    • ReportPlugin

      public ReportPlugin()

  • Method Details

    • addReportSet

      public void addReportSet(ReportSet reportSet)
      Method addReportSet.
      Parameters:
      reportSet - a reportSet object.

    • clone

      public ReportPlugin clone()
      Method clone.
      Overrides:
      clone in class ConfigurationContainer
      Returns:
      ReportPlugin

    • getArtifactId

      public String getArtifactId()
      Get the artifact ID of the reporting plugin in the repository.
      Returns:
      String

    • getGroupId

      public String getGroupId()
      Get the group ID of the reporting plugin in the repository.
      Returns:
      String

    • getReportSets

      public List<ReportSet> getReportSets()
      Method getReportSets.
      Returns:
      List

    • getVersion

      public String getVersion()
      Get the version of the reporting plugin to be used. Starting with Maven 3, if no version is defined explicitely, version is searched in build/plugins then in build/pluginManagement.
      Returns:
      String

    • removeReportSet

      public void removeReportSet(ReportSet reportSet)
      Method removeReportSet.
      Parameters:
      reportSet - a reportSet object.

    • setArtifactId

      public void setArtifactId(String artifactId)
      Set the artifact ID of the reporting plugin in the repository.
      Parameters:
      artifactId - a artifactId object.

    • setGroupId

      public void setGroupId(String groupId)
      Set the group ID of the reporting plugin in the repository.
      Parameters:
      groupId - a groupId object.

    • setReportSets

      public void setReportSets(List<ReportSet> reportSets)
      Set multiple specifications of a set of reports, each having (possibly) different configuration. This is the reporting parallel to an execution in the build.
      Parameters:
      reportSets - a reportSets object.

    • setVersion

      public void setVersion(String version)
      Set the version of the reporting plugin to be used. Starting with Maven 3, if no version is defined explicitely, version is searched in build/plugins then in build/pluginManagement.
      Parameters:
      version - a version object.

    • flushReportSetMap

      public void flushReportSetMap()
      Reset the reportSetMap field to null

    • getReportSetsAsMap

      public Map<String, ReportSet> getReportSetsAsMap()
      Returns:
      a Map of reportSets field with ReportSet#getId() as key
      See Also:

    • getKey

      public String getKey()
      Returns:
      the key of the report plugin, ie groupId:artifactId

    • constructKey

      public static String constructKey(String groupId, String artifactId)
      Parameters:
      groupId - The group ID of the plugin in the repository
      artifactId - The artifact ID of the reporting plugin in the repository
      Returns:
      the key of the report plugin, ie groupId:artifactId