Index (Literate Build API 0.6 API)

A B C E F G H I J L M O P R S T W Y

A

AbstractCommands - Class in org.cloudbees.literate.api.v1: This represents an entire section of a project definition - stuff under a heading.
AbstractCommands(Map<ExecutionEnvironment, List<String>>) - Constructor for class org.cloudbees.literate.api.v1.AbstractCommands: Deprecated.
use AbstractCommands.AbstractCommands(java.util.Map, java.util.List)
AbstractCommands(Map<ExecutionEnvironment, List<String>>, List<Parameter>) - Constructor for class org.cloudbees.literate.api.v1.AbstractCommands: Constructor.
addBuild(Map<ExecutionEnvironment, List<String>>) - Method in class org.cloudbees.literate.api.v1.ProjectModel.Builder: Adds the supplied build commands.
addBuild(String) - Method in class org.cloudbees.literate.api.v1.ProjectModel.Builder: Adds the supplied build command.
addBuild(List<String>) - Method in class org.cloudbees.literate.api.v1.ProjectModel.Builder: Adds the supplied build commands.
addBuild(Set<String>, List<String>) - Method in class org.cloudbees.literate.api.v1.ProjectModel.Builder: Adds the supplied build command.
addBuild(Set<String>, String) - Method in class org.cloudbees.literate.api.v1.ProjectModel.Builder: Adds the supplied build command.
addBuild(ExecutionEnvironment, String) - Method in class org.cloudbees.literate.api.v1.ProjectModel.Builder: Adds the supplied build command.
addBuild(ExecutionEnvironment, List<String>) - Method in class org.cloudbees.literate.api.v1.ProjectModel.Builder: Adds the supplied build command.
addBuildParameter(Parameter) - Method in class org.cloudbees.literate.api.v1.ProjectModel.Builder: Adds the supplied parameter to the parameters of the build command.
addBuildParameters(Parameter...) - Method in class org.cloudbees.literate.api.v1.ProjectModel.Builder: Adds the supplied parameters to the parameters of the build command.
addBuildParameters(Iterable<Parameter>) - Method in class org.cloudbees.literate.api.v1.ProjectModel.Builder: Adds the supplied parameters to the parameters of the build command.
addEnvironment(ExecutionEnvironment) - Method in class org.cloudbees.literate.api.v1.ProjectModel.Builder: Adds the supplied environment.
addEnvironment(String...) - Method in class org.cloudbees.literate.api.v1.ProjectModel.Builder: Adds the supplied environment.
addEnvironments(Collection<ExecutionEnvironment>) - Method in class org.cloudbees.literate.api.v1.ProjectModel.Builder: Adds the supplied environments.
addTask(String, String) - Method in class org.cloudbees.literate.api.v1.ProjectModel.Builder: Adds the supplied task command.
addTask(String, List<String>) - Method in class org.cloudbees.literate.api.v1.ProjectModel.Builder: Adds the supplied task command.
addTask(String, TaskCommands) - Method in class org.cloudbees.literate.api.v1.ProjectModel.Builder: Adds the supplied task command.
addTaskId(String) - Method in class org.cloudbees.literate.api.v1.ProjectModelRequest.Builder: Adds a task id to the request.
addTaskIds(String...) - Method in class org.cloudbees.literate.api.v1.ProjectModelRequest.Builder: Adds task ids to the request.
addTaskIds(Collection<String>) - Method in class org.cloudbees.literate.api.v1.ProjectModelRequest.Builder: Adds task ids to the request.
addTaskParameter(String, Parameter) - Method in class org.cloudbees.literate.api.v1.ProjectModel.Builder: Adds the supplied task parameter.
addTaskParameters(String, Parameter...) - Method in class org.cloudbees.literate.api.v1.ProjectModel.Builder: Adds the supplied task parameters.
addTaskParameters(String, Iterable<Parameter>) - Method in class org.cloudbees.literate.api.v1.ProjectModel.Builder: Adds the supplied task parameters.
any() - Static method in class org.cloudbees.literate.api.v1.ExecutionEnvironment: Returns an environment without labels, that is it will match all other environments.
asHeaderNode(Node) - Static method in class org.cloudbees.literate.impl.MarkdownProjectModelBuilder

