Package org.gradle.buildinit.specs

Schnittstelle BuildInitSpec

Alle Superschnittstellen:

Describable

@Incubating
public interface BuildInitSpec
extends Describable

Represents a specification for a new type of project that the init task can generate.

Seit:

8.12

Implementation Requirements:

Meant to be implemented by plugins that want to provide additional project types, with implementations being discoverable by a ServiceLoader.

Methodenübersicht

Modifizierer und Typ	Methode	Beschreibung
default String	getDisplayName()	The name of the type of project this spec will generate.
default List<BuildInitParameter<?>>	getParameters()	Returns the parameters that can be provided to configure this project during generation.
String	getType()	An identifier for the type of project this spec will generate.

Methodendetails

getDisplayName

default String getDisplayName()

The 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 init task. By default, this is the proper-cased version of getType().

Angegeben von:

getDisplayName in Schnittstelle Describable

Gibt zurück:

a name providing a brief description of this type of project

Seit:

8.12

getType

String 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 init task non-interactively by supplying the --type parameter to the init task.

Each project type can be registered to only a single BuildInitGenerator.

Gibt zurück:

type id for this type of project

Seit:

8.12

Implementation Requirements:

Must be unique amongst all project types contributed by a plugin.

getParameters

default List<BuildInitParameter<?>> getParameters()

Returns the parameters that can be provided to configure this project during generation.

Gibt zurück:

the parameters for this type of project specification

Seit:

8.12