Package org.apache.maven.model
Class ReportPlugin
java.lang.Object
org.apache.maven.model.ReportPlugin
- All Implemented Interfaces:
Serializable
The
<plugin>
element contains
informations required for a report plugin.- Version:
- $Revision$ $Date$
- See Also:
-
Field Summary
FieldsModifier and TypeFieldDescriptionprivate String
The artifact ID of the reporting plugin in the repository.private Object
The configuration of the reporting plugin.private String
The group ID of the reporting plugin in the repository.private boolean
private String
Whether the configuration in this plugin should be made available to projects that inherit from this one.private Map
Field reportSets.private String
The version of the reporting plugin to be used. -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionvoid
addReportSet
(ReportSet reportSet) Method addReportSet.static String
constructKey
(String groupId, String artifactId) boolean
void
Reset thereportSetMap
field tonull
Get the artifact ID of the reporting plugin in the repository.Get the configuration of the reporting plugin.Get the group ID of the reporting plugin in the repository.Get whether the configuration in this plugin should be made available to projects that inherit from this one.getKey()
Method getReportSets.Get the version of the reporting plugin to be used.int
hashCode()
boolean
void
removeReportSet
(ReportSet reportSet) Method removeReportSet.void
setArtifactId
(String artifactId) Set the artifact ID of the reporting plugin in the repository.void
setConfiguration
(Object configuration) Set the configuration of the reporting plugin.void
setGroupId
(String groupId) Set the group ID of the reporting plugin in the repository.void
setInherited
(String inherited) Set whether the configuration in this plugin should be made available to projects that inherit from this one.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.toString()
void
-
Field Details
-
groupId
The group ID of the reporting plugin in the repository. -
artifactId
The artifact ID of the reporting plugin in the repository. -
version
The version of the reporting plugin to be used. -
inherited
Whether the configuration in this plugin should be made available to projects that inherit from this one. -
configuration
The configuration of the reporting plugin. -
reportSets
Field reportSets. -
reportSetMap
-
inheritanceApplied
private boolean inheritanceApplied
-
-
Constructor Details
-
ReportPlugin
public ReportPlugin()
-
-
Method Details
-
addReportSet
Method addReportSet.- Parameters:
reportSet
-
-
getArtifactId
Get the artifact ID of the reporting plugin in the repository.- Returns:
- String
-
getConfiguration
Get the configuration of the reporting plugin.- Returns:
- Object
-
getGroupId
Get the group ID of the reporting plugin in the repository.- Returns:
- String
-
getInherited
Get whether the configuration in this plugin should be made available to projects that inherit from this one.- Returns:
- String
-
getReportSets
Method getReportSets.- Returns:
- List
-
getVersion
Get the version of the reporting plugin to be used.- Returns:
- String
-
removeReportSet
Method removeReportSet.- Parameters:
reportSet
-
-
setArtifactId
Set the artifact ID of the reporting plugin in the repository.- Parameters:
artifactId
-
-
setConfiguration
Set the configuration of the reporting plugin.- Parameters:
configuration
-
-
setGroupId
Set the group ID of the reporting plugin in the repository.- Parameters:
groupId
-
-
setInherited
Set whether the configuration in this plugin should be made available to projects that inherit from this one.- Parameters:
inherited
-
-
setReportSets
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
Set the version of the reporting plugin to be used.- Parameters:
version
-
-
flushReportSetMap
public void flushReportSetMap()Reset thereportSetMap
field tonull
-
getReportSetsAsMap
- Returns:
- a Map of reportSets field with
ReportSet#getId()
as key - See Also:
-
getKey
- Returns:
- the key of the report plugin, ie
groupId:artifactId
-
constructKey
- Parameters:
groupId
-artifactId
-- Returns:
- the key of the report plugin, ie
groupId:artifactId
-
unsetInheritanceApplied
public void unsetInheritanceApplied() -
isInheritanceApplied
public boolean isInheritanceApplied() -
equals
-
hashCode
public int hashCode() -
toString
-