B

build() - Method in class org.cloudbees.literate.api.v1.ProjectModel.Builder: Builds the ProjectModel instance.
build() - Method in class org.cloudbees.literate.api.v1.ProjectModelRequest.Builder: Builds the ProjectModelRequest.
build(ProjectModelRequest) - Method in class org.cloudbees.literate.impl.MarkdownProjectModelBuilder: Tries to build a ProjectModel from the supplied ProjectModelRequest
build(Map<String, Object>, ProjectRepository) - Method in class org.cloudbees.literate.impl.yaml.JavaLanguage
build(Map<String, Object>, ProjectRepository) - Method in interface org.cloudbees.literate.impl.yaml.Language
build(ProjectModelRequest) - Method in class org.cloudbees.literate.impl.YamlProjectModelBuilder: Tries to build a ProjectModel from the supplied ProjectModelRequest
build(ProjectModelRequest) - Method in interface org.cloudbees.literate.spi.v1.ProjectModelBuilder: Tries to build a ProjectModel from the supplied ProjectModelRequest
BuildCommands - Class in org.cloudbees.literate.api.v1: This represents build commands.
BuildCommands(List<String>) - Constructor for class org.cloudbees.literate.api.v1.BuildCommands: Constructor.
BuildCommands(ExecutionEnvironment, List<String>) - Constructor for class org.cloudbees.literate.api.v1.BuildCommands: Constructor.
BuildCommands(List<String>, List<Parameter>) - Constructor for class org.cloudbees.literate.api.v1.BuildCommands: Constructor.
BuildCommands(ExecutionEnvironment, List<String>, List<Parameter>) - Constructor for class org.cloudbees.literate.api.v1.BuildCommands: Constructor.
BuildCommands(Map<ExecutionEnvironment, List<String>>) - Constructor for class org.cloudbees.literate.api.v1.BuildCommands: Constructor.
BuildCommands(Map<ExecutionEnvironment, List<String>>, List<Parameter>) - Constructor for class org.cloudbees.literate.api.v1.BuildCommands: Constructor.
builder() - Static method in class org.cloudbees.literate.api.v1.ProjectModel: Instantiates a ProjectModel.Builder for creating ProjectModel instances.
builder(ProjectRepository) - Static method in class org.cloudbees.literate.api.v1.ProjectModelRequest: Instantiates a new ProjectModelRequest.Builder.

C

compare(ProjectModelBuilder, ProjectModelBuilder) - Method in class org.cloudbees.literate.spi.v1.ProjectModelBuilder.PriorityComparator
containsStringIgnoreCase(String) - Static method in class org.cloudbees.literate.impl.MarkdownProjectModelBuilder.StringContainsIgnoreCase: Creates a matcher that matches if the examined String contains the specified String anywhere.

E

equals(Object) - Method in class org.cloudbees.literate.api.v1.ExecutionEnvironment
equals(Object) - Method in class org.cloudbees.literate.api.v1.Parameter
evalSubstringOf(String) - Method in class org.cloudbees.literate.impl.MarkdownProjectModelBuilder.StringContainsIgnoreCase
ExecutionEnvironment - Class in org.cloudbees.literate.api.v1: Represents an environment for execution of a series of commands.
ExecutionEnvironment() - Constructor for class org.cloudbees.literate.api.v1.ExecutionEnvironment: Default constructor of an empty environment.
ExecutionEnvironment(Collection<String>) - Constructor for class org.cloudbees.literate.api.v1.ExecutionEnvironment: Constructor.
ExecutionEnvironment(String...) - Constructor for class org.cloudbees.literate.api.v1.ExecutionEnvironment: Constructor.
ExecutionEnvironment(ExecutionEnvironment, Collection<String>) - Constructor for class org.cloudbees.literate.api.v1.ExecutionEnvironment: Constructor.
ExecutionEnvironment(ExecutionEnvironment, String...) - Constructor for class org.cloudbees.literate.api.v1.ExecutionEnvironment: Constructor.

