org.apache.maven.model
Class Reporting

java.lang.Object
  extended by 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:
Serialized Form

Constructor Summary
Reporting()
           
 
Method Summary
 void addPlugin(ReportPlugin reportPlugin)
          Method addPlugin.
 void flushReportPluginMap()
           
 String getOutputDirectory()
          Get where to store all of the generated reports.
 List<ReportPlugin> getPlugins()
          Method getPlugins.
 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(String outputDirectory)
          Set where to store all of the generated reports.
 void setPlugins(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
 

Constructor Detail

Reporting

public Reporting()
Method Detail

addPlugin

public void addPlugin(ReportPlugin reportPlugin)
Method addPlugin.

Parameters:
reportPlugin -

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

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(String outputDirectory)
Set where to store all of the generated reports. The default is ${project.build.directory}/site .

Parameters:
outputDirectory -

setPlugins

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

Parameters:
plugins -

flushReportPluginMap

public void flushReportPluginMap()

getReportPluginsAsMap

public Map getReportPluginsAsMap()


Copyright © 2001-2011 Apache Software Foundation. All Rights Reserved.