Class Reporting

java.lang.Object
org.apache.maven.model.Reporting
All Implemented Interfaces:
Serializable
public class Reporting extends Object implements Serializable
Section for management of reports and their configuration.
Version:
$Revision$ $Date$
See Also:

  • Constructor Details

    • Reporting

      public Reporting()

  • Method Details

    • addPlugin

      public void addPlugin(ReportPlugin reportPlugin)
      Method addPlugin.
      Parameters:
      reportPlugin - a reportPlugin object.

    • getOutputDirectory

      public String getOutputDirectory()
      Get where to store all of the generated reports. The default is ${project.build.directory}/site .
      Returns:
      String

    • getPlugins

      public List<ReportPlugin> getPlugins()
      Method getPlugins.
      Returns:
      List

    • isExcludeDefaultsValue

      public Boolean isExcludeDefaultsValue()
      Get if true, then the default reports are not included in the site generation. This includes the reports in the "Project Info" menu.
      Returns:
      Boolean

    • removePlugin

      public void removePlugin(ReportPlugin reportPlugin)
      Method removePlugin.
      Parameters:
      reportPlugin - a reportPlugin object.

    • setExcludeDefaultsValue

      public void setExcludeDefaultsValue(Boolean excludeDefaultsValue)
      Set if true, then the default reports are not included in the site generation. This includes the reports in the "Project Info" menu.
      Parameters:
      excludeDefaultsValue - a excludeDefaultsValue object.

    • setOutputDirectory

      public void setOutputDirectory(String outputDirectory)
      Set where to store all of the generated reports. The default is ${project.build.directory}/site .
      Parameters:
      outputDirectory - a outputDirectory object.

    • setPlugins

      public void setPlugins(List<ReportPlugin> plugins)
      Set the reporting plugins to use and their configuration.
      Parameters:
      plugins - a plugins object.

    • flushReportPluginMap

      public void flushReportPluginMap()
      Reset the reportPluginMap field to null

    • getReportPluginsAsMap

      public Map getReportPluginsAsMap()
      Returns:
      a Map of plugins field with ReportPlugin#getKey() as key
      See Also:

    • isExcludeDefaults

      public boolean isExcludeDefaults()

    • setExcludeDefaults

      public void setExcludeDefaults(boolean excludeDefaults)

    • setExcludeDefaultsValue

      public void setExcludeDefaultsValue(String excludeDefaults)