gradle/org.gradle.nativeplatform/NativeBinarySpec

NativeBinarySpec

@Incubating

interface NativeBinarySpec : BinarySpec(source)

Represents a binary artifact that is the result of building a native component.

Inheritors

NativeExecutableBinarySpec

NativeLibraryBinarySpec

NativeTestSuiteBinarySpec

Functions

builtBy

abstract fun builtBy(tasks: Array<Any>)

Adds tasks required to build this component.

checkedBy

abstract fun checkedBy(tasks: Array<Any>)

Adds tasks required to check this component.

getAssembler

abstract fun getAssembler(): Tool

The configuration of the assembler used when compiling assembly sources this binary.

getBuildDependencies

abstract fun getBuildDependencies(): TaskDependency

Returns a dependency which contains the tasks which build this artifact.

getBuildTask

@Nullable

abstract fun getBuildTask(): @Nullable Task

Returns the task responsible for building this component.

getBuildType

abstract fun getBuildType(): BuildType

Returns the org.gradle.nativeplatform.BuildType used to construct this binary.

getcCompiler

abstract fun getcCompiler(): PreprocessingTool

The configuration of the C compiler used when compiling C sources for this binary.

getCheckTask

@Nullable

abstract fun getCheckTask(): @Nullable Task

Returns the task responsible for checking this component.

getComponent

abstract fun getComponent(): NativeComponentSpec

The component that this binary was built from.

getCppCompiler

abstract fun getCppCompiler(): PreprocessingTool

The configuration of the C++ compiler used when compiling C++ sources for this binary.

getDisplayName

abstract fun getDisplayName(): String

Returns a human-consumable display name for this binary.

getFlavor

abstract fun getFlavor(): Flavor

The org.gradle.nativeplatform.Flavor that this binary was built with.

getInputs

abstract fun getInputs(): DomainObjectSet<LanguageSourceSet>

Returns all inputs of the binary.

getLibs

abstract fun getLibs(): Collection<NativeDependencySet>

The libraries that should be linked into this binary.

getLinker

abstract fun getLinker(): Tool

The configuration of the linker used when linking this binary.

getName

abstract fun getName(): String

Returns the name of this element.

getObjcCompiler

abstract fun getObjcCompiler(): PreprocessingTool

The configuration of the Objective-C compiler used when compiling Objective-C sources for this binary.

getObjcppCompiler

abstract fun getObjcppCompiler(): PreprocessingTool

The configuration of the Objective-C++ compiler used when compiling Objective-C++ sources for this binary.

getProjectPath

abstract fun getProjectPath(): String

The path to the project containing this component.

getRcCompiler

abstract fun getRcCompiler(): PreprocessingTool

The configuration of the Resource compiler used when compiling resources for this binary.

getSources

abstract fun getSources(): ModelMap<LanguageSourceSet>

The sources owned by this binary.

getStaticLibArchiver

abstract fun getStaticLibArchiver(): Tool

The configuration of the static library archiver used when creating this binary.

getTargetPlatform

abstract fun getTargetPlatform(): NativePlatform

Returns the org.gradle.nativeplatform.platform.NativePlatform that this binary is targeted to run on.

getTasks

abstract fun getTasks(): BinaryTasksCollection

The set of tasks associated with this binary.

getToolChain

abstract fun getToolChain(): NativeToolChain

Returns the org.gradle.nativeplatform.toolchain.NativeToolChain that will be used to build this binary.

hasBuildDependencies

abstract fun hasBuildDependencies(): Boolean

isBuildable

abstract fun isBuildable(): Boolean

Can this binary be built in the current environment?

lib

abstract fun lib(library: Any)

Adds a library as input to this binary.

setBuildTask

abstract fun setBuildTask(@Nullable buildTask: @Nullable Task)

Specifies the task responsible for building this component.

setCheckTask

abstract fun setCheckTask(@Nullable checkTask: @Nullable Task)

Specifies the task responsible for checking this component.