org.apache.maven.model
Class Reporting

java.lang.Object
  org.apache.maven.model.Reporting

All Implemented Interfaces:

Serializable

public class Reporting
extends Object
implements Serializable

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.
void	flushReportPluginMap() Reset the reportPluginMap field to null
String	getModelEncoding()
String	getOutputDirectory() Get Where to store all of the generated reports.
List	getPlugins() Method getPlugins.
Map	getReportPluginsAsMap()
boolean	isExcludeDefaults()
Boolean	isExcludeDefaultsValue() Get if true, then the default reports are not included in the site generation.
void	removePlugin(ReportPlugin reportPlugin) Method removePlugin.
void	setExcludeDefaults(boolean excludeDefaults)
void	setExcludeDefaultsValue(Boolean excludeDefaultsValue) Set if true, then the default reports are not included in the site generation.
void	setExcludeDefaultsValue(String excludeDefaults)
void	setModelEncoding(String modelEncoding) Set an encoding used for reading/writing the model.
void	setOutputDirectory(String outputDirectory) Set Where to store all of the generated reports.
void	setPlugins(List plugins) Set the reporting plugins to use and their configuration.

Methods inherited from class java.lang.Object

clone, 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 -

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

Method getPlugins.

Returns:

java.util.List

isExcludeDefaultsValue

public Boolean isExcludeDefaultsValue()

Get if true, then the default reports are not included in the site generation. This includes the reports in the "Project Info" menu.

Returns:

Boolean

removePlugin

public void removePlugin(ReportPlugin reportPlugin)

Method removePlugin.

Parameters:

reportPlugin -

setExcludeDefaultsValue

public void setExcludeDefaultsValue(Boolean excludeDefaultsValue)

Set if true, then the default reports are not included in the site generation. This includes the reports in the "Project Info" menu.

Parameters:

excludeDefaultsValue -

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

Set the reporting plugins to use and their configuration.

Parameters:

plugins -

flushReportPluginMap

public void flushReportPluginMap()

Reset the reportPluginMap field to null

getReportPluginsAsMap

public Map getReportPluginsAsMap()

Returns:

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

See Also:

ReportPlugin.getKey()

isExcludeDefaults

public boolean isExcludeDefaults()

setExcludeDefaults

public void setExcludeDefaults(boolean excludeDefaults)

setExcludeDefaultsValue

public void setExcludeDefaultsValue(String excludeDefaults)

setModelEncoding

public void setModelEncoding(String modelEncoding)

Set an encoding used for reading/writing the model.

Parameters:

modelEncoding - the encoding used when reading/writing the model.

getModelEncoding

public String getModelEncoding()

Returns:

the current encoding used when reading/writing this model.