Package org.jenkinsci.plugins.pipeline.modeldefinition.model

Class SkippedStageReason

java.lang.Object

org.jenkinsci.plugins.pipeline.modeldefinition.model.SkippedStageReason

All Implemented Interfaces:

Serializable

Direct Known Subclasses:

SkippedStageReason.Failure, SkippedStageReason.Restart, SkippedStageReason.Unstable, SkippedStageReason.When

public abstract class SkippedStageReason
extends Object
implements Serializable

Used to mark why a stage was skipped for internal purposes, allowing us to abstract away handling of skipped stages without needing chains of if/else or cases to get the different behaviors.

See Also:

• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	SkippedStageReason.Failure
static class	SkippedStageReason.Restart
static class	SkippedStageReason.Unstable
static class	SkippedStageReason.When

Field Summary

Fields

Modifier and Type	Field	Description
protected String	stageName

Constructor Summary

Constructors

Constructor	Description
SkippedStageReason(String stageName)

Method Summary

Modifier and Type	Method	Description
abstract SkippedStageReason	cloneWithNewStage(String newStage)
abstract String	getMessage()
String	getStageName()
abstract String	getStageStatus()
boolean	isNotExecutedNode()

Methods inherited from class java.lang.Object

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

Field Details

stageName

protected String stageName

Constructor Details

SkippedStageReason

public SkippedStageReason(@NonNull
 String stageName)

Method Details

isNotExecutedNode

public boolean isNotExecutedNode()

getMessage

@NonNull
public abstract String getMessage()

getStageStatus

@NonNull
public abstract String getStageStatus()

cloneWithNewStage

@NonNull
public abstract SkippedStageReason cloneWithNewStage(@NonNull
 String newStage)

getStageName

@NonNull
public String getStageName()