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 contains informations required for a report plugin.- Version:
- $Revision$ $Date$
- See Also:
- Serialized Form
-
-
Field Summary
Fields Modifier and Type Field Description private java.lang.String
artifactId
The artifact ID of the reporting plugin in the repository.private java.lang.String
groupId
The group ID of the reporting plugin in the repository.private java.util.Map<java.lang.String,ReportSet>
reportSetMap
private java.util.List<ReportSet>
reportSets
Field reportSets.private java.lang.String
version
The version of the reporting plugin to be used.
-
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 java.lang.String
constructKey(java.lang.String groupId, java.lang.String artifactId)
void
flushReportSetMap()
Reset thereportSetMap
field tonull
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
-
-
-
-
Field Detail
-
groupId
private java.lang.String groupId
The group ID of the reporting plugin in the repository.
-
artifactId
private java.lang.String artifactId
The artifact ID of the reporting plugin in the repository.
-
version
private java.lang.String version
The version of the reporting plugin to be used.
-
reportSets
private java.util.List<ReportSet> reportSets
Field reportSets.
-
reportSetMap
private java.util.Map<java.lang.String,ReportSet> reportSetMap
-
-
Method Detail
-
addReportSet
public void addReportSet(ReportSet reportSet)
Method addReportSet.- Parameters:
reportSet
-
-
clone
public ReportPlugin clone()
Method clone.- Overrides:
clone
in classConfigurationContainer
- 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.- Returns:
- String
-
removeReportSet
public void removeReportSet(ReportSet reportSet)
Method removeReportSet.- Parameters:
reportSet
-
-
setArtifactId
public void setArtifactId(java.lang.String artifactId)
Set the artifact ID of the reporting plugin in the repository.- Parameters:
artifactId
-
-
setGroupId
public void setGroupId(java.lang.String groupId)
Set the group ID of the reporting plugin in the repository.- Parameters:
groupId
-
-
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 anexecution
in the build.- Parameters:
reportSets
-
-
setVersion
public void setVersion(java.lang.String version)
Set the version of the reporting plugin to be used.- Parameters:
version
-
-
flushReportSetMap
public void flushReportSetMap()
Reset thereportSetMap
field tonull
-
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 repositoryartifactId
- The artifact ID of the reporting plugin in the repository- Returns:
- the key of the report plugin, ie
groupId:artifactId
-
-