Package org.apache.maven.model

Class ReportPlugin

java.lang.Object

org.apache.maven.model.ConfigurationContainer

org.apache.maven.model.ReportPlugin

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable, InputLocationTracker

public class ReportPlugin
extends ConfigurationContainer
implements java.io.Serializable, java.lang.Cloneable

The <plugin> element in <reporting><plugins> contains informations required for a report plugin.

Version:

$Revision$ $Date$

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor	Description
ReportPlugin()

Method Summary

Modifier and Type	Method	Description
void	addReportSet(ReportSet reportSet)	Method addReportSet.
ReportPlugin	clone()	Method clone.
static java.lang.String	constructKey(java.lang.String groupId, java.lang.String artifactId)
void	flushReportSetMap()	Reset the reportSetMap field to null
java.lang.String	getArtifactId()	Get the artifact ID of the reporting plugin in the repository.
java.lang.String	getGroupId()	Get the group ID of the reporting plugin in the repository.
java.lang.String	getKey()
java.util.List<ReportSet>	getReportSets()	Method getReportSets.
java.util.Map<java.lang.String,ReportSet>	getReportSetsAsMap()
java.lang.String	getVersion()	Get the version of the reporting plugin to be used.
void	removeReportSet(ReportSet reportSet)	Method removeReportSet.
void	setArtifactId(java.lang.String artifactId)	Set the artifact ID of the reporting plugin in the repository.
void	setGroupId(java.lang.String groupId)	Set the group ID of the reporting plugin in the repository.
void	setReportSets(java.util.List<ReportSet> reportSets)	Set multiple specifications of a set of reports, each having (possibly) different configuration.
void	setVersion(java.lang.String version)	Set the version of the reporting plugin to be used.

Methods inherited from class org.apache.maven.model.ConfigurationContainer

getConfiguration, getInherited, getLocation, isInheritanceApplied, isInherited, setConfiguration, setInherited, setInherited, setLocation, setOtherLocation, unsetInheritanceApplied

Methods inherited from class java.lang.Object

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

Constructor Detail

ReportPlugin

public ReportPlugin()

Method Detail

addReportSet

public void addReportSet(ReportSet reportSet)

Method addReportSet.

Parameters:

reportSet - a reportSet object.

clone

public ReportPlugin clone()

Method clone.

Overrides:

clone in class ConfigurationContainer

Returns:

ReportPlugin

getArtifactId

public java.lang.String getArtifactId()

Get the artifact ID of the reporting plugin in the repository.

Returns:

String

getGroupId

public java.lang.String getGroupId()

Get the group ID of the reporting plugin in the repository.

Returns:

String

getReportSets

public java.util.List<ReportSet> getReportSets()

Method getReportSets.

Returns:

List

getVersion

public java.lang.String getVersion()

Get the version of the reporting plugin to be used. Starting with Maven 3, if no version is defined explicitely, version is searched in build/plugins then in build/pluginManagement.

Returns:

String

removeReportSet

public void removeReportSet(ReportSet reportSet)

Method removeReportSet.

Parameters:

reportSet - a reportSet object.

setArtifactId

public void setArtifactId(java.lang.String artifactId)

Set the artifact ID of the reporting plugin in the repository.

Parameters:

artifactId - a artifactId object.

setGroupId

public void setGroupId(java.lang.String groupId)

Set the group ID of the reporting plugin in the repository.

Parameters:

groupId - a groupId object.

setReportSets

public void setReportSets(java.util.List<ReportSet> reportSets)

Set multiple specifications of a set of reports, each having (possibly) different configuration. This is the reporting parallel to an execution in the build.

Parameters:

reportSets - a reportSets object.

setVersion

public void setVersion(java.lang.String version)

Set the version of the reporting plugin to be used. Starting with Maven 3, if no version is defined explicitely, version is searched in build/plugins then in build/pluginManagement.

Parameters:

version - a version object.

flushReportSetMap

public void flushReportSetMap()

Reset the reportSetMap field to null

getReportSetsAsMap

public java.util.Map<java.lang.String,ReportSet> getReportSetsAsMap()

Returns:

a Map of reportSets field with ReportSet#getId() as key

See Also:

ReportSet.getId()

getKey

public java.lang.String getKey()

Returns:

the key of the report plugin, ie groupId:artifactId

constructKey

public static java.lang.String constructKey(java.lang.String groupId,
                                            java.lang.String artifactId)

Parameters:

groupId - The group ID of the plugin in the repository

artifactId - The artifact ID of the reporting plugin in the repository

Returns:

the key of the report plugin, ie groupId:artifactId