org.cloudbees.literate.api.v1

Class ExecutionEnvironment

java.lang.Object

org.cloudbees.literate.api.v1.ExecutionEnvironment

All Implemented Interfaces:

Serializable

@Immutable
public class ExecutionEnvironment
extends Object
implements Serializable

Represents an environment for execution of a series of commands.

Author:

Stephen Connolly

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
ExecutionEnvironment() Default constructor of an empty environment.
ExecutionEnvironment(Collection<String> labels) Constructor.
ExecutionEnvironment(ExecutionEnvironment base, Collection<String> additionalLabels) Constructor.
ExecutionEnvironment(ExecutionEnvironment base, String... additionalLabels) Constructor.
ExecutionEnvironment(String... labels) Constructor.

Method Summary

Methods

Modifier and Type	Method and Description
static ExecutionEnvironment	any() Returns an environment without labels, that is it will match all other environments.
boolean	equals(Object o)
Set<String>	getLabels() Returns the labels that define the environment.
int	hashCode()
boolean	isMatchFor(ExecutionEnvironment environment) Tests if this environment satisfies the requirements of the specified environment.
boolean	isUnspecified() Returns true if the environment does not specify any labels.
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

ExecutionEnvironment

public ExecutionEnvironment()

Default constructor of an empty environment.

ExecutionEnvironment

public ExecutionEnvironment(@CheckForNull
                    Collection<String> labels)

Constructor.

Parameters:

labels - collection of labels that define the environment.

ExecutionEnvironment

public ExecutionEnvironment(String... labels)

Constructor.

Parameters:

labels - the labels that define the environment.

ExecutionEnvironment

public ExecutionEnvironment(@CheckForNull
                    ExecutionEnvironment base,
                    @CheckForNull
                    Collection<String> additionalLabels)

Constructor.

Parameters:

base - a base ExecutionEnvironment to be extended by the additional labels

additionalLabels - collection of labels that define the environment.

ExecutionEnvironment

public ExecutionEnvironment(@CheckForNull
                    ExecutionEnvironment base,
                    String... additionalLabels)

Constructor.

Parameters:

base - a base ExecutionEnvironment to be extended by the additional labels

additionalLabels - collection of labels that define the environment.

Method Detail

getLabels

@NonNull
public Set<String> getLabels()

Returns the labels that define the environment.

Returns:

the labels that define the environment.

isUnspecified

public boolean isUnspecified()

Returns true if the environment does not specify any labels.

Returns:

true if the environment does not specify any labels.

isMatchFor

public boolean isMatchFor(ExecutionEnvironment environment)

Tests if this environment satisfies the requirements of the specified environment.

Parameters:

environment - the specified environment.

Returns:

true if and only if all the labels required by the specified environment are provided by this environment.

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object

any

public static ExecutionEnvironment any()

Returns an environment without labels, that is it will match all other environments.

Returns:

an environment without labels.