Package org.gradle.buildinit.tasks

Class InitBuild

java.lang.Object

org.gradle.api.internal.AbstractTask

org.gradle.api.DefaultTask

org.gradle.buildinit.tasks.InitBuild

All Implemented Interfaces:

Comparable<Task>, org.gradle.api.internal.DynamicObjectAware, org.gradle.api.internal.TaskInternal, ExtensionAware, Task, org.gradle.util.Configurable<Task>

public class InitBuild
extends DefaultTask

Generates a Gradle project structure.

Nested Class Summary

Nested classes/interfaces inherited from interface org.gradle.api.Task

Task.Namer

Field Summary

Fields inherited from interface org.gradle.api.Task

TASK_ACTION, TASK_CONSTRUCTOR_ARGS, TASK_DEPENDS_ON, TASK_DESCRIPTION, TASK_GROUP, TASK_NAME, TASK_OVERWRITE, TASK_TYPE

Constructor Summary

Constructors

Constructor	Description
InitBuild()

Method Summary

Modifier and Type	Method	Description
List<String>	getAvailableBuildTypes()
List<String>	getAvailableDSLs()	Available build script DSLs to be used.
List<String>	getAvailableTestFrameworks()	Available test frameworks.
String	getDsl()	The desired DSL of build scripts to create, defaults to 'groovy'.
String	getPackageName()	The name of the package to use for generated source.
org.gradle.buildinit.plugins.internal.ProjectLayoutSetupRegistry	getProjectLayoutRegistry()
String	getProjectName()	The name of the generated project, defaults to the name of the directory the project is generated in.
String	getTestFramework()	The test framework to be used in the generated project.
String	getType()	The desired type of project to generate, defaults to 'pom' if a 'pom.xml' is found in the project root and if no 'pom.xml' is found, it defaults to 'basic'.
void	setDsl(String dsl)	Set the build script DSL to be used.
void	setPackageName(String packageName)	Set the package name.
void	setProjectName(String projectName)	Set the project name.
void	setTestFramework(String testFramework)	Set the test framework to be used.
void	setType(String type)
void	setupProjectLayout()

Methods inherited from class org.gradle.api.DefaultTask

newInputDirectory, newInputFile, newOutputDirectory, newOutputFile

Methods inherited from class org.gradle.api.internal.AbstractTask

appendParallelSafeAction, compareTo, configure, dependsOn, doFirst, doFirst, doFirst, doLast, doLast, doLast, finalizedBy, getActions, getAnt, getAsDynamicObject, getConvention, getDependsOn, getDescription, getDestroyables, getDidWork, getEnabled, getExtensions, getFinalizedBy, getGroup, getIdentityPath, getImpliesSubProjects, getInputs, getLocalState, getLogger, getLogging, getMustRunAfter, getName, getOnlyIf, getOutputs, getPath, getProject, getServices, getShouldRunAfter, getStandardOutputCapture, getState, getTaskActions, getTaskDependencies, getTaskIdentity, getTemporaryDir, getTemporaryDirFactory, getTimeout, hasProperty, hasTaskActions, injectIntoNewInstance, isEnabled, isHasCustomActions, mustRunAfter, onlyIf, onlyIf, prependParallelSafeAction, property, replaceLogger, setActions, setDependsOn, setDescription, setDidWork, setEnabled, setFinalizedBy, setGroup, setImpliesSubProjects, setMustRunAfter, setOnlyIf, setOnlyIf, setProperty, setShouldRunAfter, shouldRunAfter, toString

Methods inherited from class java.lang.Object

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

Constructor Detail

InitBuild

public InitBuild()

Method Detail

getType

@Input
public String getType()

The desired type of project to generate, defaults to 'pom' if a 'pom.xml' is found in the project root and if no 'pom.xml' is found, it defaults to 'basic'. This property can be set via command-line option '--type'.

getDsl

@Incubating
@Optional
@Input
public String getDsl()

The desired DSL of build scripts to create, defaults to 'groovy'. This property can be set via command-line option '--dsl'.

Since:

4.5

getProjectName

@Incubating
@Input
public String getProjectName()

The name of the generated project, defaults to the name of the directory the project is generated in. This property can be set via command-line option '--project-name'.

Since:

5.0

getPackageName

@Incubating
@Input
public String getPackageName()

The name of the package to use for generated source. This property can be set via command-line option '--package'.

Since:

5.0

getTestFramework

@Nullable
@Optional
@Input
public String getTestFramework()

The test framework to be used in the generated project. This property can be set via command-line option '--test-framework'

getProjectLayoutRegistry

public org.gradle.buildinit.plugins.internal.ProjectLayoutSetupRegistry getProjectLayoutRegistry()

setupProjectLayout

public void setupProjectLayout()

setType

public void setType(String type)

getAvailableBuildTypes

public List<String> getAvailableBuildTypes()

setDsl

@Incubating
public void setDsl(String dsl)

Set the build script DSL to be used.

Since:

4.5

getAvailableDSLs

@Incubating
public List<String> getAvailableDSLs()

Available build script DSLs to be used.

Since:

4.5

setTestFramework

public void setTestFramework(@Nullable
                             String testFramework)

Set the test framework to be used.

getAvailableTestFrameworks

public List<String> getAvailableTestFrameworks()

Available test frameworks.

setProjectName

@Incubating
public void setProjectName(String projectName)

Set the project name.

Since:

5.0

setPackageName

@Incubating
public void setPackageName(String packageName)

Set the package name.

Since:

5.0