gradle/org.gradle.kotlin.dsl/SettingsScriptApi

SettingsScriptApi

abstract class ~~SettingsScriptApi~~(val delegate: Settings) : SettingsDelegate(source)

Deprecated

Kept for compatibility with precompiled script plugins published with Gradle versions prior to 6.0

Replace with

import org.gradle.api.initialization.Settings

Settings

Standard implementation of the API exposed to all types of Settings scripts, precompiled and otherwise.

Inheritors

KotlinSettingsScript

Constructors

SettingsScriptApi

constructor(delegate: Settings)

Properties

buildCache

open val buildCache: BuildCacheConfiguration

buildscript

open val buildscript: ScriptHandler

caches

open val caches: CacheConfigurations

defaults

open val defaults: SharedModelDefaults

delegate

open override val delegate: Settings

dependencyResolutionManagement

open val dependencyResolutionManagement: DependencyResolutionManagement

extensions

open val extensions: ExtensionContainer

extra

val ExtensionAware.extra: ExtraPropertiesExtension

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

gradle

open val gradle: Gradle

layout

open val layout: BuildLayout

logger

val logger: Logger

Logger for settings. You can use this in your settings file to write log messages.

logging

val logging: LoggingManager

The LoggingManager which can be used to receive logging and to control the standard output/error capture for this script. 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.

pluginManagement

open val pluginManagement: PluginManagementSpec

pluginManager

open val pluginManager: PluginManager

plugins

open val plugins: PluginContainer

providers

open val providers: ProviderFactory

resources

val resources: ResourceHandler

Provides access to resource-specific utility methods, for example factory methods that create various resources.

rootDir

open val rootDir: File

rootProject

open val rootProject: ProjectDescriptor

settings

open val settings: Settings

settingsDir

open val settingsDir: File

sourceControl

open val sourceControl: SourceControl

startParameter

open val startParameter: StartParameter

toolchainManagement

open val toolchainManagement: ToolchainManagement

Functions

apply

open override fun apply(closure: Closure<Any>)

open override fun apply(options: Map<String, *>)

open override fun apply(action: Action<in ObjectConfigurationAction>)

apply

inline fun <T : Plugin<Settings>> Settings.apply()

inline fun <T : Plugin<*>> PluginAware.apply()

Applies the plugin of the given type T. Does nothing if the plugin has already been applied.

inline fun PluginAware.apply(vararg options: Pair<String, Any>)

Kotlin extension function for org.gradle.api.plugins.PluginAware.apply.

fun PluginAware.apply(from: Any? = null, plugin: String? = null, to: Any? = null)

Applies the given plugin or script.

applyTo

inline fun <T : Plugin<*>> PluginAware.applyTo(vararg targets: Any)

Applies the plugin of the given type T to the specified object. Does nothing if the plugin has already been applied.

buildCache

open override fun buildCache(action: Action<in BuildCacheConfiguration>)

buildscript

open fun buildscript(block: ScriptHandlerScope.() -> Unit)

Configures the build script classpath for settings.

caches

open override fun caches(cacheConfigurations: Action<in CacheConfigurations>)

configure

inline fun <T : Any> ExtensionAware.configure(noinline configuration: T.() -> Unit)

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

copy

fun copy(configuration: CopySpec.() -> Unit): WorkResult

Copies the specified files.

copySpec

fun copySpec(): CopySpec

fun copySpec(configuration: CopySpec.() -> Unit): CopySpec

Creates a {@link CopySpec} which can later be used to copy files or create an archive.

defaults

open override fun defaults(action: Action<in SharedModelDefaults>)

delete

fun delete(configuration: DeleteSpec.() -> Unit): WorkResult

Deletes the specified files.

fun delete(vararg paths: Any): Boolean

Deletes files and directories.

dependencyResolutionManagement

open override fun dependencyResolutionManagement(dependencyResolutionConfiguration: Action<in DependencyResolutionManagement>)

enableFeaturePreview

open override fun enableFeaturePreview(name: String)

file

fun file(path: Any): File

fun file(path: Any, validation: PathValidation): File

Resolves a file path relative to this script's target base directory.

files

fun files(vararg paths: Any): ConfigurableFileCollection

fun files(paths: Any, configuration: ConfigurableFileCollection.() -> Unit): ConfigurableFileCollection

Creates a ConfigurableFileCollection containing the given files.

fileTree

fun fileTree(baseDir: Any): ConfigurableFileTree

fun fileTree(baseDir: Any, configuration: ConfigurableFileTree.() -> Unit): ConfigurableFileTree

Creates a new ConfigurableFileTree using the given base directory.

findProject

open override fun findProject(projectDir: File): ProjectDescriptor?

open override fun findProject(path: String): ProjectDescriptor?

getBuildCache

open override fun getBuildCache(): BuildCacheConfiguration

getBuildscript

open override fun getBuildscript(): ScriptHandler

getCaches

open override fun getCaches(): CacheConfigurations

getDefaults

open override fun getDefaults(): SharedModelDefaults

getDependencyResolutionManagement

open override fun getDependencyResolutionManagement(): DependencyResolutionManagement

getExtensions

open override fun getExtensions(): ExtensionContainer

getGradle

open override fun getGradle(): Gradle

getLayout

open override fun getLayout(): BuildLayout

getPluginManagement

open override fun getPluginManagement(): PluginManagementSpec

getPluginManager

open override fun getPluginManager(): PluginManager

getPlugins

open override fun getPlugins(): PluginContainer

getProviders

open override fun getProviders(): ProviderFactory

getRootDir

open override fun getRootDir(): File

getRootProject

open override fun getRootProject(): ProjectDescriptor

getSettings

open override fun getSettings(): Settings

getSettingsDir

open override fun getSettingsDir(): File

getSourceControl

open override fun getSourceControl(): SourceControl

getStartParameter

open override fun getStartParameter(): StartParameter

getToolchainManagement

open override fun getToolchainManagement(): ToolchainManagement

include

open fun include(vararg projectPaths: String?)

Adds the given projects to the build. Each path in the supplied list is treated as the path of a project to add to the build. Note that these path are not file paths, but instead specify the location of the new project in the project hierarchy. As such, the supplied paths must use the ':' character as separator (and NOT '/').

open override fun include(projectPaths: Iterable<String>)

includeBuild