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

Reporting()

Method Summary

void	addPlugin(ReportPlugin reportPlugin) Method addPlugin.
Reporting	clone() Method clone.
void	flushReportPluginMap() Reset the reportPluginMap field to null
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	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.

Methods inherited from class java.lang.Object

equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Reporting

public Reporting()

Method Detail

addPlugin

public void addPlugin(ReportPlugin reportPlugin)

Method addPlugin.

Parameters:

reportPlugin -

clone

public Reporting clone()

Method clone.

Overrides:

clone in class Object

Returns:

Reporting

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 is String for technical reasons, the semantic type is actually Boolean. Default value is false.

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 interface InputLocationTracker

Parameters:

key -

Returns:

InputLocation

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 -

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 is String for technical reasons, the semantic type is actually Boolean. Default value is false.

Parameters:

excludeDefaults -

setLocation

public void setLocation(Object key,
                        InputLocation location)

Description copied from interface: InputLocationTracker

Sets the location of the specified field.

Specified by:

setLocation in interface InputLocationTracker

Parameters:

key -

location -

setOutputDirectory

public void setOutputDirectory(String outputDirectory)

Set where to store all of the generated reports. The default is ${project.build.directory}/site .

Parameters:

outputDirectory -

setPlugins

public void setPlugins(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 the reportPluginMap field to null

getReportPluginsAsMap

public Map<String,ReportPlugin> getReportPluginsAsMap()

Returns:

a Map of plugins field with ReportPlugin#getKey() as key

See Also:

ReportPlugin.getKey()