Package org.apache.maven.model
Class ReportPlugin
- java.lang.Object
-
- org.apache.maven.model.ReportPlugin
-
- All Implemented Interfaces:
java.io.Serializable
public class ReportPlugin extends java.lang.Object implements java.io.Serializable
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.Object
configuration
The configuration of the reporting plugin.private java.lang.String
groupId
The group ID of the reporting plugin in the repository.private boolean
inheritanceApplied
private java.lang.String
inherited
Whether the configuration in this plugin should be made available to projects that inherit from this one.private java.util.Map
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.static java.lang.String
constructKey(java.lang.String groupId, java.lang.String artifactId)
boolean
equals(java.lang.Object other)
void
flushReportSetMap()
Reset thereportSetMap
field tonull
java.lang.String
getArtifactId()
Get the artifact ID of the reporting plugin in the repository.java.lang.Object
getConfiguration()
Get the configuration of the reporting plugin.java.lang.String
getGroupId()
Get the group ID of the reporting plugin in the repository.java.lang.String
getInherited()
Get whether the configuration in this plugin should be made available to projects that inherit from this one.java.lang.String
getKey()
java.util.List<ReportSet>
getReportSets()
Method getReportSets.java.util.Map
getReportSetsAsMap()
java.lang.String
getVersion()
Get the version of the reporting plugin to be used.int
hashCode()
boolean
isInheritanceApplied()
void
removeReportSet(ReportSet reportSet)
Method removeReportSet.void
setArtifactId(java.lang.String artifactId)
Set the artifact ID of the reporting plugin in the repository.void
setConfiguration(java.lang.Object configuration)
Set the configuration of the reporting plugin.void
setGroupId(java.lang.String groupId)
Set the group ID of the reporting plugin in the repository.void
setInherited(java.lang.String inherited)
Set whether the configuration in this plugin should be made available to projects that inherit from this one.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.java.lang.String
toString()
void
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.
-
inherited
private java.lang.String inherited
Whether the configuration in this plugin should be made available to projects that inherit from this one.
-
configuration
private java.lang.Object configuration
The configuration of the reporting plugin.
-
reportSets
private java.util.List<ReportSet> reportSets
Field reportSets.
-
reportSetMap
private java.util.Map reportSetMap
-
inheritanceApplied
private boolean inheritanceApplied
-
-
Method Detail
-
addReportSet
public void addReportSet(ReportSet reportSet)
Method addReportSet.- Parameters:
reportSet
-
-
getArtifactId
public java.lang.String getArtifactId()
Get the artifact ID of the reporting plugin in the repository.- Returns:
- String
-
getConfiguration
public java.lang.Object getConfiguration()
Get the configuration of the reporting plugin.- Returns:
- Object
-
getGroupId
public java.lang.String getGroupId()
Get the group ID of the reporting plugin in the repository.- Returns:
- String
-
getInherited
public java.lang.String getInherited()
Get whether the configuration in this plugin should be made available to projects that inherit from this one.- 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
-
-
setConfiguration
public void setConfiguration(java.lang.Object configuration)
Set the configuration of the reporting plugin.- Parameters:
configuration
-
-
setGroupId
public void setGroupId(java.lang.String groupId)
Set the group ID of the reporting plugin in the repository.- Parameters:
groupId
-
-
setInherited
public void setInherited(java.lang.String inherited)
Set whether the configuration in this plugin should be made available to projects that inherit from this one.- Parameters:
inherited
-
-
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 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
-artifactId
-- Returns:
- the key of the report plugin, ie
groupId:artifactId
-
unsetInheritanceApplied
public void unsetInheritanceApplied()
-
isInheritanceApplied
public boolean isInheritanceApplied()
-
equals
public boolean equals(java.lang.Object other)
- Overrides:
equals
in classjava.lang.Object
- See Also:
Object.equals(java.lang.Object)
-
hashCode
public int hashCode()
- Overrides:
hashCode
in classjava.lang.Object
- See Also:
Object.hashCode()
-
toString
public java.lang.String toString()
- Overrides:
toString
in classjava.lang.Object
- See Also:
Object.toString()
-
-