Package org.apache.maven.model
Class Reporting
- java.lang.Object
-
- org.apache.maven.model.Reporting
-
- All Implemented Interfaces:
Serializable
,Cloneable
,InputLocationTracker
public class Reporting extends Object implements Serializable, Cloneable, InputLocationTracker
Section for management of reports and their configuration.- Version:
- $Revision$ $Date$
- See Also:
- Serialized Form
-
-
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
String
getExcludeDefaults()
Get if true, then the default reports are not included in the site generation.InputLocation
getLocation(Object key)
Gets the location of the specified field in the input source.String
getOutputDirectory()
Get where to store all of the generated reports.List<ReportPlugin>
getPlugins()
Method getPlugins.Map<String,ReportPlugin>
getReportPluginsAsMap()
boolean
isExcludeDefaults()
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.
-
-
-
Method Detail
-
addPlugin
public void addPlugin(ReportPlugin reportPlugin)
Method addPlugin.- Parameters:
reportPlugin
- a reportPlugin object.
-
getExcludeDefaults
public 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(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
- a key object.- Returns:
- InputLocation
-
setLocation
public void setLocation(Object key, InputLocation location)
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
public void setOtherLocation(Object key, InputLocation location)
- Parameters:
key
- a key object.location
- a location object.
-
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
-
removePlugin
public void removePlugin(ReportPlugin reportPlugin)
Method removePlugin.- Parameters:
reportPlugin
- a reportPlugin object.
-
setExcludeDefaults
public void setExcludeDefaults(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
- a excludeDefaults object.
-
setOutputDirectory
public void setOutputDirectory(String outputDirectory)
Set where to store all of the generated reports. The default is${project.build.directory}/site
.- Parameters:
outputDirectory
- a outputDirectory object.
-
setPlugins
public void setPlugins(List<ReportPlugin> plugins)
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
public Map<String,ReportPlugin> getReportPluginsAsMap()
- Returns:
- a Map of plugins field with
ReportPlugin#getKey()
as key - See Also:
ReportPlugin.getKey()
-
-