All Implemented Interfaces:: org.gradle.api.Named , org.gradle.api.attributes.HasAttributes


public final class Framework
extends AbstractNativeLibrary implements HasAttributes

Nested Class Summary

Nested Classes
Modifier and Type	Class	Description
`public class`	`Framework.BitcodeEmbeddingMode`
`public class`	`Framework.Companion`

Field Summary

Fields
Modifier and Type	Field	Description
`private final NativeOutputKind`	`outputKind`
`private BitcodeEmbeddingMode`	`embedBitcode`
`private Boolean`	`isStatic`
`private final String`	`exportConfigurationName`
`private Boolean`	`transitiveExport`
`private String`	`baseName`
`private final KotlinNativeTarget`	`target`
`private final Project`	`project`
`private Boolean`	`debuggable`
`private Boolean`	`optimized`
`private List<String>`	`linkerOpts`
`private Map<String, String>`	`binaryOptions`
`private List<String>`	`freeCompilerArgs`
`private final String`	`linkTaskName`
`private final KotlinNativeLink`	`linkTask`
`private final TaskProvider<out KotlinNativeLink>`	`linkTaskProvider`
`private File`	`outputDirectory`
`private final File`	`outputFile`
`private final NativeBuildType`	`buildType`
`private transient KotlinNativeCompilation`	`compilation`

Constructor Summary

Constructors
Constructor	Description
`Framework(String name, String baseName, NativeBuildType buildType, KotlinNativeCompilation compilation)`

Enum Constant Summary

Enum Constants
Enum Constant	Description

Method Summary

Modifier and Type	Method	Description
`NativeOutputKind`	`getOutputKind()`
`final BitcodeEmbeddingMode`	`getEmbedBitcode()`	Embed bitcode for the framework or not.
`final Unit`	`setEmbedBitcode(BitcodeEmbeddingMode embedBitcode)`	Embed bitcode for the framework or not.
`final Boolean`	`getIsStatic()`	Specifies if the framework is linked as a static library (false by default).
`final Unit`	`setIsStatic(Boolean isStatic)`
`final String`	`getExportConfigurationName()`
`final Boolean`	`getTransitiveExport()`
`final Unit`	`setTransitiveExport(Boolean transitiveExport)`
`String`	`getBaseName()`
`Unit`	`setBaseName(String baseName)`
`final KotlinNativeTarget`	`getTarget()`
`final Project`	`getProject()`
`final Boolean`	`getDebuggable()`
`final Unit`	`setDebuggable(Boolean debuggable)`
`final Boolean`	`getOptimized()`
`final Unit`	`setOptimized(Boolean optimized)`
`final List<String>`	`getLinkerOpts()`	Additional options passed to the linker by the Kotlin/Native compiler.
`final Unit`	`setLinkerOpts(List<String> linkerOpts)`	Additional options passed to the linker by the Kotlin/Native compiler.
`final Map<String, String>`	`getBinaryOptions()`
`final Unit`	`setBinaryOptions(Map<String, String> binaryOptions)`
`final List<String>`	`getFreeCompilerArgs()`
`final Unit`	`setFreeCompilerArgs(List<String> freeCompilerArgs)`
`final String`	`getLinkTaskName()`
`final KotlinNativeLink`	`getLinkTask()`
`final TaskProvider<out KotlinNativeLink>`	`getLinkTaskProvider()`
`final File`	`getOutputDirectory()`
`final Unit`	`setOutputDirectory(File outputDirectory)`
`final File`	`getOutputFile()`
`final NativeBuildType`	`getBuildType()`
`final KotlinNativeCompilation`	`getCompilation()`
`final Unit`	`setCompilation(KotlinNativeCompilation compilation)`
`HierarchyAttributeContainer`	`getAttributes()`
`final Unit`	`embedBitcode(BitcodeEmbeddingMode mode)`	Enable or disable embedding bitcode for the framework.
`final Unit`	`embedBitcode(String mode)`	Enable or disable embedding bitcode for the framework.

Methods inherited from class org.jetbrains.kotlin.gradle.plugin.mpp.Framework
export, export, export
Methods inherited from class org.jetbrains.kotlin.gradle.plugin.mpp.AbstractNativeLibrary
binaryOption, getName, linkerOpts, linkerOpts
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Framework

Framework(String name, String baseName, NativeBuildType buildType, KotlinNativeCompilation compilation)

Method Detail

getOutputKind
```
 NativeOutputKind getOutputKind()
```

