# ObjectFilesToBinary

interface ObjectFilesToBinary : Task(source)

A task that combines a set of object files into a single binary.

#### Inheritors

CreateStaticLibrary
AbstractLinkTask

## Properties

extra
Link copied to clipboard
val ExtensionAware. extra: ExtraPropertiesExtension

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

TASK_ACTION
Link copied to clipboard
val TASK_ACTION: String = "action"
TASK_CONSTRUCTOR_ARGS
Link copied to clipboard
val TASK_CONSTRUCTOR_ARGS: String = "constructorArgs"
Constructor arguments for the Task
TASK_DEPENDS_ON
Link copied to clipboard
val TASK_DEPENDS_ON: String = "dependsOn"
TASK_DESCRIPTION
Link copied to clipboard
val TASK_DESCRIPTION: String = "description"
TASK_GROUP
Link copied to clipboard
val TASK_GROUP: String = "group"
TASK_NAME
Link copied to clipboard
val TASK_NAME: String = "name"
TASK_OVERWRITE
Link copied to clipboard
val TASK_OVERWRITE: String = "overwrite"
TASK_TYPE
Link copied to clipboard
val TASK_TYPE: String = "type"

## Functions

compareTo
Link copied to clipboard
abstract fun compareTo(p: T): Int
configure
Link copied to clipboard
abstract fun configure(configureClosure: Closure): Task
Applies the statements of the closure against this task object.
configure
Link copied to clipboard
inline fun <T : Any> ExtensionAware. configure(noinline configuration: T.() -> Unit)

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

