org.jenkins_ci.plugins.run_condition.common

Class PrebuildSameAsPerformRunCondition

java.lang.Object

org.jenkins_ci.plugins.run_condition.RunCondition

org.jenkins_ci.plugins.run_condition.common.PrebuildSameAsPerformRunCondition

All Implemented Interfaces:

hudson.ExtensionPoint, hudson.model.Describable<RunCondition>

Direct Known Subclasses:

AlwaysRun, NeverRun

public abstract class PrebuildSameAsPerformRunCondition
extends RunCondition

Nested Class Summary

Nested classes/interfaces inherited from class org.jenkins_ci.plugins.run_condition.RunCondition

RunCondition.RunConditionDescriptor

Nested classes/interfaces inherited from interface hudson.ExtensionPoint

hudson.ExtensionPoint.LegacyInstancesAreScopedToHudson

Constructor Summary

Constructors

Constructor and Description
PrebuildSameAsPerformRunCondition()

Method Summary

Methods

Modifier and Type	Method and Description
protected abstract boolean	runBuildStep(hudson.model.AbstractBuild<?,?> build, hudson.model.BuildListener listener)
boolean	runPerform(hudson.model.AbstractBuild<?,?> build, hudson.model.BuildListener listener) Decide whether to run the perform method in the BuildStep.
boolean	runPrebuild(hudson.model.AbstractBuild<?,?> build, hudson.model.BuildListener listener) Decide whether to run the prebuild method in the BuildStep.

Methods inherited from class org.jenkins_ci.plugins.run_condition.RunCondition

all, getDescriptor

Methods inherited from class java.lang.Object

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

Constructor Detail

PrebuildSameAsPerformRunCondition

public PrebuildSameAsPerformRunCondition()

Method Detail

runPrebuild

public final boolean runPrebuild(hudson.model.AbstractBuild<?,?> build,
                  hudson.model.BuildListener listener)
                          throws Exception

Description copied from class: RunCondition

Decide whether to run the prebuild method in the BuildStep. If the condition depends, or may depend, on something that may be affected by the build itself, then it is probably safest to always return true here. (@TODO review this once the plugin has been in use for a while with a variety of conditions and BuildSteps) If the condition is not dependent on the state of the build i.e. just looks at the build timestamp, then this method should return the same as the runPerform method.

Specified by:

runPrebuild in class RunCondition

Returns:

true if the prebuild method of the BuildStep should run

Throws:

Exception

See Also:

AlwaysPrebuildRunCondition, PrebuildSameAsPerformRunCondition

runPerform

public final boolean runPerform(hudson.model.AbstractBuild<?,?> build,
                 hudson.model.BuildListener listener)
                         throws Exception

Description copied from class: RunCondition

Decide whether to run the perform method in the BuildStep.

Specified by:

runPerform in class RunCondition

Returns:

true if the perform method of the BuildStep should run

Throws:

Exception

runBuildStep

protected abstract boolean runBuildStep(hudson.model.AbstractBuild<?,?> build,
                   hudson.model.BuildListener listener)
                                 throws Exception

Throws:

Exception