Package org.apache.maven.model
Class Reporting
java.lang.Object
org.apache.maven.model.Reporting
- All Implemented Interfaces:
Serializable
,Cloneable
,InputLocationTracker
Section for management of reports and their configuration.
- Version:
- $Revision$ $Date$
- See Also:
-
Field Summary
FieldsModifier and TypeFieldDescriptionprivate String
If true, then the default reports are not included in the site generation.private InputLocation
Field excludeDefaultsLocation.private InputLocation
Field location.private Map<Object,
InputLocation> Field locations.private String
Where to store all of the generated reports.private InputLocation
Field outputDirectoryLocation.private List<ReportPlugin>
Field plugins.private InputLocation
Field pluginsLocation.(package private) Map<String,
ReportPlugin> -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionvoid
addPlugin
(ReportPlugin reportPlugin) Method addPlugin.clone()
Method clone.void
Reset thereportPluginMap
field tonull
Get if true, then the default reports are not included in the site generation.getLocation
(Object key) Gets the location of the specified field in the input source.private InputLocation
getOtherLocation
(Object key) Get where to store all of the generated reports.Method getPlugins.boolean
void
removePlugin
(ReportPlugin reportPlugin) Method removePlugin.void
setExcludeDefaults
(boolean excludeDefaults) void
setExcludeDefaults
(String excludeDefaults) Set if true, then the default reports are not included in the site generation.void
setLocation
(Object key, InputLocation location) Sets the location of the specified field.void
setOtherLocation
(Object key, InputLocation location) 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
-
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
Where to store all of the generated reports. The default is${project.build.directory}/site
. -
plugins
Field plugins. -
locations
Field locations. -
location
Field location. -
excludeDefaultsLocation
Field excludeDefaultsLocation. -
outputDirectoryLocation
Field outputDirectoryLocation. -
pluginsLocation
Field pluginsLocation. -
reportPluginMap
Map<String,ReportPlugin> reportPluginMap
-
-
Constructor Details
-
Reporting
public Reporting()
-
-
Method Details
-
addPlugin
Method addPlugin.- Parameters:
reportPlugin
- a reportPlugin object.
-
clone
Method clone. -
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
Description copied from interface:InputLocationTracker
Gets the location of the specified field in the input source.- Specified by:
getLocation
in interfaceInputLocationTracker
- Parameters:
key
- a key object.- Returns:
- InputLocation
-
setLocation
Description copied from interface:InputLocationTracker
Sets the location of the specified field.- Specified by:
setLocation
in interfaceInputLocationTracker
- Parameters:
key
- a key object.location
- a location object.
-
setOtherLocation
- Parameters:
key
- a key object.location
- a location object.
-
getOtherLocation
- Parameters:
key
- a key object.- Returns:
- InputLocation
-
getOutputDirectory
Get where to store all of the generated reports. The default is${project.build.directory}/site
.- Returns:
- String
-
getPlugins
Method getPlugins.- Returns:
- List
-
removePlugin
Method removePlugin.- Parameters:
reportPlugin
- a reportPlugin object.
-
setExcludeDefaults
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
- a excludeDefaults object.
-
setOutputDirectory
Set where to store all of the generated reports. The default is${project.build.directory}/site
.- Parameters:
outputDirectory
- a outputDirectory object.
-
setPlugins
Set the reporting plugins to use and their configuration.- Parameters:
plugins
- a plugins object.
-
isExcludeDefaults
public boolean isExcludeDefaults() -
setExcludeDefaults
public void setExcludeDefaults(boolean excludeDefaults) -
flushReportPluginMap
public void flushReportPluginMap()Reset thereportPluginMap
field tonull
-
getReportPluginsAsMap
- Returns:
- a Map of plugins field with
ReportPlugin#getKey()
as key - See Also:
-