dependsOn
Link copied to clipboard
abstract fun dependsOn(paths: Array<Any>): Task
Adds the given dependencies to this task.
doFirst
Link copied to clipboard
abstract fun doFirst(@DelegatesTo(value = Task::class) action: Closure): Task
Adds the given closure to the beginning of this task's action list.
abstract fun doFirst(action: Action<in Task>): Task
abstract fun doFirst(actionName: String, action: Action<in Task>): Task
Adds the given Action to the beginning of this task's action list.
doLast
Link copied to clipboard
abstract fun doLast(@DelegatesTo(value = Task::class) action: Closure): Task
Adds the given closure to the end of this task's action list.
abstract fun doLast(action: Action<in Task>): Task
abstract fun doLast(actionName: String, action: Action<in Task>): Task
Adds the given Action to the end of this task's action list.
doNotTrackState
Link copied to clipboard
abstract fun doNotTrackState(reasonNotToTrackState: String)
Do not track the state of the task.
finalizedBy
Link copied to clipboard
abstract fun finalizedBy(paths: Array<Any>): Task
Adds the given finalizer tasks for this task.
getActions
Link copied to clipboard
@Internal
abstract fun getActions(): List<Action<in Task>>
Returns the sequence of Action objects which will be executed by this task, in the order of execution.
getAnt
Link copied to clipboard
@Internal
abstract fun getAnt(): AntBuilder
Returns the `AntBuilder` for this task.
getDependsOn
Link copied to clipboard
@Internal
abstract fun getDependsOn(): Set<Any>
Returns the dependencies of this task.
getDescription
Link copied to clipboard
@Internal
@Nullable
abstract fun getDescription(): @Nullable String
Returns the description of this task.
getDestroyables
Link copied to clipboard
@Internal
abstract fun getDestroyables(): TaskDestroyables
Returns the destroyables of this task.
getDidWork
Link copied to clipboard
@Internal
abstract fun getDidWork(): Boolean
Checks if the task actually did any work.
getEnabled
Link copied to clipboard
@Internal
abstract fun getEnabled(): Boolean
Returns if this task is enabled or not.
getExtensions
Link copied to clipboard
@Internal
abstract fun getExtensions(): ExtensionContainer
The container of extensions.
getFinalizedBy
Link copied to clipboard
@Internal
abstract fun getFinalizedBy(): TaskDependency
Returns tasks that finalize this task.
getGroup
Link copied to clipboard
@Internal
@Nullable
abstract fun getGroup(): @Nullable String
Returns the task group which this task belongs to.
getInputs
Link copied to clipboard
@Internal
abstract fun getInputs(): TaskInputs
Returns the inputs of this task.
getLocalState
Link copied to clipboard
@Internal
abstract fun getLocalState(): TaskLocalState
Returns the local state of this task.
getLogger
Link copied to clipboard
@Internal
abstract fun getLogger(): Logger
Returns the logger for this task.
getLogging
Link copied to clipboard
@Internal
abstract fun getLogging(): LoggingManager
Returns the org.gradle.api.logging.LoggingManager which can be used to receive logging and to control the standard output/error capture for this task.
getMustRunAfter
Link copied to clipboard
@Internal
abstract fun getMustRunAfter(): TaskDependency
Returns tasks that this task must run after.
getName
Link copied to clipboard
@Internal
abstract fun getName(): String
Returns the name of this task.
getOutputs
Link copied to clipboard
@Internal
abstract fun getOutputs(): TaskOutputs
Returns the outputs of this task.
getPath
Link copied to clipboard
@Internal
abstract fun getPath(): String
Returns the path of the task, which is a fully qualified name for the task.
getProject
Link copied to clipboard
@Internal
abstract fun getProject(): Project
Returns the Project which this task belongs to.
getShouldRunAfter
Link copied to clipboard
@Internal
abstract fun getShouldRunAfter(): TaskDependency
Returns tasks that this task should run after.
getState
Link copied to clipboard
@Internal
abstract fun getState(): TaskState
Returns the execution state of this task.
getTaskDependencies
Link copied to clipboard
@Internal
abstract fun getTaskDependencies(): TaskDependency
Returns a TaskDependency which contains all the tasks that this task depends on.
getTemporaryDir
Link copied to clipboard
@Internal
abstract fun getTemporaryDir(): File
Returns a directory which this task can use to write temporary files to.
getTimeout
Link copied to clipboard
@Internal
abstract fun getTimeout(): Property<Duration>
The timeout of this task.
hasProperty
Link copied to clipboard
abstract fun hasProperty(propertyName: String): Boolean
Determines if this task has the given property.
mustRunAfter
Link copied to clipboard
abstract fun mustRunAfter(paths: Array<Any>): Task
Specifies that this task must run after all of the supplied tasks.
notCompatibleWithConfigurationCache
Link copied to clipboard
abstract fun notCompatibleWithConfigurationCache(reason: String)
Specifies that this task is not compatible with the configuration cache.
onlyIf
Link copied to clipboard
abstract fun onlyIf(onlyIfClosure: Closure<out Any>)
Execute the task only if the given closure returns true.
abstract fun onlyIf(onlyIfSpec: Spec<in Task>)
@Incubating
abstract fun onlyIf(onlyIfReason: String, onlyIfSpec: Spec<in Task>)
Execute the task only if the given spec is satisfied.
property
Link copied to clipboard
@Nullable
abstract fun property(propertyName: String): @Nullable Any
Returns the value of the given property of this task.
setActions
Link copied to clipboard
abstract fun setActions(actions: List<Action<in Task>>)
Sets the sequence of Action objects which will be executed by this task.
setDependsOn
Link copied to clipboard
abstract fun setDependsOn(dependsOnTasks: Iterable<out Any>)
Sets the dependencies of this task.
setDescription
Link copied to clipboard
abstract fun setDescription(@Nullable description: @Nullable String)
Sets a description for this task.
setDidWork
Link copied to clipboard
abstract fun setDidWork(didWork: Boolean)
Sets whether the task actually did any work.
setEnabled
Link copied to clipboard
abstract fun setEnabled(enabled: Boolean)
Set the enabled state of a task.
setFinalizedBy
Link copied to clipboard
abstract fun setFinalizedBy(finalizedBy: Iterable<out Any>)
Specifies the set of finalizer tasks for this task.
setGroup
Link copied to clipboard
abstract fun setGroup(@Nullable group: @Nullable String)
Sets the task group which this task belongs to.
setMustRunAfter
Link copied to clipboard
abstract fun setMustRunAfter(mustRunAfter: Iterable<out Any>)
Specifies the set of tasks that this task must run after.
setOnlyIf
Link copied to clipboard
abstract fun setOnlyIf(onlyIfClosure: Closure<out Any>)
Execute the task only if the given closure returns true.
abstract fun setOnlyIf(onlyIfSpec: Spec<in Task>)
@Incubating
abstract fun setOnlyIf(onlyIfReason: String, onlyIfSpec: Spec<in Task>)
Execute the task only if the given spec is satisfied.
setProperty
Link copied to clipboard
abstract fun setProperty(name: String, value: Any)
Sets a property of this task.
setShouldRunAfter
Link copied to clipboard
abstract fun setShouldRunAfter(shouldRunAfter: Iterable<out Any>)
Specifies the set of tasks that this task should run after.
shouldRunAfter
Link copied to clipboard
abstract fun shouldRunAfter(paths: Array<Any>): TaskDependency
Specifies that this task should run after all of the supplied tasks.
source
Link copied to clipboard
abstract fun source(source: Any)
Adds a set of object files to be combined into the file binary.
the
Link copied to clipboard
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.

usesService
Link copied to clipboard
abstract fun usesService(service: Provider<out BuildService<out Any>>)
Registers a BuildService that is used by this task so its constraint on parallel execution can be honored.