hudson.plugins.analysis.core
Class AbstractResultAction<T extends BuildResult>

java.lang.Object
  hudson.plugins.analysis.core.AbstractResultAction<T>

Type Parameters:

T - type of the result of this action

All Implemented Interfaces:

hudson.model.Action, hudson.model.HealthReportingAction, hudson.model.ModelObject, ResultAction<T>, ToolTipProvider, org.kohsuke.stapler.StaplerProxy

public abstract class AbstractResultAction<T extends BuildResult>
extends Object
implements org.kohsuke.stapler.StaplerProxy, hudson.model.HealthReportingAction, ToolTipProvider, ResultAction<T>

Controls the live cycle of the results in a job. This action persists the results of a build and displays them on the build page. The actual visualization of the results is defined in the matching summary.jelly file.

Moreover, this class renders the results trend.

Author:

Ulli Hafner

Constructor Summary

AbstractResultAction(hudson.model.AbstractBuild<?,?> owner, AbstractHealthDescriptor healthDescriptor)
Creates a new instance of AbstractResultAction.

AbstractResultAction(hudson.model.AbstractBuild<?,?> owner, AbstractHealthDescriptor healthDescriptor, T result)
Creates a new instance of AbstractResultAction.

Method Summary

protected void	addModule(ParserResult aggregatedResult, List<hudson.maven.MavenBuild> builds) Deprecated. replaced by MavenResultAction
protected ParserResult	createAggregatedResult(Map<hudson.maven.MavenModule,List<hudson.maven.MavenBuild>> moduleBuilds) Deprecated. replaced by MavenResultAction
protected ParserResult	createResult() Factory method to create the result of this action.
hudson.model.AbstractBuild<?,?>	getBuild() Returns the associated build of this action.
hudson.model.HealthReport	getBuildHealth()
protected abstract PluginDescriptor	getDescriptor() Returns the descriptor of the associated plug-in.
AbstractHealthDescriptor	getHealthDescriptor() Returns the healthDescriptor.
String	getIconFileName()
String	getLargeImageName() Returns the URL of the 48x48 image used in the build summary.
protected String	getMultipleItemsTooltip(int numberOfItems) Returns the tooltip for several items.
hudson.model.AbstractBuild<?,?>	getOwner() Returns the associated build of this action.
T	getResult() Returns the current result of this action.
protected String	getSingleItemTooltip() Returns the tooltip for exactly one item.
protected String	getSmallImage() Returns the URL of the 24x24 image used in the build link.
String	getSmallImageName() Returns the URL of the 24x24 image used in the build link.
Object	getTarget()
String	getTooltip(int numberOfItems) Returns the tooltip for the specified number of items.
ToolTipProvider	getToolTipProvider() Returns the associated tool tip provider.
String	getUrlName()
boolean	hasLargeImage() Returns whether a large image is defined.
boolean	isSuccessful() Returns whether this build is successful with respect to the HealthDescriptor of this action.
void	setResult(T result) Sets the result for this build.
protected void	updateBuildHealth(hudson.maven.MavenBuild build, BuildResult buildResult) Deprecated. replaced by MavenResultAction

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface hudson.model.Action

getDisplayName

Constructor Detail

AbstractResultAction

public AbstractResultAction(hudson.model.AbstractBuild<?,?> owner,
                            AbstractHealthDescriptor healthDescriptor,
                            T result)

Creates a new instance of AbstractResultAction.

Parameters:

owner - the associated build of this action

healthDescriptor - health descriptor

result - the result of the action

AbstractResultAction

public AbstractResultAction(hudson.model.AbstractBuild<?,?> owner,
                            AbstractHealthDescriptor healthDescriptor)

Creates a new instance of AbstractResultAction.

Parameters:

owner - the associated build of this action

healthDescriptor - health descriptor

Method Detail

getHealthDescriptor

public AbstractHealthDescriptor getHealthDescriptor()

Returns the healthDescriptor.

Specified by:

getHealthDescriptor in interface ResultAction<T extends BuildResult>

Returns:

the healthDescriptor

getDescriptor

protected abstract PluginDescriptor getDescriptor()

Returns the descriptor of the associated plug-in.

