Package org.apache.maven.model
Class Reporting
- java.lang.Object
-
- org.apache.maven.model.Reporting
-
- All Implemented Interfaces:
java.io.Serializable
,java.lang.Cloneable
,InputLocationTracker
public class Reporting extends java.lang.Object implements java.io.Serializable, java.lang.Cloneable, InputLocationTracker
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.String
excludeDefaults
If true, then the default reports are not included in the site generation.private InputLocation
excludeDefaultsLocation
Field excludeDefaultsLocation.private InputLocation
location
Field location.private java.util.Map<java.lang.Object,InputLocation>
locations
Field locations.private java.lang.String
outputDirectory
Where to store all of the generated reports.private InputLocation
outputDirectoryLocation
Field outputDirectoryLocation.private java.util.List<ReportPlugin>
plugins
Field plugins.private InputLocation
pluginsLocation
Field pluginsLocation.(package private) java.util.Map<java.lang.String,ReportPlugin>
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.Reporting
clone()
Method clone.void
flushReportPluginMap()
Reset thereportPluginMap
field tonull
java.lang.String
getExcludeDefaults()
Get if true, then the default reports are not included in the site generation.InputLocation
getLocation(java.lang.Object key)
Gets the location of the specified field in the input source.private InputLocation
getOtherLocation(java.lang.Object key)
java.lang.String
getOutputDirectory()
Get where to store all of the generated reports.java.util.List<ReportPlugin>
getPlugins()
Method getPlugins.java.util.Map<java.lang.String,ReportPlugin>
getReportPluginsAsMap()
boolean
isExcludeDefaults()
void
removePlugin(ReportPlugin reportPlugin)
Method removePlugin.void
setExcludeDefaults(boolean excludeDefaults)
void
setExcludeDefaults(java.lang.String excludeDefaults)
Set if true, then the default reports are not included in the site generation.void
setLocation(java.lang.Object key, InputLocation location)
Sets the location of the specified field.void
setOtherLocation(java.lang.Object key, InputLocation location)
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
-
excludeDefaults
private java.lang.String excludeDefaults
If true, then the default reports are not included in the site generation. This includes the reports in the "Project Info" menu. Note: While the type of this field isString
for technical reasons, the semantic type is actuallyBoolean
. Default value isfalse
.
-
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.
-
locations
private java.util.Map<java.lang.Object,InputLocation> locations
Field locations.
-
location
private InputLocation location
Field location.
-
excludeDefaultsLocation
private InputLocation excludeDefaultsLocation
Field excludeDefaultsLocation.
-
outputDirectoryLocation
private InputLocation outputDirectoryLocation
Field outputDirectoryLocation.
-
pluginsLocation
private InputLocation pluginsLocation
Field pluginsLocation.
-
reportPluginMap
java.util.Map<java.lang.String,ReportPlugin> reportPluginMap
-
-
Method Detail
-
addPlugin
public void addPlugin(ReportPlugin reportPlugin)
Method addPlugin.- Parameters:
reportPlugin
-
-
clone
public Reporting clone()
Method clone.- Overrides:
clone
in classjava.lang.Object
- Returns:
- Reporting
-
getExcludeDefaults
public java.lang.String getExcludeDefaults()
Get if true, then the default reports are not included in the site generation. This includes the reports in the "Project Info" menu. Note: While the type of this field isString
for technical reasons, the semantic type is actuallyBoolean
. Default value isfalse
.- Returns:
- String
-
getLocation
public InputLocation getLocation(java.lang.Object key)
Description copied from interface:InputLocationTracker
Gets the location of the specified field in the input source.- Specified by:
getLocation
in interfaceInputLocationTracker
- Parameters:
key
-- Returns:
- InputLocation
-
setLocation
public void setLocation(java.lang.Object key, InputLocation location)
Description copied from interface:InputLocationTracker
Sets the location of the specified field.- Specified by:
setLocation
in interfaceInputLocationTracker
- Parameters:
key
-location
-
-
setOtherLocation
public void setOtherLocation(java.lang.Object key, InputLocation location)
- Parameters:
key
-location
-
-
getOtherLocation
private InputLocation getOtherLocation(java.lang.Object key)
- Parameters:
key
-- Returns:
- InputLocation
-
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
-
removePlugin
public void removePlugin(ReportPlugin reportPlugin)
Method removePlugin.- Parameters:
reportPlugin
-
-
setExcludeDefaults
public void setExcludeDefaults(java.lang.String excludeDefaults)
Set if true, then the default reports are not included in the site generation. This includes the reports in the "Project Info" menu. Note: While the type of this field isString
for technical reasons, the semantic type is actuallyBoolean
. Default value isfalse
.- 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
-
-
isExcludeDefaults
public boolean isExcludeDefaults()
-
setExcludeDefaults
public void setExcludeDefaults(boolean excludeDefaults)
-
flushReportPluginMap
public void flushReportPluginMap()
Reset thereportPluginMap
field tonull
-
getReportPluginsAsMap
public java.util.Map<java.lang.String,ReportPlugin> getReportPluginsAsMap()
- Returns:
- a Map of plugins field with
ReportPlugin#getKey()
as key - See Also:
ReportPlugin.getKey()
-
-