Package org.jenkins.plugins.lockableresources.queue

Class Utils

java.lang.Object

org.jenkins.plugins.lockableresources.queue.Utils

public final class Utils
extends Object

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	Utils.MatrixAssist
static final class	Utils.MatrixImpl

Method Summary

Modifier and Type	Method	Description
static boolean	containsVariable(String value)	Returns true when the given string contains at least one ${...} variable reference that will be resolved at build time.
static EnvVars	getParametersAsEnvVars(Queue.Item item)	Extract build parameters from a Queue.Item and return them as EnvVars so that ${PARAM} references in resource names, labels and numbers are expanded.
static Job<?,?>	getProject(Queue.Item item)
static Job<?,?>	getProject(Run<?,?> build)
static LockableResourcesStruct	requiredResources(Job<?,?> project)	Deprecated.
static LockableResourcesStruct	requiredResources(Job<?,?> project, EnvVars additionalEnv)	Build the required-resources structure for a project, merging any additional environment variables (e.g. build parameters) into the expansion context.

Methods inherited from class java.lang.Object

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

Method Details

getProject

@CheckForNull
public static Job<?,?> getProject(@NonNull
 Queue.Item item)

getProject

@NonNull
public static Job<?,?> getProject(@NonNull
 Run<?,?> build)

requiredResources

@Deprecated
@CheckForNull
@Restricted(org.kohsuke.accmod.restrictions.NoExternalUse.class)
public static LockableResourcesStruct requiredResources(@NonNull
 Job<?,?> project)

Deprecated.

Build the required-resources structure for a project, without additional environment variables.

See Also:

• requiredResources(Job, EnvVars)

requiredResources

@CheckForNull
@Restricted(org.kohsuke.accmod.restrictions.NoExternalUse.class)
public static LockableResourcesStruct requiredResources(@NonNull
 Job<?,?> project,
 @CheckForNull
 EnvVars additionalEnv)

Build the required-resources structure for a project, merging any additional environment variables (e.g. build parameters) into the expansion context.

Parameters:

project - the job whose RequiredResourcesProperty is read

additionalEnv - extra variables to use when expanding ${...} references; may be null

Returns:

the struct, or null if the project has no lockable-resource property

getParametersAsEnvVars

@NonNull
@Restricted(org.kohsuke.accmod.restrictions.NoExternalUse.class)
public static EnvVars getParametersAsEnvVars(@NonNull
 Queue.Item item)

Extract build parameters from a Queue.Item and return them as EnvVars so that ${PARAM} references in resource names, labels and numbers are expanded.

containsVariable

@Restricted(org.kohsuke.accmod.restrictions.NoExternalUse.class)
public static boolean containsVariable(@CheckForNull
 String value)

Returns true when the given string contains at least one ${...} variable reference that will be resolved at build time.