io.spring.initializr.generator.project

Class ProjectGenerator

java.lang.Object

io.spring.initializr.generator.project.ProjectGenerator

public class ProjectGenerator
extends Object

Main entry point for project generation that processes a ProjectDescription by creating a dedicated ProjectGenerationContext with all available ProjectGenerationConfiguration classes. Once the context has been started for a particular ProjectDescription, a ProjectAssetGenerator can query it and generate an appropriate asset (for instance, a project structure on disk).

Author:

Andy Wilkinson, Stephane Nicoll

Constructor Summary

Constructors

Constructor and Description
ProjectGenerator(Consumer<ProjectGenerationContext> contextConsumer) Create an instance with a customizer for the ProjectGenerationContext and a default factory for the ProjectGenerationContext that disables bean definition overriding.
ProjectGenerator(Consumer<ProjectGenerationContext> contextConsumer, Supplier<? extends ProjectGenerationContext> contextFactory) Create an instance with a customizer for the project generator application context and a factory for the ProjectGenerationContext.

Method Summary

Modifier and Type	Method and Description
<T> T	generate(ProjectDescription description, ProjectAssetGenerator<T> projectAssetGenerator) Generate project assets using the specified ProjectAssetGenerator for the specified ProjectDescription.
protected List<String>	getCandidateProjectGenerationConfigurations(ProjectDescription description) Return the ProjectGenerationConfiguration class names that should be considered.

Methods inherited from class java.lang.Object

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

Constructor Detail

ProjectGenerator

public ProjectGenerator(Consumer<ProjectGenerationContext> contextConsumer,
                        Supplier<? extends ProjectGenerationContext> contextFactory)

Create an instance with a customizer for the project generator application context and a factory for the ProjectGenerationContext.

Parameters:

contextConsumer - a consumer of the project generation context after contributors and the ProjectDescription have been registered but before it is refreshed

contextFactory - the factory to use to create ProjectGenerationContext instances

ProjectGenerator

public ProjectGenerator(Consumer<ProjectGenerationContext> contextConsumer)

Create an instance with a customizer for the ProjectGenerationContext and a default factory for the ProjectGenerationContext that disables bean definition overriding.

Parameters:

contextConsumer - a consumer of the project generation context after contributors and the ProjectDescription have been registered but before it is refreshed

See Also:

GenericApplicationContext.setAllowBeanDefinitionOverriding(boolean)

Method Detail

generate

public <T> T generate(ProjectDescription description,
                      ProjectAssetGenerator<T> projectAssetGenerator)
               throws ProjectGenerationException

Generate project assets using the specified ProjectAssetGenerator for the specified ProjectDescription.

Create a dedicated ProjectGenerationContext using the supplied contextFactory and then apply the following:

• Register a ProjectDescription bean based on the given description post-processed by available ProjectDescriptionCustomizer beans.
• Process all registered ProjectGenerationConfiguration classes.
• Apply the contextConsumer to further customize the context before it is refreshed.

Type Parameters:

T - the type that gathers the project assets

Parameters:

description - the description of the project to generate

projectAssetGenerator - the ProjectAssetGenerator to invoke

Returns:

the generated content

Throws:

ProjectGenerationException - if an error occurs while generating the project

getCandidateProjectGenerationConfigurations

protected List<String> getCandidateProjectGenerationConfigurations(ProjectDescription description)

Return the ProjectGenerationConfiguration class names that should be considered. By default this method will load candidates using SpringFactoriesLoader with ProjectGenerationConfiguration.

Parameters:

description - the description of the project to generate

Returns:

a list of candidate configurations