ReportPlugin (Maven Model 3.1.0 API)

Overview

Package

Class

Use

Tree

Deprecated

Index

Help

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

org.apache.maven.model
Class ReportPlugin

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

All Implemented Interfaces:: Serializable, Cloneable, InputLocationTracker

public class ReportPlugin
extends ConfigurationContainer
implements Serializable, Cloneable
extends ConfigurationContainer
implements Serializable, Cloneable

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.
`String`	`getGroupId()` Get the group ID of the reporting plugin in the repository.
`String`	`getKey()`
`List<ReportSet>`	`getReportSets()` Method getReportSets.
`Map<String,ReportSet>`	`getReportSetsAsMap()`
`String`	`getVersion()` Get the version of the reporting plugin to be used.
`void`	`removeReportSet(ReportSet reportSet)` Method removeReportSet.
`void`	`setArtifactId(String artifactId)` Set the artifact ID of the reporting plugin in the repository.
`void`	`setGroupId(String groupId)` Set the group ID of the reporting plugin in the repository.
`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.

Methods inherited from class org.apache.maven.model.ConfigurationContainer
`getConfiguration, getInherited, getLocation, isInheritanceApplied, isInherited, setConfiguration, setInherited, setInherited, setLocation, 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 ConfigurationContainer

Returns:: ReportPlugin

getArtifactId

public String getArtifactId()

Get the artifact ID of the reporting plugin in the repository.

Returns:: String

getGroupId

public String getGroupId()

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

Returns:: String

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 -

setGroupId

public void setGroupId(String groupId)

Set the group ID of the reporting plugin in the repository.

Parameters:: groupId -

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