Package hudson.maven

Interface MavenAggregatedReport

All Superinterfaces:

Action, ModelObject

All Known Implementing Classes:

MavenAggregatedArtifactRecord, SurefireAggregatedReport

public interface MavenAggregatedReport
extends Action

Action to be associated with MavenModuleSetBuild, which usually displays some aspect of the aggregated results of the module builds (such as aggregated test result, aggregated coverage report, etc.)

When a module build is completed, its governing MavenModuleSetBuild tries to create an instane of MavenAggregatedReport from each kind of MavenReporterDescriptor whose MavenReporters are used on module builds.

The obtained instance is then persisted with MavenModuleSetBuild.

Since:

1.99

Author:

Kohsuke Kawaguchi

See Also:

• AggregatableAction

Method Summary

Modifier and Type	Method	Description
Class<? extends AggregatableAction>	getIndividualActionType()	Returns the implementation class of AggregatableAction that produces this MavenAggregatedReport.
Action	getProjectAction(MavenModuleSet moduleSet)	Equivalent of BuildStep.getProjectAction(AbstractProject) for MavenAggregatedReport.
void	update(Map<MavenModule,List<MavenBuild>> moduleBuilds, MavenBuild newBuild)	Called whenever a new module build is completed, to update the aggregated report.

Methods inherited from interface hudson.model.Action

getDisplayName, getIconFileName, getUrlName

Method Details

update

void update(Map<MavenModule,List<MavenBuild>> moduleBuilds,
 MavenBuild newBuild)

Called whenever a new module build is completed, to update the aggregated report. When multiple builds complete simultaneously, Hudson serializes the execution of this method, so this method needs not be concurrency-safe.

Parameters:

moduleBuilds - Same as MavenModuleSetBuild.getModuleBuilds() but provided for convenience and efficiency.

newBuild - Newly completed build.

getIndividualActionType

Class<? extends AggregatableAction> getIndividualActionType()

Returns the implementation class of AggregatableAction that produces this MavenAggregatedReport. Hudson uses this method to determine which AggregatableAction is aggregated to which MavenAggregatedReport.

getProjectAction

Action getProjectAction(MavenModuleSet moduleSet)

Equivalent of BuildStep.getProjectAction(AbstractProject) for MavenAggregatedReport.