Package io.spring.initializr.web.support
Class CommandLineHelpGenerator
java.lang.Object
io.spring.initializr.web.support.CommandLineHelpGenerator
Generate help pages for command-line clients.
- Author:
- Stephane Nicoll
-
Constructor Summary
ConstructorsConstructorDescriptionCommandLineHelpGenerator
(TemplateRenderer template) CommandLineHelpGenerator
(TemplateRenderer template, int maxColumnWidth) -
Method Summary
Modifier and TypeMethodDescriptionbuildParametersDescription
(InitializrMetadata metadata) generateCurlCapabilities
(InitializrMetadata metadata, String serviceUrl) Generate the capabilities of the service using "curl" as a plain text document.protected String
generateDependencyTable
(InitializrMetadata metadata) generateGenericCapabilities
(InitializrMetadata metadata, String serviceUrl) Generate the capabilities of the service as a generic plain text document.generateHttpieCapabilities
(InitializrMetadata metadata, String serviceUrl) Generate the capabilities of the service using "HTTPie" as a plain text document.generateSpringBootCliCapabilities
(InitializrMetadata metadata, String serviceUrl) Generate the capabilities of the service using Spring Boot CLI as a plain text document.protected String
generateTypeTable
(InitializrMetadata metadata, String linkHeader, boolean addTags) initializeCommandLineModel
(InitializrMetadata metadata, String serviceUrl) initializeSpringBootCliModel
(InitializrMetadata metadata, String serviceUrl)
-
Constructor Details
-
CommandLineHelpGenerator
-
CommandLineHelpGenerator
-
-
Method Details
-
generateGenericCapabilities
public String generateGenericCapabilities(InitializrMetadata metadata, String serviceUrl) throws IOException Generate the capabilities of the service as a generic plain text document. Used when no particular agent was detected.- Parameters:
metadata
- the initializr metadataserviceUrl
- the service URL- Returns:
- the generic capabilities text document
- Throws:
IOException
- if rendering the capabilities failed
-
generateCurlCapabilities
public String generateCurlCapabilities(InitializrMetadata metadata, String serviceUrl) throws IOException Generate the capabilities of the service using "curl" as a plain text document.- Parameters:
metadata
- the initializr metadataserviceUrl
- the service URL- Returns:
- the generic capabilities text document
- Throws:
IOException
- if rendering the capabilities failed
-
generateHttpieCapabilities
public String generateHttpieCapabilities(InitializrMetadata metadata, String serviceUrl) throws IOException Generate the capabilities of the service using "HTTPie" as a plain text document.- Parameters:
metadata
- the initializr metadataserviceUrl
- the service URL- Returns:
- the generic capabilities text document
- Throws:
IOException
- if rendering the capabilities failed
-
generateSpringBootCliCapabilities
public String generateSpringBootCliCapabilities(InitializrMetadata metadata, String serviceUrl) throws IOException Generate the capabilities of the service using Spring Boot CLI as a plain text document.- Parameters:
metadata
- the initializr metadataserviceUrl
- the service URL- Returns:
- the generic capabilities text document
- Throws:
IOException
- if rendering the capabilities failed
-
initializeCommandLineModel
protected Map<String,Object> initializeCommandLineModel(InitializrMetadata metadata, String serviceUrl) -
initializeSpringBootCliModel
protected Map<String,Object> initializeSpringBootCliModel(InitializrMetadata metadata, String serviceUrl) -
generateDependencyTable
-
generateTypeTable
-
buildParametersDescription
-