Package org.jenkinsci.plugins.workflow.steps

Class MissingContextVariableException

java.lang.Object

java.lang.Throwable

java.lang.Exception

org.jenkinsci.plugins.workflow.steps.MissingContextVariableException

All Implemented Interfaces:

Serializable

public class MissingContextVariableException
extends Exception

Indicates that a required context was not available.

Author:

Kohsuke Kawaguchi

See Also:

• StepContext.get(Class)
• TODO: extend from AbortException if it's not final
• Serialized Form

Constructor Summary

Constructors

Constructor	Description
MissingContextVariableException(Class<?> type)	Deprecated. use MissingContextVariableException(Class, StepDescriptor)
MissingContextVariableException(Class<?> type, StepDescriptor d)

Method Summary

Modifier and Type	Method	Description
String	getMessage()
List<StepDescriptor>	getProviders()	Returns StepDescriptors with body that can provide a context of this type, so that the error message can diagnose what steps were likely missing.
Class<?>	getType()

Methods inherited from class java.lang.Throwable

addSuppressed, fillInStackTrace, getCause, getLocalizedMessage, getStackTrace, getSuppressed, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toString

Methods inherited from class java.lang.Object

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

Constructor Details

MissingContextVariableException

@Deprecated
public MissingContextVariableException(@NonNull
 Class<?> type)

Deprecated.

use MissingContextVariableException(Class, StepDescriptor)

MissingContextVariableException

public MissingContextVariableException(@NonNull
 Class<?> type,
 @CheckForNull
 StepDescriptor d)

Method Details

getType

public Class<?> getType()

getMessage

public String getMessage()

Overrides:

getMessage in class Throwable

getProviders

@NonNull
public List<StepDescriptor> getProviders()

Returns StepDescriptors with body that can provide a context of this type, so that the error message can diagnose what steps were likely missing.

In such error diagnosing context, we don't care about StepDescriptors that just decorates/modifies the existing context, so we check required context as well to exclude them