org.apache.maven.model
Class ReportPlugin

java.lang.Object
  org.apache.maven.model.ReportPlugin

All Implemented Interfaces:

Serializable

public class ReportPlugin

extends Object

implements Serializable

null

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)
void	flushReportSetMap()
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.
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)
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.
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 String getArtifactId()

Get The artifact ID of the reporting plugin in the repository

getConfiguration

public Object getConfiguration()

Get The configuration of the reporting plugin.

getGroupId

public String getGroupId()

Get The group ID of the reporting plugin in the repository.

getInherited

public String getInherited()

Get Whether the configuration in this plugin should be made available to projects that inherit from this one.

getReportSets

public List getReportSets()

Method getReportSets

getVersion

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

getReportSetsAsMap

public Map getReportSetsAsMap()

getKey

public String getKey()

constructKey

public static String constructKey(String groupId,
                                  String artifactId)

unsetInheritanceApplied

public void unsetInheritanceApplied()

isInheritanceApplied

public boolean isInheritanceApplied()

setModelEncoding

public void setModelEncoding(String modelEncoding)

getModelEncoding

public String getModelEncoding()