io.spring.initializr.generator.spring.documentation

Class HelpDocumentProjectContributor

java.lang.Object

io.spring.initializr.generator.spring.documentation.HelpDocumentProjectContributor

All Implemented Interfaces:

ProjectContributor, org.springframework.core.Ordered

public class HelpDocumentProjectContributor
extends Object
implements ProjectContributor

ProjectContributor for the project's HELP.md file.

Author:

Stephane Nicoll, Madhura Bhave

Field Summary

Fields inherited from interface org.springframework.core.Ordered

HIGHEST_PRECEDENCE, LOWEST_PRECEDENCE

Constructor Summary

Constructors

Constructor and Description
HelpDocumentProjectContributor(HelpDocument helpDocument)

Method Summary

Modifier and Type	Method and Description
void	contribute(Path projectRoot) Contribute additional resources to the project in the specified root directory.

Methods inherited from class java.lang.Object

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

Methods inherited from interface io.spring.initializr.generator.project.contributor.ProjectContributor

getOrder

Constructor Detail

HelpDocumentProjectContributor

public HelpDocumentProjectContributor(HelpDocument helpDocument)

Method Detail

contribute

public void contribute(Path projectRoot)
                throws IOException

Description copied from interface: ProjectContributor

Contribute additional resources to the project in the specified root directory.

Specified by:

contribute in interface ProjectContributor

Parameters:

projectRoot - the root directory of the project

Throws:

IOException - if contributing a resource failed