org.cloudbees.literate.api.v1

Class ProjectModel

java.lang.Object

org.cloudbees.literate.api.v1.ProjectModel

All Implemented Interfaces:

Serializable

@Immutable
public class ProjectModel
extends Object
implements Serializable

Represents a literate project.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ProjectModel.Builder The builder of ProjectModel instances.

Method Summary

Methods

Modifier and Type	Method and Description
static ProjectModel.Builder	builder() Instantiates a ProjectModel.Builder for creating ProjectModel instances.
BuildCommands	getBuild() Returns the build commands.
List<String>	getBuildFor(ExecutionEnvironment environment) Gets the matching build command.
List<String>	getBuildFor(String... labels) Helper version of getBuildFor(ExecutionEnvironment).
List<ExecutionEnvironment>	getEnvironments() Returns the (possibly empty) list of build environments.
TaskCommands	getTask(String taskId) Returns the task command for the specified task id.
Set<String>	getTaskIds() Returns the task ids of all the tasks defined in the model.

Methods inherited from class java.lang.Object

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

Method Detail

builder

@NonNull
public static ProjectModel.Builder builder()

Instantiates a ProjectModel.Builder for creating ProjectModel instances.

Returns:

a new ProjectModel.Builder for creating ProjectModel instances.

getBuildFor

@CheckForNull
public List<String> getBuildFor(String... labels)

Helper version of getBuildFor(ExecutionEnvironment).

Parameters:

labels - the labels.

Returns:

the build command or null if no build command matches the supplied labels.

getBuildFor

@CheckForNull
public List<String> getBuildFor(@CheckForNull
                                    ExecutionEnvironment environment)

Gets the matching build command.

Parameters:

environment - the environment.

Returns:

the build command or null if no build command matches the supplied environment.

getBuild

@NonNull
public BuildCommands getBuild()

Returns the build commands.

Returns:

the build commands.

getTaskIds

@NonNull
public Set<String> getTaskIds()

Returns the task ids of all the tasks defined in the model.

Returns:

the task ids of all the tasks defined in the model.

getTask

@CheckForNull
public TaskCommands getTask(@CheckForNull
                                String taskId)

Returns the task command for the specified task id.

Parameters:

taskId - the task id.

Returns:

the task command or null.

getEnvironments

@NonNull
public List<ExecutionEnvironment> getEnvironments()

Returns the (possibly empty) list of build environments.

Returns:

the (possibly empty) list of build environments.