F

FilesystemRepository - Class in org.cloudbees.literate.api.v1.vfs: A ProjectRepository hosted on the local file system.
FilesystemRepository(File) - Constructor for class org.cloudbees.literate.api.v1.vfs.FilesystemRepository: Constructor.
format(ProjectModel) - Method in class org.cloudbees.literate.api.v1.ProjectModelFormatter: Formats the model as a string.
format(ProjectModel) - Method in class org.cloudbees.literate.impl.MarkdownProjectModelFormatter

G

get(String) - Method in class org.cloudbees.literate.api.v1.vfs.FilesystemRepository: Returns the contents of the specified file
get(String) - Method in interface org.cloudbees.literate.api.v1.vfs.ProjectRepository: Returns the contents of the specified file
getBaseName() - Method in class org.cloudbees.literate.api.v1.ProjectModelRequest: Gets the base name that the project model builder will use to detect the model.
getBuild() - Method in class org.cloudbees.literate.api.v1.ProjectModel: Returns the build commands.
getBuildFor(String...) - Method in class org.cloudbees.literate.api.v1.ProjectModel: Helper version of ProjectModel.getBuildFor(ExecutionEnvironment).
getBuildFor(ExecutionEnvironment) - Method in class org.cloudbees.literate.api.v1.ProjectModel: Gets the matching build command.
getBuildId() - Method in class org.cloudbees.literate.api.v1.ProjectModelRequest: Gets the id of the build instructions within the source model.
getCommand() - Method in class org.cloudbees.literate.api.v1.TaskCommands: Returns the command.
getCommands() - Method in class org.cloudbees.literate.api.v1.AbstractCommands
getDefaultValue() - Method in class org.cloudbees.literate.api.v1.Parameter: Returns an optional default value to use if no value is provided by the user or if no user is present to provide a value.
getDescription() - Method in class org.cloudbees.literate.api.v1.Parameter: Returns a human readable description of the parameter for use if prompting the user for a value.
getEnvironments() - Method in class org.cloudbees.literate.api.v1.ProjectModel: Returns the (possibly empty) list of build environments.
getEnvironmentsId() - Method in class org.cloudbees.literate.api.v1.ProjectModelRequest: Gets the id of the environments within the source model.
getInstance(String) - Static method in class org.cloudbees.literate.api.v1.ProjectModelFormatter: Gets an instance from the current thread's context classloader for the specified mime type.
getInstance(ClassLoader, String) - Static method in class org.cloudbees.literate.api.v1.ProjectModelFormatter: Gets an instance from the specified classloader for the specified mime type.
getLabels() - Method in class org.cloudbees.literate.api.v1.ExecutionEnvironment: Returns the labels that define the environment.
getMatchingCommand(ExecutionEnvironment) - Method in class org.cloudbees.literate.api.v1.AbstractCommands: Given an environment - return us the whole script for this section, based on a "best" environmental match.
getName() - Method in class org.cloudbees.literate.api.v1.Parameter: Returns the name of the parameter.
getParameters() - Method in class org.cloudbees.literate.api.v1.AbstractCommands
getPaths(String) - Method in class org.cloudbees.literate.api.v1.vfs.FilesystemRepository: Returns the immediate child paths of the specified path.
getPaths(String) - Method in interface org.cloudbees.literate.api.v1.vfs.ProjectRepository: Returns the immediate child paths of the specified path.
getRepository() - Method in class org.cloudbees.literate.api.v1.ProjectModelRequest: Returns the project repository to construct the project model from.
getTask(String) - Method in class org.cloudbees.literate.api.v1.ProjectModel: Returns the task command for the specified task id.
getTaskIds() - Method in class org.cloudbees.literate.api.v1.ProjectModel: Returns the task ids of all the tasks defined in the model.
getTaskIds() - Method in class org.cloudbees.literate.api.v1.ProjectModelRequest: Returns the task ids to additionally populate in the project model.
getText(Node) - Static method in class org.cloudbees.literate.impl.MarkdownProjectModelBuilder
getTextUntil(Node, Node) - Static method in class org.cloudbees.literate.impl.MarkdownProjectModelBuilder
getValidValues() - Method in class org.cloudbees.literate.api.v1.Parameter: Returns an optional list of valid values that the parameter may take, if null then there is no a restriction to a finite set.

