Table of Contents
API Documentation: | AbstractLinkTask |
---|
Known Subtypes: |
|
---|
Base task for linking a native binary from object files and libraries.
Property | Description |
actions | The sequence of |
ant | The |
convention | Deprecated The |
debuggable | Create a debuggable binary? |
dependsOn | The dependencies of this task. |
description | The description of this task. |
destroyables | The destroyables of this task. |
didWork | Checks if the task actually did any work. Even if a Task executes, it may determine that it has nothing to do. For example, a compilation task may determine that source files have not changed since the last time a the task was run. |
enabled | Returns if this task is enabled or not. |
extensions | The container of extensions. |
finalizedBy | Returns tasks that finalize this task. |
group | The task group which this task belongs to. The task group is used in reports and user interfaces to group related tasks together when presenting a list of tasks to the user. |
inputs | The inputs of this task. |
libs | The library files to be passed to the linker. |
linkedFile | The file where the linked binary will be located. |
linkerArgs | Additional arguments passed to the linker. |
localState | The local state of this task. |
logger | The logger for this task. You can use this in your build file to write log messages. |
logging | The |
mustRunAfter | Returns tasks that this task must run after. |
name | The name of this task. The name uniquely identifies the task within its |
outputs | The outputs of this task. |
path | The path of the task, which is a fully qualified name for the task. The path of a task is the path of
its |
project | The |
shouldRunAfter | Returns tasks that this task should run after. |
source | The source object files to be passed to the linker. |
state | The execution state of this task. This provides information about the execution of this task, such as whether it has executed, been skipped, has failed, etc. |
targetPlatform | The platform being linked for. |
taskDependencies | Returns a |
temporaryDir | Returns a directory which this task can use to write temporary files to. Each task instance is provided with a separate temporary directory. There are no guarantees that the contents of this directory will be kept beyond the execution of the task. |
timeout | The timeout of this task. |
toolChain | The tool chain used for linking. |
Method | Description |
dependsOn(paths) | Adds the given dependencies to this task. See here for a description of the types of objects which can be used as task dependencies. |
doFirst(action) | Adds the given closure to the beginning of this task's action list. The closure is passed this task as a parameter when executed. |
doFirst(actionName, action) | Adds the given |
doFirst(action) | Adds the given |
doLast(action) | Adds the given closure to the end of this task's action list. The closure is passed this task as a parameter when executed. |
doLast(actionName, action) | Adds the given |
doLast(action) | Adds the given |
doNotTrackState(reasonNotToTrackState) | Do not track the state of the task. |
finalizedBy(paths) | Adds the given finalizer tasks for this task. |
hasProperty(propertyName) | Determines if this task has the given property. See here for details of the properties which are available for a task. |
lib(libs) | Adds a set of library files to be linked. The provided libs object is evaluated as per |
mustRunAfter(paths) | Specifies that this task must run after all of the supplied tasks. |
onlyIf(onlyIfClosure) | Execute the task only if the given closure returns true. The closure will be evaluated at task execution time, not during configuration. The closure will be passed a single parameter, this task. If the closure returns false, the task will be skipped. |
onlyIf(onlyIfReason, onlyIfSpec) | Incubating Execute the task only if the given spec is satisfied. The spec will be evaluated at task execution time, not during configuration. If the Spec is not satisfied, the task will be skipped. |
onlyIf(onlyIfSpec) | Execute the task only if the given spec is satisfied. The spec will be evaluated at task execution time, not during configuration. If the Spec is not satisfied, the task will be skipped. |
property(propertyName) | Returns the value of the given property of this task. This method locates a property as follows: |
setProperty(name, value) | Sets a property of this task. This method searches for a property with the given name in the following locations, and sets the property on the first location where it finds the property. |
shouldRunAfter(paths) | Specifies that this task should run after all of the supplied tasks. |
source(source) | Adds a set of object files to be linked. The provided source object is evaluated as per |
usesService(service) | Registers a |
The sequence of Action
objects which will be executed by this task, in the order of
execution.
AntBuilder
ant
(read-only)
The AntBuilder
for this task. You can use this in your build file to execute ant
tasks.
Convention
convention
(read-only)
Note: This property is deprecated and will be removed in the next major version of Gradle.
The Convention
object for this task. A Plugin
can use the convention object to
contribute properties and methods to this task.
String
description
The description of this task.
TaskDestroyables
destroyables
(read-only)
The destroyables of this task.
Checks if the task actually did any work. Even if a Task executes, it may determine that it has nothing to do. For example, a compilation task may determine that source files have not changed since the last time a the task was run.
ExtensionContainer
extensions
(read-only)
The container of extensions.
TaskDependency
finalizedBy
Returns tasks that finalize this task.
String
group
The task group which this task belongs to. The task group is used in reports and user interfaces to group related tasks together when presenting a list of tasks to the user.
TaskInputs
inputs
(read-only)
The inputs of this task.
The library files to be passed to the linker.
RegularFileProperty
linkedFile
The file where the linked binary will be located.
ListProperty
<String
>
linkerArgs
ListProperty
<String
>Additional arguments passed to the linker.
TaskLocalState
localState
(read-only)
The local state of this task.
Logger
logger
(read-only)
The logger for this task. You can use this in your build file to write log messages.
LoggingManager
logging
(read-only)
The LoggingManager
which can be used to receive logging and to control the
standard output/error capture for this task. By default, System.out is redirected to the Gradle logging system at
the QUIET log level, and System.err is redirected at the ERROR log level.
TaskDependency
mustRunAfter
Returns tasks that this task must run after.
String
name
(read-only)
The name of this task. The name uniquely identifies the task within its Project
.
TaskOutputs
outputs
(read-only)
The outputs of this task.
String
path
(read-only)
The path of the task, which is a fully qualified name for the task. The path of a task is the path of
its Project
plus the name of the task, separated by :
.
Project
project
(read-only)
The Project
which this task belongs to.
Calling this method from a task action is not supported when configuration caching is enabled.
TaskDependency
shouldRunAfter
Returns tasks that this task should run after.
ConfigurableFileCollection
source
The source object files to be passed to the linker.
TaskState
state
(read-only)
The execution state of this task. This provides information about the execution of this task, such as whether it has executed, been skipped, has failed, etc.
Property
<NativePlatform
>
targetPlatform
Property
<NativePlatform
>The platform being linked for.
TaskDependency
taskDependencies
(read-only)
Returns a TaskDependency
which contains all the tasks that this task depends on.
Calling this method from a task action is not supported when configuration caching is enabled.
File
temporaryDir
(read-only)
Returns a directory which this task can use to write temporary files to. Each task instance is provided with a separate temporary directory. There are no guarantees that the contents of this directory will be kept beyond the execution of the task.
The timeout of this task.
task myTask {
timeout = Duration.ofMinutes(10)
}
The Thread executing this task will be interrupted if the task takes longer than the specified amount of time to run. In order for a task to work properly with this feature, it needs to react to interrupts and must clean up any resources it opened.
By default, tasks never time out.
Property
<NativeToolChain
>
toolChain
Property
<NativeToolChain
>The tool chain used for linking.
Adds the given dependencies to this task. See here for a description of the types of objects which can be used as task dependencies.
Adds the given closure to the beginning of this task's action list. The closure is passed this task as a parameter when executed.
Adds the given Action
to the beginning of this task's action list.
Adds the given Action
to the beginning of this task's action list.
Adds the given closure to the end of this task's action list. The closure is passed this task as a parameter when executed.
Adds the given Action
to the end of this task's action list.
Adds the given Action
to the end of this task's action list.
void
doNotTrackState
(String
reasonNotToTrackState)
Do not track the state of the task.
Instructs Gradle to treat the task as untracked.
Adds the given finalizer tasks for this task.
task taskY {
finalizedBy "taskX"
}
See here for a description of the types of objects which can be used to specify a finalizer task.
boolean
hasProperty
(String
propertyName)
Determines if this task has the given property. See here for details of the properties which are available for a task.
void
lib
(Object
libs)
Adds a set of library files to be linked. The provided libs object is evaluated as per Project.files(java.lang.Object[])
.
Specifies that this task must run after all of the supplied tasks.
task taskY {
mustRunAfter "taskX"
}
For each supplied task, this action adds a task 'ordering', and does not specify a 'dependency' between the tasks. As such, it is still possible to execute 'taskY' without first executing the 'taskX' in the example.
See here for a description of the types of objects which can be used to specify an ordering relationship.
void
onlyIf
(Closure
onlyIfClosure)
Execute the task only if the given closure returns true. The closure will be evaluated at task execution time, not during configuration. The closure will be passed a single parameter, this task. If the closure returns false, the task will be skipped.
You may add multiple such predicates. The task is skipped if any of the predicates return false.
Typical usage:myTask.onlyIf { isProductionEnvironment() }
Note: This method is incubating and may change in a future version of Gradle.
Execute the task only if the given spec is satisfied. The spec will be evaluated at task execution time, not during configuration. If the Spec is not satisfied, the task will be skipped.
You may add multiple such predicates. The task is skipped if any of the predicates return false.
Typical usage (from Java):
myTask.onlyIf("run only in production environment", new Spec<Task>() { boolean isSatisfiedBy(Task task) { return isProductionEnvironment(); } });
Execute the task only if the given spec is satisfied. The spec will be evaluated at task execution time, not during configuration. If the Spec is not satisfied, the task will be skipped.
You may add multiple such predicates. The task is skipped if any of the predicates return false.
Typical usage (from Java):
myTask.onlyIf(new Spec<Task>() { boolean isSatisfiedBy(Task task) { return isProductionEnvironment(); } });
Returns the value of the given property of this task. This method locates a property as follows:
- If this task object has a property with the given name, return the value of the property.
- If this task has an extension with the given name, return the extension.
- If this task's convention object has a property with the given name, return the value of the property.
- If this task has an extra property with the given name, return the value of the property.
- If not found, throw
MissingPropertyException
Sets a property of this task. This method searches for a property with the given name in the following locations, and sets the property on the first location where it finds the property.
- The task object itself. For example, the
enabled
project property. - The task's convention object.
- The task's extra properties.
If the property is not found, a MissingPropertyException
is thrown.
TaskDependency
shouldRunAfter
(Object
...
paths)
Object
...Specifies that this task should run after all of the supplied tasks.
task taskY {
shouldRunAfter "taskX"
}
For each supplied task, this action adds a task 'ordering', and does not specify a 'dependency' between the tasks. As such, it is still possible to execute 'taskY' without first executing the 'taskX' in the example.
See here for a description of the types of objects which can be used to specify an ordering relationship.
void
source
(Object
source)
Adds a set of object files to be linked. The provided source object is evaluated as per Project.files(java.lang.Object[])
.
void
usesService
(Provider
<? extends BuildService
<?>>
service)
Provider
<? extends BuildService
<?>>Registers a BuildService
that is used by this task so
BuildServiceRegistration.getMaxParallelUsages()
can be honored.