getEmbedBitcode
```
 final BitcodeEmbeddingMode getEmbedBitcode()
```
Embed bitcode for the framework or not. See BitcodeEmbeddingMode.

setEmbedBitcode
```
 final Unit setEmbedBitcode(BitcodeEmbeddingMode embedBitcode)
```
Embed bitcode for the framework or not. See BitcodeEmbeddingMode.

getIsStatic
```
 final Boolean getIsStatic()
```
Specifies if the framework is linked as a static library (false by default). Note: Cocoapods plugin links frameworks as a static library by default!

setIsStatic

 final Unit setIsStatic(Boolean isStatic)

getExportConfigurationName

 final String getExportConfigurationName()

getTransitiveExport
```
 final Boolean getTransitiveExport()
```

setTransitiveExport

 final Unit setTransitiveExport(Boolean transitiveExport)

getBaseName
```
 String getBaseName()
```

setBaseName
```
 Unit setBaseName(String baseName)
```

getTarget
```
 final KotlinNativeTarget getTarget()
```

getProject
```
 final Project getProject()
```

getDebuggable
```
 final Boolean getDebuggable()
```

setDebuggable

 final Unit setDebuggable(Boolean debuggable)

getOptimized
```
 final Boolean getOptimized()
```

setOptimized

 final Unit setOptimized(Boolean optimized)

getLinkerOpts
```
 final List<String> getLinkerOpts()
```
Additional options passed to the linker by the Kotlin/Native compiler.

setLinkerOpts
```
 final Unit setLinkerOpts(List<String> linkerOpts)
```
Additional options passed to the linker by the Kotlin/Native compiler.

getBinaryOptions

 final Map<String, String> getBinaryOptions()

setBinaryOptions

 final Unit setBinaryOptions(Map<String, String> binaryOptions)

getFreeCompilerArgs

 final List<String> getFreeCompilerArgs()

setFreeCompilerArgs

 final Unit setFreeCompilerArgs(List<String> freeCompilerArgs)

getLinkTaskName
```
 final String getLinkTaskName()
```

getLinkTask
```
 final KotlinNativeLink getLinkTask()
```

getLinkTaskProvider

 final TaskProvider<out KotlinNativeLink> getLinkTaskProvider()

getOutputDirectory
```
 final File getOutputDirectory()
```

setOutputDirectory

 final Unit setOutputDirectory(File outputDirectory)

getOutputFile
```
 final File getOutputFile()
```

getBuildType
```
 final NativeBuildType getBuildType()
```

getCompilation

 final KotlinNativeCompilation getCompilation()

setCompilation
```
 final Unit setCompilation(KotlinNativeCompilation compilation)
```
Parameters:
compilation -
- a compilation used to produce this binary.

getAttributes

 HierarchyAttributeContainer getAttributes()

embedBitcode
```
 final Unit embedBitcode(BitcodeEmbeddingMode mode)
```
Enable or disable embedding bitcode for the framework. See BitcodeEmbeddingMode.

embedBitcode

 final Unit embedBitcode(String mode)

Enable or disable embedding bitcode for the framework. The parameter mode is one of the following string constants:

    disable - Don't embed LLVM IR bitcode.
    bitcode - Embed LLVM IR bitcode as data.
              Has the same effect as the -Xembed-bitcode command line option.
    marker - Embed placeholder LLVM IR data as a marker.
             Has the same effect as the -Xembed-bitcode-marker command line option.

Class Framework

Nested Class Summary

Field Summary

Constructor Summary

Enum Constant Summary

Method Summary

Methods inherited from class org.jetbrains.kotlin.gradle.plugin.mpp.Framework

Methods inherited from class org.jetbrains.kotlin.gradle.plugin.mpp.AbstractNativeLibrary

Methods inherited from class java.lang.Object

Constructor Detail

Framework

Method Detail

getOutputKind

getEmbedBitcode

setEmbedBitcode

getIsStatic

setIsStatic

getExportConfigurationName

getTransitiveExport

setTransitiveExport

getBaseName

setBaseName

getTarget

getProject

getDebuggable

setDebuggable

getOptimized

setOptimized

getLinkerOpts

setLinkerOpts

getBinaryOptions

setBinaryOptions

getFreeCompilerArgs

setFreeCompilerArgs

getLinkTaskName

getLinkTask

getLinkTaskProvider

getOutputDirectory

setOutputDirectory

getOutputFile

getBuildType

getCompilation

setCompilation

getAttributes

embedBitcode

embedBitcode