H

hashCode() - Method in class org.cloudbees.literate.api.v1.ExecutionEnvironment
hashCode() - Method in class org.cloudbees.literate.api.v1.Parameter

I

isDirectory(String) - Method in class org.cloudbees.literate.api.v1.vfs.FilesystemRepository: Returns true if and only if the specified path corresponds to a directory.
isDirectory(String) - Method in interface org.cloudbees.literate.api.v1.vfs.ProjectRepository: Returns true if and only if the specified path corresponds to a directory.
isFile(String) - Method in class org.cloudbees.literate.api.v1.vfs.FilesystemRepository: Returns true if and only if the specified path corresponds to a file.
isFile(String) - Method in interface org.cloudbees.literate.api.v1.vfs.ProjectRepository: Returns true if and only if the specified path corresponds to a file.
isMatchFor(ExecutionEnvironment) - Method in class org.cloudbees.literate.api.v1.ExecutionEnvironment: Tests if this environment satisfies the requirements of the specified environment.
isUnspecified() - Method in class org.cloudbees.literate.api.v1.ExecutionEnvironment: Returns true if the environment does not specify any labels.

J

JavaLanguage - Class in org.cloudbees.literate.impl.yaml
JavaLanguage() - Constructor for class org.cloudbees.literate.impl.yaml.JavaLanguage
join(List<String>, List<String>) - Static method in class org.cloudbees.literate.api.v1.AbstractCommands

L

Language - Interface in org.cloudbees.literate.impl.yaml

M

MARKDOWN - Static variable in class org.cloudbees.literate.api.v1.ProjectModelFormatter: The Markdown mime type.
MarkdownProjectModelBuilder - Class in org.cloudbees.literate.impl: A ProjectModelBuilder that uses a Markdown file as the source of its ProjectModel
MarkdownProjectModelBuilder() - Constructor for class org.cloudbees.literate.impl.MarkdownProjectModelBuilder
MarkdownProjectModelBuilder.StringContainsIgnoreCase - Class in org.cloudbees.literate.impl
MarkdownProjectModelBuilder.StringContainsIgnoreCase(String) - Constructor for class org.cloudbees.literate.impl.MarkdownProjectModelBuilder.StringContainsIgnoreCase
MarkdownProjectModelFormatter - Class in org.cloudbees.literate.impl
MarkdownProjectModelFormatter() - Constructor for class org.cloudbees.literate.impl.MarkdownProjectModelFormatter: Default constructor.
markerFiles(String) - Method in class org.cloudbees.literate.api.v1.ProjectModelSource: Returns the set of marker filename(s) that the source supports based on the supplied basename.
markerFiles(String) - Method in class org.cloudbees.literate.impl.MarkdownProjectModelBuilder: Returns the marker filename(s) that the model builder supports based on the supplied basename.
markerFiles(String) - Method in class org.cloudbees.literate.impl.YamlProjectModelBuilder: Returns the marker filename(s) that the model builder supports based on the supplied basename.
markerFiles(String) - Method in interface org.cloudbees.literate.spi.v1.ProjectModelBuilder: Returns the marker filename(s) that the model builder supports based on the supplied basename.
merge(BuildCommands, BuildCommands) - Static method in class org.cloudbees.literate.api.v1.BuildCommands: Merges two build commands.
merge(TaskCommands, TaskCommands) - Static method in class org.cloudbees.literate.api.v1.TaskCommands: Merges two commands, the second one will be appended to the first.

