Package org.apache.maven.model
Class ReportPlugin
- java.lang.Object
-
- org.apache.maven.model.ConfigurationContainer
-
- org.apache.maven.model.ReportPlugin
-
- All Implemented Interfaces:
Serializable
,Cloneable
,InputLocationTracker
public class ReportPlugin extends ConfigurationContainer implements Serializable, 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
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description void
addReportSet(ReportSet reportSet)
Method addReportSet.ReportPlugin
clone()
Method clone.static String
constructKey(String groupId, String artifactId)
void
flushReportSetMap()
Reset thereportSetMap
field tonull
String
getArtifactId()
Get the artifact ID of the reporting plugin in the repository.String
getGroupId()
Get the group ID of the reporting plugin in the repository.String
getKey()
List<ReportSet>
getReportSets()
Method getReportSets.Map<String,ReportSet>
getReportSetsAsMap()
String
getVersion()
Get the version of the reporting plugin to be used.void
removeReportSet(ReportSet reportSet)
Method removeReportSet.void
setArtifactId(String artifactId)
Set the artifact ID of the reporting plugin in the repository.void
setGroupId(String groupId)
Set the group ID of the reporting plugin in the repository.void
setReportSets(List<ReportSet> reportSets)
Set multiple specifications of a set of reports, each having (possibly) different configuration.void
setVersion(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
-
-
-
-
Method Detail
-
addReportSet
public void addReportSet(ReportSet reportSet)
Method addReportSet.- Parameters:
reportSet
- a reportSet object.
-
clone
public ReportPlugin clone()
Method clone.- Overrides:
clone
in classConfigurationContainer
- Returns:
- ReportPlugin
-
getArtifactId
public String getArtifactId()
Get the artifact ID of the reporting plugin in the repository.- Returns:
- String
-
getGroupId
public String getGroupId()
Get the group ID of the reporting plugin in the repository.- Returns:
- String
-
getVersion
public 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 inbuild/plugins
then inbuild/pluginManagement
.- Returns:
- String
-
removeReportSet
public void removeReportSet(ReportSet reportSet)
Method removeReportSet.- Parameters:
reportSet
- a reportSet object.
-
setArtifactId
public void setArtifactId(String artifactId)
Set the artifact ID of the reporting plugin in the repository.- Parameters:
artifactId
- a artifactId object.
-
setGroupId
public void setGroupId(String groupId)
Set the group ID of the reporting plugin in the repository.- Parameters:
groupId
- a groupId object.
-
setReportSets
public void setReportSets(List<ReportSet> reportSets)
Set multiple specifications of a set of reports, each having (possibly) different configuration. This is the reporting parallel to anexecution
in the build.- Parameters:
reportSets
- a reportSets object.
-
setVersion
public void setVersion(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 inbuild/plugins
then inbuild/pluginManagement
.- Parameters:
version
- a version object.
-
flushReportSetMap
public void flushReportSetMap()
Reset thereportSetMap
field tonull
-
getReportSetsAsMap
public Map<String,ReportSet> getReportSetsAsMap()
- Returns:
- a Map of reportSets field with
ReportSet#getId()
as key - See Also:
ReportSet.getId()
-
getKey
public String getKey()
- Returns:
- the key of the report plugin, ie
groupId:artifactId
-
-