org.cloudbees.literate.spi.v1

Interface ProjectModelBuilder

All Known Implementing Classes:

MarkdownProjectModelBuilder, YamlProjectModelBuilder

public interface ProjectModelBuilder

Service provider interface for ProjectModelSource.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	ProjectModelBuilder.Priority Annotation to allow defining the sequence amongst competing ProjectModelBuilder implementations.
static class	ProjectModelBuilder.PriorityComparator A Comparator that sorts by decreasing ProjectModelBuilder.Priority.

Method Summary

Methods

Modifier and Type	Method and Description
ProjectModel	build(ProjectModelRequest request) Tries to build a ProjectModel from the supplied ProjectModelRequest
Collection<String>	markerFiles(String basename) Returns the marker filename(s) that the model builder supports based on the supplied basename.

Method Detail

build

ProjectModel build(ProjectModelRequest request)
                   throws IOException,
                          ProjectModelBuildingException

Tries to build a ProjectModel from the supplied ProjectModelRequest

Parameters:

request - the request.

Returns:

the model.

Throws:

IOException - if things go wrong.

ProjectModelBuildingException - if the source repository does not yield a valid model.

markerFiles

@NonNull
Collection<String> markerFiles(@NonNull
                                     String basename)

Returns the marker filename(s) that the model builder supports based on the supplied basename. The presence of a marker file in a project root indicates that the project root is worth attempting to build(org.cloudbees.literate.api.v1.ProjectModelRequest) against.

Parameters:

basename - the ProjectModelRequest.getBaseName()

Returns:

the set of marker filenames.