org.apache.maven.model
Class ReportPlugin

java.lang.Object
  extended by 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

Constructor Summary
ReportPlugin()
           
 
Method Summary
 void addReportSet(ReportSet reportSet)
          Method addReportSet
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.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.lang.String getModelEncoding()
           
 java.util.List getReportSets()
          Method getReportSets
 java.util.Map getReportSetsAsMap()
           
 java.lang.String getVersion()
          Get The version of the reporting plugin to be used.
 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 setModelEncoding(java.lang.String modelEncoding)
           
 void setReportSets(java.util.List 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.
 void unsetInheritanceApplied()
           
 
Methods inherited from class java.lang.Object
clone, 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 -

getArtifactId

public java.lang.String getArtifactId()
Get The artifact ID of the reporting plugin in the repository.


getConfiguration

public java.lang.Object getConfiguration()
Get The configuration of the reporting plugin.


getGroupId

public java.lang.String getGroupId()
Get The group ID of the reporting plugin in the repository.


getInherited

public java.lang.String getInherited()
Get Whether the configuration in this plugin should be made available to projects that inherit from this one.


getReportSets

public java.util.List getReportSets()
Method getReportSets


getVersion

public java.lang.String getVersion()
Get The version of the reporting plugin to be used.


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 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 -

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 the reportSetMap field to null


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()

setModelEncoding

public void setModelEncoding(java.lang.String modelEncoding)

getModelEncoding

public java.lang.String getModelEncoding()


Copyright © 2001-2008 Apache Software Foundation. All Rights Reserved.