O

org.cloudbees.literate.api.v1 - package org.cloudbees.literate.api.v1
org.cloudbees.literate.api.v1.vfs - package org.cloudbees.literate.api.v1.vfs
org.cloudbees.literate.impl - package org.cloudbees.literate.impl
org.cloudbees.literate.impl.yaml - package org.cloudbees.literate.impl.yaml
org.cloudbees.literate.spi.v1 - package org.cloudbees.literate.spi.v1

P

Parameter - Class in org.cloudbees.literate.api.v1: This represents a parameter that should be exposed to some AbstractCommands
Parameter(String, String, String, Collection<String>) - Constructor for class org.cloudbees.literate.api.v1.Parameter: Constructs a new parameter.
PathNotFoundException - Exception in org.cloudbees.literate.api.v1.vfs: Indicates that the path was not found in the ProjectRepository.
PathNotFoundException() - Constructor for exception org.cloudbees.literate.api.v1.vfs.PathNotFoundException
PathNotFoundException(Throwable) - Constructor for exception org.cloudbees.literate.api.v1.vfs.PathNotFoundException
PathNotFoundException(String) - Constructor for exception org.cloudbees.literate.api.v1.vfs.PathNotFoundException
PathNotFoundException(String, Throwable) - Constructor for exception org.cloudbees.literate.api.v1.vfs.PathNotFoundException
ProjectModel - Class in org.cloudbees.literate.api.v1: Represents a literate project.
ProjectModel.Builder - Class in org.cloudbees.literate.api.v1: The builder of ProjectModel instances.
ProjectModelBuilder - Interface in org.cloudbees.literate.spi.v1: Service provider interface for ProjectModelSource.
ProjectModelBuilder.Priority - Annotation Type in org.cloudbees.literate.spi.v1: Annotation to allow defining the sequence amongst competing ProjectModelBuilder implementations.
ProjectModelBuilder.PriorityComparator - Class in org.cloudbees.literate.spi.v1: A Comparator that sorts by decreasing ProjectModelBuilder.Priority.
ProjectModelBuilder.PriorityComparator() - Constructor for class org.cloudbees.literate.spi.v1.ProjectModelBuilder.PriorityComparator
ProjectModelBuildingException - Exception in org.cloudbees.literate.api.v1: Thrown when a ProjectModel can not be built due to the violation of a project model invariant.
ProjectModelBuildingException() - Constructor for exception org.cloudbees.literate.api.v1.ProjectModelBuildingException
ProjectModelBuildingException(Throwable) - Constructor for exception org.cloudbees.literate.api.v1.ProjectModelBuildingException
ProjectModelBuildingException(String) - Constructor for exception org.cloudbees.literate.api.v1.ProjectModelBuildingException
ProjectModelBuildingException(String, Throwable) - Constructor for exception org.cloudbees.literate.api.v1.ProjectModelBuildingException
ProjectModelFormatter - Class in org.cloudbees.literate.api.v1: A formatter of ProjectModel instances.
ProjectModelFormatter(String) - Constructor for class org.cloudbees.literate.api.v1.ProjectModelFormatter: Constructor.
ProjectModelRequest - Class in org.cloudbees.literate.api.v1: A request for a ProjectModel
ProjectModelRequest.Builder - Class in org.cloudbees.literate.api.v1: A builder of ProjectModelRequest instances.
ProjectModelSource - Class in org.cloudbees.literate.api.v1: A source of ProjectModel instances.
ProjectModelSource(ClassLoader) - Constructor for class org.cloudbees.literate.api.v1.ProjectModelSource: Constructs an instance from a specific classloader.
ProjectModelSource() - Constructor for class org.cloudbees.literate.api.v1.ProjectModelSource: Constructs an instance from the current thread's context classloader.
ProjectModelValidationException - Exception in org.cloudbees.literate.api.v1: Thrown when a ProjectModel is invalid the violation of a project model invariant.
ProjectModelValidationException() - Constructor for exception org.cloudbees.literate.api.v1.ProjectModelValidationException
ProjectModelValidationException(Throwable) - Constructor for exception org.cloudbees.literate.api.v1.ProjectModelValidationException
ProjectModelValidationException(String) - Constructor for exception org.cloudbees.literate.api.v1.ProjectModelValidationException
ProjectModelValidationException(String, Throwable) - Constructor for exception org.cloudbees.literate.api.v1.ProjectModelValidationException
ProjectRepository - Interface in org.cloudbees.literate.api.v1.vfs: Represents a virtual file system that contains a project.
ProjectRepositoryException - Exception in org.cloudbees.literate.api.v1.vfs: Base class for exceptions thrown by a ProjectRepository.
ProjectRepositoryException() - Constructor for exception org.cloudbees.literate.api.v1.vfs.ProjectRepositoryException
ProjectRepositoryException(Throwable) - Constructor for exception org.cloudbees.literate.api.v1.vfs.ProjectRepositoryException
ProjectRepositoryException(String) - Constructor for exception org.cloudbees.literate.api.v1.vfs.ProjectRepositoryException
ProjectRepositoryException(String, Throwable) - Constructor for exception org.cloudbees.literate.api.v1.vfs.ProjectRepositoryException

