gradle/org.gradle.api.tasks.wrapper/Wrapper

Wrapper

@DisableCachingByDefault(because = "Updating the wrapper is not worth caching")

abstract class Wrapper : DefaultTask(source)

Generates scripts (for *nix and windows) which allow you to build your project with Gradle, without having to install Gradle.

When a user executes a wrapper script the first time, the script downloads and installs the appropriate Gradle distribution and runs the build against this downloaded distribution. Any installed Gradle distribution is ignored when using the wrapper scripts.

The scripts generated by this task are intended to be committed to your version control system. This task also generates a small gradle-wrapper.jar bootstrap JAR file and properties file which should also be committed to your VCS. The scripts delegates to this JAR.

Constructors

constructor()

Types

DistributionType

enum DistributionType

Specifies the Gradle distribution type.

Specifies how the wrapper path should be interpreted.

Properties

@get:Input

open var archiveBase: Wrapper.PathBase

@get:Input

open var archivePath: String

DEFAULT_DISTRIBUTION_PARENT_NAME

val DEFAULT_DISTRIBUTION_PARENT_NAME: String = "wrapper/dists"

open var description: String

distributionBase

@get:Input

open var distributionBase: Wrapper.PathBase

distributionPath

@get:Input

open var distributionPath: String

distributionSha256Sum

@get:Nullable

@get:Input

open var distributionSha256Sum: String

distributionType

@get:Input

open var distributionType: Wrapper.DistributionType

distributionUrl

@get:Input

open var distributionUrl: String

open var enabled: Boolean

val ExtensionAware.extra: ExtraPropertiesExtension

The extra properties extension in this object's extension container.

open var group: String

impliesSubProjects

open var impliesSubProjects: Boolean

@get:Input

@get:Incubating

val networkTimeout: Property<Integer>

val state: TaskStateInternal

val TASK_ACTION: String = "action"

TASK_CONSTRUCTOR_ARGS

val TASK_CONSTRUCTOR_ARGS: String = "constructorArgs"

TASK_DEPENDS_ON

val TASK_DEPENDS_ON: String = "dependsOn"

TASK_DESCRIPTION

val TASK_DESCRIPTION: String = "description"

val TASK_GROUP: String = "group"

val TASK_NAME: String = "name"

val TASK_OVERWRITE: String = "overwrite"

val TASK_TYPE: String = "type"

val timeout: Property<Duration>

Functions

acceptServiceReferences

open fun acceptServiceReferences(serviceReferences: Set<ServiceReferenceSpec>)

appendParallelSafeAction

open fun appendParallelSafeAction(action: Action<in Task>)

open fun compareTo(otherTask: Task): Int

open fun configure(closure: Closure): Task

abstract fun configure(cl: Closure): T

inline fun <T : Any> ExtensionAware.configure(noinline configuration: T.() -> Unit)

Executes the given configuration block against the extension of the specified type.

open fun dependsOn(paths: Array<Any>): Task

open fun doFirst(action: Action<in Task>): Task

open fun doLast(action: Action<in Task>): Task

doNotTrackState

open fun doNotTrackState(reasonNotToTrackState: String)

open fun finalizedBy(paths: Array<Any>): Task

open fun getActions(): List<Action<in Task>>

open fun getAnt(): AntBuilder

getAsDynamicObject

open fun getAsDynamicObject(): DynamicObject

getAvailableDistributionTypes

open fun getAvailableDistributionTypes(): List<Wrapper.DistributionType>

The list of available gradle distribution types.

open fun getBatchScript(): File

Returns the file to write the wrapper batch script to.

open fun getConvention(): Convention

open fun getDependsOn(): Set<Any>

getDestroyables

open fun getDestroyables(): TaskDestroyables

open fun getDidWork(): Boolean

open fun getExtensions(): ExtensionContainer

open fun getFinalizedBy(): TaskDependency

getGradleVersion

open fun getGradleVersion(): String

Returns the gradle version for the wrapper.

getIdentityPath

open fun getIdentityPath(): Path

open fun getInputs(): TaskInputsInternal

abstract fun getInputs(): TaskInputs

open fun getJarFile(): File

Returns the file to write the wrapper jar file to.

getLifecycleDependencies

open fun getLifecycleDependencies(): TaskDependencyInternal

