Package io.spring.initializr.web.project

Class DefaultProjectRequestToDescriptionConverter

java.lang.Object

io.spring.initializr.web.project.DefaultProjectRequestToDescriptionConverter

All Implemented Interfaces:

ProjectRequestToDescriptionConverter<ProjectRequest>

public class DefaultProjectRequestToDescriptionConverter
extends Object
implements ProjectRequestToDescriptionConverter<ProjectRequest>

A default ProjectRequestToDescriptionConverter implementation that uses the metadata to set default values for missing attributes if necessary. Transparently transform the platform version if necessary using a ProjectRequestPlatformVersionTransformer.

Author:

Madhura Bhave, HaiTao Zhang, Stephane Nicoll, Nirbhay Mishra

Constructor Summary

Constructors

Constructor	Description
DefaultProjectRequestToDescriptionConverter()
DefaultProjectRequestToDescriptionConverter(ProjectRequestPlatformVersionTransformer platformVersionTransformer)

Method Summary

Modifier and Type	Method	Description
protected String	cleanInputValue(String value)	Clean input value to rely on US-ascii character as much as possible.
void	convert(ProjectRequest request, MutableProjectDescription description, InitializrMetadata metadata)	Validate the specified request and initialize the specified description.
ProjectDescription	convert(ProjectRequest request, InitializrMetadata metadata)	Validate and convert the specified ProjectRequest to a ProjectDescription used as the source of project generation.

Methods inherited from class java.lang.Object

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

Constructor Details

DefaultProjectRequestToDescriptionConverter

public DefaultProjectRequestToDescriptionConverter()

DefaultProjectRequestToDescriptionConverter

public DefaultProjectRequestToDescriptionConverter(ProjectRequestPlatformVersionTransformer platformVersionTransformer)

Method Details

convert

public ProjectDescription convert(ProjectRequest request,
 InitializrMetadata metadata)

Description copied from interface: ProjectRequestToDescriptionConverter

Validate and convert the specified ProjectRequest to a ProjectDescription used as the source of project generation.

Specified by:

convert in interface ProjectRequestToDescriptionConverter<ProjectRequest>

Parameters:

request - the request to convert

metadata - the metadata instance to use

Returns:

a validated ProjectDescription to use to generate a project that matches the specified request

convert

public void convert(ProjectRequest request,
 MutableProjectDescription description,
 InitializrMetadata metadata)

Validate the specified request and initialize the specified description. Override any attribute of the description that are managed by this instance.

Parameters:

request - the request to validate

description - the description to initialize

metadata - the metadata instance to use to apply defaults if necessary

cleanInputValue

protected String cleanInputValue(String value)

Clean input value to rely on US-ascii character as much as possible.

Parameters:

value - the input value to clean

Returns:

a value that can be used as part of an identifier