org.apache.maven.model
Class ReportPlugin

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

All Implemented Interfaces:

Serializable, Cloneable, InputLocationTracker

public class ReportPlugin
extends Object
implements Serializable, Cloneable, InputLocationTracker

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.
ReportPlugin	clone() Method clone.
static String	constructKey(String groupId, String artifactId)
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()
InputLocation	getLocation(Object key) Gets the location of the specified field in the input source.
List<ReportSet>	getReportSets() Method getReportSets.
Map<String,ReportSet>	getReportSetsAsMap()
String	getVersion() Get the version of the reporting plugin to be used.
boolean	isInheritanceApplied()
boolean	isInherited()
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(boolean inherited)
void	setInherited(String inherited) Set whether the configuration in this plugin should be made available to projects that inherit from this one.
void	setLocation(Object key, InputLocation location) Sets the location of the specified field.
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.
void	unsetInheritanceApplied()

Methods inherited from class java.lang.Object

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 -

clone

public ReportPlugin clone()

Method clone.

Overrides:

clone in class Object

Returns:

ReportPlugin

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. Note: While the type of this field is String for technical reasons, the semantic type is actually Boolean. Default value is true.

Returns:

String

getLocation

public InputLocation getLocation(Object key)

Description copied from interface: InputLocationTracker

Gets the location of the specified field in the input source.

Specified by:

getLocation in interface InputLocationTracker

Parameters:

key -

Returns:

InputLocation

getReportSets

public List<ReportSet> getReportSets()

Method getReportSets.

Returns:

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. Note: While the type of this field is String for technical reasons, the semantic type is actually Boolean. Default value is true.

Parameters:

inherited -

setLocation

public void setLocation(Object key,
                        InputLocation location)

Description copied from interface: InputLocationTracker

Sets the location of the specified field.

Specified by:

setLocation in interface InputLocationTracker

Parameters:

key -

location -

setReportSets

public void setReportSets(List<ReportSet> 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<String,ReportSet> 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

isInherited

public boolean isInherited()

setInherited

public void setInherited(boolean inherited)

unsetInheritanceApplied

public void unsetInheritanceApplied()

isInheritanceApplied

public boolean isInheritanceApplied()