api / org.gradle.language.nativeplatform / ComponentWithInstallation

ComponentWithInstallation

@Incubating interface ComponentWithInstallation : ComponentWithNativeRuntime

Represents a native component that produces an application installation.

Since
4.5

Functions

getInstallDirectory	`abstract fun getInstallDirectory(): Provider<Directory>` Returns the installation directory.
getInstallTask	`abstract fun getInstallTask(): Provider<out InstallExecutable>` Returns the install task.
getRuntimeLibraries	`abstract fun getRuntimeLibraries(): FileCollection` Returns the runtime libraries required for the installation. Includes the runtime libraries of the component's dependencies.

Inherited Functions

getBaseName	`abstract fun getBaseName(): Provider<String>` Returns the base name of this component. This is used to calculate output file names.
getTargetPlatform	`abstract fun getTargetPlatform(): NativePlatform` Returns the target platform for this component.
getToolChain	`abstract fun getToolChain(): NativeToolChain` Returns the tool chain for this component.
isDebuggable	`abstract fun isDebuggable(): Boolean` Returns true if this component has debugging enabled.
isOptimized	`abstract fun isOptimized(): Boolean` Returns true if this component is optimized.

Inheritors

CppExecutable	`interface CppExecutable : CppBinary, ComponentWithExecutable, ComponentWithInstallation, ComponentWithOutputs, ComponentWithRuntimeUsage, PublishableComponent` An executable built from C++ source.
CppTestExecutable	`interface CppTestExecutable : CppBinary, ComponentWithExecutable, ComponentWithInstallation, TestComponent` A test executable with tests implemented in C++.
SwiftExecutable	`interface SwiftExecutable : SwiftBinary, ComponentWithExecutable, ComponentWithInstallation, ComponentWithOutputs` An executable built from Swift source.
SwiftXCTestExecutable	`interface SwiftXCTestExecutable : SwiftXCTestBinary, ComponentWithExecutable, ComponentWithInstallation` An XCTest executable for tests implemented in Swift.