abstract fun getLifecycleDependencies(): TaskDependency

open fun getLocalState(): TaskLocalState

open fun getLogger(): Logger

open fun getLogging(): LoggingManager

getMustRunAfter

open fun getMustRunAfter(): TaskDependency

open fun getName(): String

open fun getOnlyIf(): Spec<in TaskInternal>

open fun getOutputs(): TaskOutputsInternal

abstract fun getOutputs(): TaskOutputs

open fun getPath(): String

open fun getProject(): Project

getPropertiesFile

open fun getPropertiesFile(): File

Returns the file to write the wrapper properties to.

getReasonNotToTrackState

open fun getReasonNotToTrackState(): Optional<String>

getReasonTaskIsIncompatibleWithConfigurationCache

open fun getReasonTaskIsIncompatibleWithConfigurationCache(): Optional<String>

getRequiredServices

open fun getRequiredServices(): TaskRequiredServices

open fun getScriptFile(): File

Returns the file to write the wrapper script to.

getSharedResources

open fun getSharedResources(): List<ResourceLock>

abstract fun getSharedResources(): List<out ResourceLock>

getShouldRunAfter

open fun getShouldRunAfter(): TaskDependency

getStandardOutputCapture

open fun getStandardOutputCapture(): StandardOutputCapture

abstract fun getState(): TaskState

open fun getTaskActions(): List<InputChangesAwareTaskAction>

getTaskDependencies

open fun getTaskDependencies(): TaskDependencyInternal

abstract fun getTaskDependencies(): TaskDependency

getTaskIdentity

open fun getTaskIdentity(): TaskIdentity<out Any>

getTemporaryDir

open fun getTemporaryDir(): File

getTemporaryDirFactory

open fun getTemporaryDirFactory(): Factory<File>

getValidateDistributionUrl

abstract fun getValidateDistributionUrl(): Property<Boolean>

Indicates if this task will validate the distribution url that has been configured.

open fun hasProperty(propertyName: String): Boolean

open fun hasTaskActions(): Boolean

injectIntoNewInstance

open fun <T : Task?> injectIntoNewInstance(project: ProjectInternal, identity: TaskIdentity<T>, factory: Callable<T>): T

isCompatibleWithConfigurationCache

open fun isCompatibleWithConfigurationCache(): Boolean

open fun isEnabled(): Boolean

isHasCustomActions

open fun isHasCustomActions(): Boolean

open fun mustRunAfter(paths: Array<Any>): Task

notCompatibleWithConfigurationCache

open fun notCompatibleWithConfigurationCache(reason: String)

open fun onlyIf(spec: Spec<in Task>)

prependParallelSafeAction

open fun prependParallelSafeAction(action: Action<in Task>)

open fun property(propertyName: String): Any

open fun setActions(replacements: List<Action<in Task>>)

open fun setDependsOn(dependsOn: Iterable<out Any>)

open fun setDidWork(didWork: Boolean)

open fun setFinalizedBy(finalizedByTasks: Iterable<out Any>)

setGradleVersion

open fun setGradleVersion(gradleVersion: String)

The version of the gradle distribution required by the wrapper.

open fun setJarFile(jarFile: File)

open fun setJarFile(jarFile: Any)

The file to write the wrapper jar file to.

setMustRunAfter

open fun setMustRunAfter(mustRunAfterTasks: Iterable<out Any>)

open fun setOnlyIf(spec: Spec<in Task>)

open fun setProperty(name: String, value: Any)

open fun setScriptFile(scriptFile: File)

open fun setScriptFile(scriptFile: Any)

The file to write the wrapper script to.

setShouldRunAfter

open fun setShouldRunAfter(shouldRunAfterTasks: Iterable<out Any>)

setWrapperVersionsResources

open fun setWrapperVersionsResources(wrapperVersionsResources: WrapperVersionsResources)

Set Wrapper versions resources.

open fun shouldRunAfter(paths: Array<Any>): TaskDependency

inline fun <T : Any> ExtensionAware.the(): T

Returns the extension of the specified type.

fun <T : Any> ExtensionAware.the(extensionType: KClass<T>): T

Returns the extension of the specified extensionType.

open fun usesService(service: Provider<out BuildService<out Any>>)