Package org.apache.maven.model
Class Reporting
- java.lang.Object
-
- 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
Fields Modifier and Type Field Description private java.lang.Boolean
excludeDefaultsValue
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
Constructors Constructor Description Reporting()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description void
addPlugin(ReportPlugin reportPlugin)
Method addPlugin.void
flushReportPluginMap()
Reset thereportPluginMap
field tonull
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()
java.lang.Boolean
isExcludeDefaultsValue()
Get if true, then the default reports are not included in the site generation.void
removePlugin(ReportPlugin reportPlugin)
Method removePlugin.void
setExcludeDefaults(boolean excludeDefaults)
void
setExcludeDefaultsValue(java.lang.Boolean excludeDefaultsValue)
Set if true, then the default reports are not included in the site generation.void
setExcludeDefaultsValue(java.lang.String excludeDefaults)
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.
-
-
-
Field Detail
-
excludeDefaultsValue
private java.lang.Boolean excludeDefaultsValue
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
-
-
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
-
isExcludeDefaultsValue
public java.lang.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
-
-
setExcludeDefaultsValue
public void setExcludeDefaultsValue(java.lang.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
-
-
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()
Reset thereportPluginMap
field tonull
-
getReportPluginsAsMap
public java.util.Map getReportPluginsAsMap()
- Returns:
- a Map of plugins field with
ReportPlugin#getKey()
as key - See Also:
ReportPlugin.getKey()
-
isExcludeDefaults
public boolean isExcludeDefaults()
-
setExcludeDefaults
public void setExcludeDefaults(boolean excludeDefaults)
-
setExcludeDefaultsValue
public void setExcludeDefaultsValue(java.lang.String excludeDefaults)
-
-