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 and 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 and Description
Reporting()

Method Summary

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

Methods inherited from class java.lang.Object

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

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

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

Constructor Detail

Reporting

public Reporting()

Method Detail

addPlugin

public void addPlugin(ReportPlugin reportPlugin)

Method addPlugin.

Parameters:

reportPlugin - a reportPlugin object.

clone

public Reporting clone()

Method clone.

Overrides:

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

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

Parameters:

key - a key object.

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

Parameters:

key - a key object.

location - a location object.

setOtherLocation

public void setOtherLocation(java.lang.Object key,
                             InputLocation location)

Parameters:

key - a key object.

location - a location object.

getOtherLocation

private InputLocation getOtherLocation(java.lang.Object key)

Parameters:

key - a key object.

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 - a reportPlugin object.

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

Parameters:

excludeDefaults - a excludeDefaults object.

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 - a outputDirectory object.

setPlugins

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

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()