io.spring.initializr.generator.project

Interface ProjectDescription

All Known Implementing Classes:

MutableProjectDescription

public interface ProjectDescription

Description of a project to generate.

Author:

Andy Wilkinson, Stephane Nicoll

Method Summary

Modifier and Type	Method and Description
default ProjectDescription	createCopy() Create a full copy of this description so that any additional changes made on this instance are not reflected on the returned copy.
String	getApplicationName() Return the name of the application as a standard Java identifier.
String	getArtifactId() Return the build artifactId.
String	getBaseDirectory() Return the base directory of the project or null to use the root directory.
BuildSystem	getBuildSystem() Return the BuildSystem to use.
String	getDescription() Return a human readable description of the project.
String	getGroupId() Return the build groupId.
Language	getLanguage() Return the primary Language of the project.
String	getName() Return a simple name for the project.
String	getPackageName() Return the root package name of the project.
Packaging	getPackaging() Return the build Packaging to use.
Version	getPlatformVersion() Return the requested platform Version.
Map<String,Dependency>	getRequestedDependencies() Return a immutable mapping of requested dependencies.
String	getVersion() Return the version of the project.

Method Detail

createCopy

default ProjectDescription createCopy()

Create a full copy of this description so that any additional changes made on this instance are not reflected on the returned copy.

Returns:

a clone of this instance

getRequestedDependencies

Map<String,Dependency> getRequestedDependencies()

Return a immutable mapping of requested dependencies.

Returns:

the requested dependencies

getPlatformVersion

Version getPlatformVersion()

Return the requested platform Version.

Returns:

the requested platform version or null

getBuildSystem

BuildSystem getBuildSystem()

Return the BuildSystem to use.

Returns:

the build system or null

getPackaging

Packaging getPackaging()

Return the build Packaging to use.

Returns:

the build packaging or null

getLanguage

Language getLanguage()

Return the primary Language of the project.

Returns:

the primary language or null

getGroupId

String getGroupId()

Return the build groupId.

Returns:

the groupId or null

getArtifactId

String getArtifactId()

Return the build artifactId.

Returns:

the artifactId or null

getVersion

String getVersion()

Return the version of the project.

Returns:

the version of null

getName

String getName()

Return a simple name for the project.

Returns:

the name of the project or null

getDescription

String getDescription()

Return a human readable description of the project.

Returns:

the description of the project or null

getApplicationName

String getApplicationName()

Return the name of the application as a standard Java identifier.

Returns:

the name of the application or null

getPackageName

String getPackageName()

Return the root package name of the project.

Returns:

the package name or null

getBaseDirectory

String getBaseDirectory()

Return the base directory of the project or null to use the root directory.

Returns:

the base directory