Returns:

the descriptor of the associated plug-in

getUrlName

public String getUrlName()

Specified by:

getUrlName in interface hudson.model.Action

getBuildHealth

public final hudson.model.HealthReport getBuildHealth()

Specified by:

getBuildHealth in interface hudson.model.HealthReportingAction

getToolTipProvider

public ToolTipProvider getToolTipProvider()

Returns the associated tool tip provider.

Specified by:

getToolTipProvider in interface ResultAction<T extends BuildResult>

Returns:

the tool tip provider

getOwner

public final hudson.model.AbstractBuild<?,?> getOwner()

Returns the associated build of this action.

Returns:

the associated build of this action

getBuild

public final hudson.model.AbstractBuild<?,?> getBuild()

Returns the associated build of this action.

Specified by:

getBuild in interface ResultAction<T extends BuildResult>

Returns:

the associated build of this action

getTarget

public final Object getTarget()

Specified by:

getTarget in interface org.kohsuke.stapler.StaplerProxy

getResult

public final T getResult()

Returns the current result of this action.

Specified by:

getResult in interface ResultAction<T extends BuildResult>

Returns:

the current result

setResult

public final void setResult(T result)

Sets the result for this build.

Specified by:

setResult in interface ResultAction<T extends BuildResult>

Parameters:

result - the result to set

getIconFileName

public String getIconFileName()

Specified by:

getIconFileName in interface hudson.model.Action

hasLargeImage

public boolean hasLargeImage()

Returns whether a large image is defined.

Returns:

true if a large image is defined, false otherwise. If no large image is defined, then the attribute icon must to be provided in jelly tag summary.

Since:

1.41

getLargeImageName

public String getLargeImageName()

Returns the URL of the 48x48 image used in the build summary.

Returns:

the URL of the image

Since:

1.41

getSmallImageName

public String getSmallImageName()

Returns the URL of the 24x24 image used in the build link.

Returns:

the URL of the image

Since:

1.41

getSmallImage

protected String getSmallImage()

Returns the URL of the 24x24 image used in the build link.

Returns:

the URL of the image

createResult

protected ParserResult createResult()

Factory method to create the result of this action.

Returns:

the result of this action

getTooltip

public String getTooltip(int numberOfItems)

Returns the tooltip for the specified number of items.

Specified by:

getTooltip in interface ToolTipProvider

Parameters:

numberOfItems - the number of items to display the tooltip for

Returns:

the tooltip for the specified items

getMultipleItemsTooltip

protected String getMultipleItemsTooltip(int numberOfItems)

Returns the tooltip for several items.

Parameters:

numberOfItems - the number of items to display the tooltip for

Returns:

the tooltip for several items

getSingleItemTooltip

protected String getSingleItemTooltip()

Returns the tooltip for exactly one item.

Returns:

the tooltip for exactly one item

isSuccessful

public boolean isSuccessful()

Returns whether this build is successful with respect to the HealthDescriptor of this action.

Specified by:

isSuccessful in interface ResultAction<T extends BuildResult>

Returns:

true if the build is successful, false if the build has been set to Result.UNSTABLE or Result.FAILURE by this action.

createAggregatedResult

@Deprecated
protected ParserResult createAggregatedResult(Map<hudson.maven.MavenModule,List<hudson.maven.MavenBuild>> moduleBuilds)

Deprecated. replaced by MavenResultAction

Aggregates the results of the specified maven module builds.

Parameters:

moduleBuilds - the module builds to aggregate

Returns:

the aggregated result

updateBuildHealth

@Deprecated
protected void updateBuildHealth(hudson.maven.MavenBuild build,
                                            BuildResult buildResult)

Deprecated. replaced by MavenResultAction

Updates the build status if the number of annotations exceeds one of the thresholds.

Parameters:

build - the build to change the status from

buildResult - the build result

addModule

@Deprecated
protected void addModule(ParserResult aggregatedResult,
                                    List<hudson.maven.MavenBuild> builds)

Deprecated. replaced by MavenResultAction

Adds a new module to the specified project. The new module is obtained from the specified list of builds.

Parameters:

aggregatedResult - the result to add the module to

builds - the builds for a module