Package org.apache.maven.model
Class Reporting
java.lang.Object
org.apache.maven.model.Reporting
- All Implemented Interfaces:
Serializable
Section for management of reports and their configuration.
- Version:
- $Revision$ $Date$
- See Also:
-
Field Summary
FieldsModifier and TypeFieldDescriptionprivate Boolean
If true, then the default reports are not included in the site generation.private String
Where to store all of the generated reports.private List<ReportPlugin>
Field plugins.(package private) Map
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionvoid
addPlugin
(ReportPlugin reportPlugin) Method addPlugin.void
Reset thereportPluginMap
field tonull
Get where to store all of the generated reports.Method getPlugins.boolean
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
(Boolean excludeDefaultsValue) Set if true, then the default reports are not included in the site generation.void
setExcludeDefaultsValue
(String excludeDefaults) 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.
-
Field Details
-
excludeDefaultsValue
If true, then the default reports are not included in the site generation. This includes the reports in the "Project Info" menu. -
outputDirectory
Where to store all of the generated reports. The default is${project.build.directory}/site
. -
plugins
Field plugins. -
reportPluginMap
Map reportPluginMap
-
-
Constructor Details
-
Reporting
public Reporting()
-
-
Method Details
-
addPlugin
Method addPlugin.- Parameters:
reportPlugin
-
-
getOutputDirectory
Get where to store all of the generated reports. The default is${project.build.directory}/site
.- Returns:
- String
-
getPlugins
Method getPlugins.- Returns:
- List
-
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
Method removePlugin.- Parameters:
reportPlugin
-
-
setExcludeDefaultsValue
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
Set where to store all of the generated reports. The default is${project.build.directory}/site
.- Parameters:
outputDirectory
-
-
setPlugins
Set the reporting plugins to use and their configuration.- Parameters:
plugins
-
-
flushReportPluginMap
public void flushReportPluginMap()Reset thereportPluginMap
field tonull
-
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
-