Package org.gradle.buildinit.specs
Interface BuildInitSpec
- All Superinterfaces:
- Describable
Represents a specification for a new type of project that the 
init task can generate.- Since:
- 8.12
- Implementation Requirements:
- Meant to be implemented by plugins that want to provide additional project types, with implementations
 being discoverable by a ServiceLoader.
- 
Method SummaryModifier and TypeMethodDescriptiondefault StringThe name of the type of project this spec will generate.default List<BuildInitParameter<?>> Returns the parameters that can be provided to configure this project during generation.getType()An identifier for the type of project this spec will generate.
- 
Method Details- 
getDisplayNameThe name of the type of project this spec will generate.This will be used to allow the user to select a project type when running the inittask. By default, this is the proper-cased version ofgetType().- Specified by:
- getDisplayNamein interface- Describable
- Returns:
- a name providing a brief description of this type of project
- Since:
- 8.12
 
- 
getTypeString getType()An identifier for the type of project this spec will generate.This will be used to allow the user to select a project type when running the inittask non-interactively by supplying the--typeparameter to the init task.Each project type can be registered to only a single BuildInitGenerator.- Returns:
- type id for this type of project
- Since:
- 8.12
- Implementation Requirements:
- Must be unique amongst all project types contributed by a plugin.
 
- 
getParametersReturns the parameters that can be provided to configure this project during generation.- Returns:
- the parameters for this type of project specification
- Since:
- 8.12
 
 
-