Package jenkins.tasks

Class SimpleBuildWrapper.Context

java.lang.Object

jenkins.tasks.SimpleBuildWrapper.Context

Enclosing class:

SimpleBuildWrapper

public static final class SimpleBuildWrapper.Context
extends Object

Parameter passed to SimpleBuildWrapper.setUp(jenkins.tasks.SimpleBuildWrapper.Context, hudson.model.Run<?, ?>, hudson.FilePath, hudson.Launcher, hudson.model.TaskListener, hudson.EnvVars) to allow an implementation to specify its behavior after the initial setup.

Constructor Summary

Constructors

Constructor	Description
Context()	Deprecated. Use SimpleBuildWrapper.createContext() instead, so that this context can tell whether or not a disposer will require a workspace context.

Method Summary

Modifier and Type	Method	Description
void	env(String key, String value)	Specify an environment variable override to apply to processes launched within the block.
SimpleBuildWrapper.Disposer	getDisposer()
Map<String,String>	getEnv()
void	setDisposer(SimpleBuildWrapper.Disposer disposer)	Specify an action to take when the block ends.

Methods inherited from class java.lang.Object

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

Constructor Details

Context

@Deprecated
public Context()

Deprecated.

Use SimpleBuildWrapper.createContext() instead, so that this context can tell whether or not a disposer will require a workspace context.

Creates a new context.

Method Details

env

public void env(String key,
 String value)

Specify an environment variable override to apply to processes launched within the block. If unspecified, environment variables will be inherited unmodified.

Parameters:

key - handles the special PATH+SOMETHING syntax as in EnvVars.override(java.lang.String, java.lang.String)

getDisposer

@CheckForNull
public SimpleBuildWrapper.Disposer getDisposer()

getEnv

@NonNull
public Map<String,String> getEnv()

setDisposer

public void setDisposer(@NonNull
 SimpleBuildWrapper.Disposer disposer)

Specify an action to take when the block ends. If not specified, nothing special happens.