org.apache.maven.model
Class ReportPlugin

java.lang.Object
  extended by org.apache.maven.model.ReportPlugin
All Implemented Interfaces:
Serializable

public class ReportPlugin
extends Object
implements 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 String constructKey(String groupId, String artifactId)
           
 boolean equals(Object other)
           
 void flushReportSetMap()
          Reset the reportSetMap field to null
 String getArtifactId()
          Get the artifact ID of the reporting plugin in the repository.
 Object getConfiguration()
          Get the configuration of the reporting plugin.
 String getGroupId()
          Get the group ID of the reporting plugin in the repository.
 String getInherited()
          Get whether the configuration in this plugin should be made available to projects that inherit from this one.
 String getKey()
           
 String getModelEncoding()
           
 List getReportSets()
          Method getReportSets.
 Map getReportSetsAsMap()
           
 String getVersion()
          Get the version of the reporting plugin to be used.
 int hashCode()
           
 boolean isInheritanceApplied()
           
 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 setModelEncoding(String modelEncoding)
          Set an encoding used for reading/writing the model.
 void setReportSets(List 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.
 String toString()
           
 void unsetInheritanceApplied()
           
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
 

Constructor Detail

ReportPlugin

public ReportPlugin()
Method Detail

addReportSet

public void addReportSet(ReportSet reportSet)
Method addReportSet.

Parameters:
reportSet -

getArtifactId

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

Returns:
String

getConfiguration

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

Returns:
Object

getGroupId

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

Returns:
String

getInherited

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

Returns:
String

getReportSets

public List getReportSets()
Method getReportSets.

Returns:
java.util.List

getVersion

public 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(String artifactId)
Set the artifact ID of the reporting plugin in the repository.

Parameters:
artifactId -

setConfiguration

public void setConfiguration(Object configuration)
Set the configuration of the reporting plugin.

Parameters:
configuration -

setGroupId

public void setGroupId(String groupId)
Set the group ID of the reporting plugin in the repository.

Parameters:
groupId -

setInherited

public void setInherited(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(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(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 Map 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

constructKey

public static String constructKey(String groupId,
                                  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(Object other)
Overrides:
equals in class Object
See Also:
Object.equals(java.lang.Object)

hashCode

public int hashCode()
Overrides:
hashCode in class Object
See Also:
Object.hashCode()

toString

public String toString()
Overrides:
toString in class Object
See Also:
Object.toString()

setModelEncoding

public void setModelEncoding(String modelEncoding)
Set an encoding used for reading/writing the model.

Parameters:
modelEncoding - the encoding used when reading/writing the model.

getModelEncoding

public String getModelEncoding()
Returns:
the current encoding used when reading/writing this model.


Copyright © 2001-2010 The Apache Software Foundation. All Rights Reserved.