org.apache.maven.model
Class Reporting

java.lang.Object
  extended by org.apache.maven.model.Reporting
All Implemented Interfaces:
java.io.Serializable

public class Reporting
extends java.lang.Object
implements java.io.Serializable

Section for management of reports and their configuration.

Version:
$Revision$ $Date$
See Also:
Serialized Form

Field Summary
private  boolean excludeDefaults
          If true, then the default reports are not included in the site generation.
private  java.lang.String outputDirectory
          Where to store all of the generated reports.
private  java.util.List<ReportPlugin> plugins
          Field plugins.
(package private)  java.util.Map reportPluginMap
           
 
Constructor Summary
Reporting()
           
 
Method Summary
 void addPlugin(ReportPlugin reportPlugin)
          Method addPlugin.
 void flushReportPluginMap()
           
 java.lang.String getOutputDirectory()
          Get where to store all of the generated reports.
 java.util.List<ReportPlugin> getPlugins()
          Method getPlugins.
 java.util.Map getReportPluginsAsMap()
           
 boolean isExcludeDefaults()
          Get if true, then the default reports are not included in the site generation.
 void removePlugin(ReportPlugin reportPlugin)
          Method removePlugin.
 void setExcludeDefaults(boolean excludeDefaults)
          Set if true, then the default reports are not included in the site generation.
 void setOutputDirectory(java.lang.String outputDirectory)
          Set where to store all of the generated reports.
 void setPlugins(java.util.List<ReportPlugin> plugins)
          Set the reporting plugins to use and their configuration.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

excludeDefaults

private boolean excludeDefaults
If true, then the default reports are not included in the site generation. This includes the reports in the "Project Info" menu.


outputDirectory

private java.lang.String outputDirectory
Where to store all of the generated reports. The default is ${project.build.directory}/site .


plugins

private java.util.List<ReportPlugin> plugins
Field plugins.


reportPluginMap

java.util.Map reportPluginMap
Constructor Detail

Reporting

public Reporting()
Method Detail

addPlugin

public void addPlugin(ReportPlugin reportPlugin)
Method addPlugin.

Parameters:
reportPlugin -

getOutputDirectory

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

Returns:
String

getPlugins

public java.util.List<ReportPlugin> getPlugins()
Method getPlugins.

Returns:
List

isExcludeDefaults

public boolean isExcludeDefaults()
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 -

setExcludeDefaults

public void setExcludeDefaults(boolean excludeDefaults)
Set if true, then the default reports are not included in the site generation. This includes the reports in the "Project Info" menu.

Parameters:
excludeDefaults -

setOutputDirectory

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

Parameters:
outputDirectory -

setPlugins

public void setPlugins(java.util.List<ReportPlugin> plugins)
Set the reporting plugins to use and their configuration.

Parameters:
plugins -

flushReportPluginMap

public void flushReportPluginMap()

getReportPluginsAsMap

public java.util.Map getReportPluginsAsMap()