CloverReportMojo (Maven Clover Plugin 2.3.3-ATL1 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

com.atlassian.maven.plugin.clover
Class CloverReportMojo

java.lang.Object
  org.apache.maven.plugin.AbstractMojo
      org.apache.maven.reporting.AbstractMavenReport
          com.atlassian.maven.plugin.clover.CloverReportMojo

All Implemented Interfaces:: org.apache.maven.plugin.ContextEnabled, org.apache.maven.plugin.Mojo, org.apache.maven.reporting.MavenReport

public class CloverReportMojo
extends org.apache.maven.reporting.AbstractMavenReport
extends org.apache.maven.reporting.AbstractMavenReport

Generate a Clover report from existing Clover databases. The generated report is an external report generated by Clover itself. If the project generating the report is a top level project and if the aggregate configuration element is set to true then an aggregated report will also be created.

Note: This report mojo should be an @aggregator and the clover:aggregate mojo shouldn't exist. This is a limitation of the site plugin which doesn't support @aggregator reports...

Version:: $Id: CloverReportMojo.java 555822 2007-07-13 00:03:28Z vsiveton $

Field Summary
`protected org.apache.maven.artifact.factory.ArtifactFactory`	`artifactFactory` The component used for creating artifact instances.
`protected org.apache.maven.artifact.resolver.ArtifactResolver`	`artifactResolver` The component that is used to resolve additional artifacts required.
`protected org.apache.maven.artifact.repository.ArtifactRepository`	`localRepository` The local repository.
`protected java.util.List`	`repositories` Remote repositories used for the project.

Fields inherited from interface org.apache.maven.reporting.MavenReport
`CATEGORY_PROJECT_INFORMATION, CATEGORY_PROJECT_REPORTS, ROLE`

Fields inherited from interface org.apache.maven.plugin.Mojo
`ROLE`

Constructor Summary
`CloverReportMojo()`

Method Summary
`boolean`	`canGenerateReport()` Generate reports if a Clover module database or a Clover merged database exist.
`void`	`executeReport(java.util.Locale locale)`
`java.lang.String`	`getDescription(java.util.Locale locale)`
`java.lang.String`	`getName(java.util.Locale locale)`
`protected java.lang.String`	`getOutputDirectory()`
`java.lang.String`	`getOutputName()`
`protected org.apache.maven.project.MavenProject`	`getProject()`
`protected org.apache.maven.doxia.siterenderer.Renderer`	`getSiteRenderer()`
`boolean`	`isExternalReport()` Always return true as we're using the report generated by Clover rather than creating our own report.
`protected java.io.File`	`resolveCloverDescriptor()` The logic here is taken from AbstractSiteRenderingMojo#resolveSiteDescriptor in the maven-site-plugin.
`void`	`setReportOutputDirectory(java.io.File reportOutputDirectory)`

Methods inherited from class org.apache.maven.reporting.AbstractMavenReport
`closeReport, execute, generate, getCategoryName, getReportOutputDirectory, getSink`

Methods inherited from class org.apache.maven.plugin.AbstractMojo
`getLog, getPluginContext, setLog, setPluginContext`

Methods inherited from class java.lang.Object
`clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait`

Field Detail

artifactResolver

protected org.apache.maven.artifact.resolver.ArtifactResolver artifactResolver

The component that is used to resolve additional artifacts required.

repositories

protected java.util.List repositories

Remote repositories used for the project.

artifactFactory

protected org.apache.maven.artifact.factory.ArtifactFactory artifactFactory

The component used for creating artifact instances.

localRepository

protected org.apache.maven.artifact.repository.ArtifactRepository localRepository

The local repository.

Constructor Detail