R

relationship() - Method in class org.cloudbees.literate.impl.MarkdownProjectModelBuilder.StringContainsIgnoreCase

S

submit(ProjectModelRequest) - Method in class org.cloudbees.literate.api.v1.ProjectModelSource: Submits a request and returns the resulting model
supported() - Method in class org.cloudbees.literate.impl.yaml.JavaLanguage
supported() - Method in interface org.cloudbees.literate.impl.yaml.Language

T

TaskCommands - Class in org.cloudbees.literate.api.v1: Represents a post-build task.
TaskCommands(List<String>) - Constructor for class org.cloudbees.literate.api.v1.TaskCommands: Constructor.
TaskCommands(List<String>, List<Parameter>) - Constructor for class org.cloudbees.literate.api.v1.TaskCommands: Constructor.
toList(Map<?, Parameter>) - Static method in class org.cloudbees.literate.api.v1.Parameter: Utility method to convert a Map of Parameters into a List.
toMap(Iterable<Parameter>) - Static method in class org.cloudbees.literate.api.v1.Parameter: Utility method to convert a collection of Parameter instances into a Map keyed by Parameter.getName().
toString() - Method in class org.cloudbees.literate.api.v1.AbstractCommands
toString() - Method in class org.cloudbees.literate.api.v1.ExecutionEnvironment
toString() - Method in class org.cloudbees.literate.api.v1.Parameter

W

withBaseName(String) - Method in class org.cloudbees.literate.api.v1.ProjectModelRequest.Builder: Configure the base name to use for the request.
withBuildId(String) - Method in class org.cloudbees.literate.api.v1.ProjectModelRequest.Builder: Configure the build id to use for the request.
withEnvironmentsId(String) - Method in class org.cloudbees.literate.api.v1.ProjectModelRequest.Builder: Configure the environments id to use for the request.

Y

YamlProjectModelBuilder - Class in org.cloudbees.literate.impl: A ProjectModelBuilder that uses a YAML file as the source of its ProjectModel
YamlProjectModelBuilder() - Constructor for class org.cloudbees.literate.impl.YamlProjectModelBuilder

A B C E F G H I J L M O P R S T W Y