hudson.plugins.checkstyle
Class CheckStyleResultAction

java.lang.Object
  hudson.plugins.checkstyle.util.AbstractResultAction<CheckStyleResult>
      hudson.plugins.checkstyle.CheckStyleResultAction

All Implemented Interfaces:

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

Direct Known Subclasses:

MavenCheckStyleResultAction

public class CheckStyleResultAction
extends AbstractResultAction<CheckStyleResult>

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

Moreover, this class renders the Checkstyle result trend.

Author:

Ulli Hafner

Constructor Summary

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

CheckStyleResultAction(hudson.model.AbstractBuild<?,?> owner, HealthDescriptor healthDescriptor, CheckStyleResult result)
Creates a new instance of CheckStyleResultAction.

Method Summary

protected PluginDescriptor	getDescriptor() Returns the descriptor of the associated plug-in.
java.lang.String	getDisplayName()
java.lang.String	getMultipleItemsTooltip(int numberOfItems) Returns the tooltip for several items.
CheckStyleResultAction	getPreviousResultAction() Gets the Checkstyle result of the previous build.
java.lang.String	getSingleItemTooltip() Returns the tooltip for exactly one item.

Methods inherited from class hudson.plugins.checkstyle.util.AbstractResultAction

addModule, buildDataSet, createAggregatedResult, createResult, doGraph, doGraphMap, getBuildHealth, getHealthDescriptor, getHealthReportBuilder, getIconFileName, getOwner, getPreviousBuild, getResult, getTarget, getUrlName, hasPreviousResultAction, setResult, updateBuildHealth

Methods inherited from class java.lang.Object

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

Constructor Detail

CheckStyleResultAction

public CheckStyleResultAction(hudson.model.AbstractBuild<?,?> owner,
                              HealthDescriptor healthDescriptor,
                              CheckStyleResult result)

Creates a new instance of CheckStyleResultAction.

Parameters:

owner - the associated build of this action

healthDescriptor - health descriptor

result - the result in this build

CheckStyleResultAction

public CheckStyleResultAction(hudson.model.AbstractBuild<?,?> owner,
                              HealthDescriptor healthDescriptor)

Creates a new instance of CheckStyleResultAction.

Parameters:

owner - the associated build of this action

healthDescriptor - health descriptor

Method Detail

getDisplayName

public java.lang.String getDisplayName()

getDescriptor

protected PluginDescriptor getDescriptor()

Returns the descriptor of the associated plug-in.

Specified by:

getDescriptor in class AbstractResultAction<CheckStyleResult>

Returns:

the descriptor of the associated plug-in

getPreviousResultAction

public CheckStyleResultAction getPreviousResultAction()

Gets the Checkstyle result of the previous build.

Returns:

the Checkstyle result of the previous build.

Throws:

java.util.NoSuchElementException - if there is no previous build for this action

getMultipleItemsTooltip

public java.lang.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

public java.lang.String getSingleItemTooltip()

Returns the tooltip for exactly one item.

Returns:

the tooltip for exactly one item