Package hudson.ivy

Interface IvyAggregatedReport

All Superinterfaces:

Action, ModelObject

public interface IvyAggregatedReport
extends Action

Action to be associated with IvyModuleSetBuild, 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 IvyModuleSetBuild tries to create an instance of IvyAggregatedReport from each kind of IvyReporterDescriptor whose IvyReporters are used on module builds.

The obtained instance is then persisted with IvyModuleSetBuild.

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 IvyAggregatedReport.
Action	getProjectAction(IvyModuleSet moduleSet)	Equivalent of BuildStep.getProjectAction(AbstractProject) for IvyAggregatedReport.
void	update(Map<IvyModule,List<IvyBuild>> moduleBuilds, IvyBuild 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<IvyModule,List<IvyBuild>> moduleBuilds,
 IvyBuild newBuild)

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

Parameters:

moduleBuilds - Same as IvyModuleSet.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 IvyAggregatedReport. Jenkins uses this method to determine which AggregatableAction is aggregated to which IvyAggregatedReport.

getProjectAction

Action getProjectAction(IvyModuleSet moduleSet)

Equivalent of BuildStep.getProjectAction(AbstractProject) for IvyAggregatedReport.