Package org.jenkinsci.plugins.workflow.steps

Class WarnErrorStep

java.lang.Object

hudson.model.AbstractDescribableImpl<org.jenkinsci.plugins.workflow.steps.Step>

org.jenkinsci.plugins.workflow.steps.Step

org.jenkinsci.plugins.workflow.steps.WarnErrorStep

All Implemented Interfaces:

ExtensionPoint, Describable<org.jenkinsci.plugins.workflow.steps.Step>, Serializable, CatchExecutionOptions

public class WarnErrorStep
extends org.jenkinsci.plugins.workflow.steps.Step
implements CatchExecutionOptions

Runs a block, and if that block fails, prints a message, marks the build as Result.UNSTABLE, adds a WarningAction to the step, and then continues execution normally.

See Also:

• CatchErrorStep
• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	WarnErrorStep.DescriptorImpl

Nested classes/interfaces inherited from interface hudson.ExtensionPoint

ExtensionPoint.LegacyInstancesAreScopedToHudson

Constructor Summary

Constructors

Constructor	Description
WarnErrorStep(String message)

Method Summary

Modifier and Type	Method	Description
Result	getBuildResultOnError()	The result that will be used for setting the build result if an error is caught.
String	getMessage()	A message to be printed when an error is caught.
Result	getStepResultOnError()	The result that will be used for annotating the with WarningAction) if an error is caught.
boolean	isCatchInterruptions()	Whether FlowInterruptedException should be caught and handled by the step or rethrown.
void	setCatchInterruptions(boolean catchInterruptions)
org.jenkinsci.plugins.workflow.steps.StepExecution	start(org.jenkinsci.plugins.workflow.steps.StepContext context)

Methods inherited from class org.jenkinsci.plugins.workflow.steps.Step

getDescriptor

Methods inherited from class java.lang.Object

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

Constructor Details

WarnErrorStep

@DataBoundConstructor
public WarnErrorStep(String message)

Method Details

getMessage

public String getMessage()

Description copied from interface: CatchExecutionOptions

A message to be printed when an error is caught. If CatchExecutionOptions.getStepResultOnError() (by adding a WarningAction)

Specified by:

getMessage in interface CatchExecutionOptions

getBuildResultOnError

@NonNull
public Result getBuildResultOnError()

Description copied from interface: CatchExecutionOptions

The result that will be used for setting the build result if an error is caught. Return Result.SUCCESS to leave the build result unchanged. If CatchExecutionOptions.isCatchInterruptions() returns true, then if a FlowInterruptedException is caught, its result will be used instead of this value.

Specified by:

getBuildResultOnError in interface CatchExecutionOptions

getStepResultOnError

@NonNull
public Result getStepResultOnError()

Description copied from interface: CatchExecutionOptions

The result that will be used for annotating the with WarningAction) if an error is caught. Return Result.SUCCESS to leave the step result unchanged. If CatchExecutionOptions.isCatchInterruptions() returns true, then if a FlowInterruptedException is caught, its result will be used instead of this value.

Specified by:

getStepResultOnError in interface CatchExecutionOptions

isCatchInterruptions

public boolean isCatchInterruptions()

Description copied from interface: CatchExecutionOptions

Whether FlowInterruptedException should be caught and handled by the step or rethrown. FlowInterruptedException is commonly used to control the flow of execution for things like builds aborted by a user and builds that time out inside of TimeoutStep. It is sometimes desirable to rethrow these kinds of exceptions rather than catching them so as to not interfere with their intended behavior.

Specified by:

isCatchInterruptions in interface CatchExecutionOptions

setCatchInterruptions

@DataBoundSetter
public void setCatchInterruptions(boolean catchInterruptions)

start

public org.jenkinsci.plugins.workflow.steps.StepExecution start(org.jenkinsci.plugins.workflow.steps.StepContext context)
                                                         throws Exception

Specified by:

start in class org.jenkinsci.plugins.workflow.steps.Step

Throws:

Exception