org.cloudbees.literate.impl

Class MarkdownProjectModelBuilder

java.lang.Object

org.cloudbees.literate.impl.MarkdownProjectModelBuilder

All Implemented Interfaces:

ProjectModelBuilder

public class MarkdownProjectModelBuilder
extends Object
implements ProjectModelBuilder

A ProjectModelBuilder that uses a Markdown file as the source of its ProjectModel

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	MarkdownProjectModelBuilder.StringContainsIgnoreCase

Nested classes/interfaces inherited from interface org.cloudbees.literate.spi.v1.ProjectModelBuilder

ProjectModelBuilder.Priority, ProjectModelBuilder.PriorityComparator

Constructor Summary

Constructors

Constructor and Description
MarkdownProjectModelBuilder()

Method Summary

Methods

Modifier and Type	Method and Description
static org.pegdown.ast.HeaderNode	asHeaderNode(org.pegdown.ast.Node node)
ProjectModel	build(ProjectModelRequest request) Tries to build a ProjectModel from the supplied ProjectModelRequest
static String	getText(org.pegdown.ast.Node node)
Collection<String>	markerFiles(String basename) Returns the marker filename(s) that the model builder supports based on the supplied basename.

Methods inherited from class java.lang.Object

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

Constructor Detail

MarkdownProjectModelBuilder

public MarkdownProjectModelBuilder()

Method Detail

getText

public static String getText(org.pegdown.ast.Node node)

asHeaderNode

public static org.pegdown.ast.HeaderNode asHeaderNode(org.pegdown.ast.Node node)

build

public ProjectModel build(ProjectModelRequest request)
                   throws IOException,
                          ProjectModelBuildingException

Tries to build a ProjectModel from the supplied ProjectModelRequest

Specified by:

build in interface ProjectModelBuilder

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
public 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 ProjectModelBuilder.build(org.cloudbees.literate.api.v1.ProjectModelRequest) against.

Specified by:

markerFiles in interface ProjectModelBuilder

Parameters:

basename - the ProjectModelRequest.getBaseName()

Returns:

the set of marker filenames.