gradle/org.gradle.kotlin.dsl/SettingsScriptApi

SettingsScriptApi

abstract class ~~SettingsScriptApi~~(val delegate: ERROR CLASS: Symbol not found for 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: ERROR CLASS: Symbol not found for Settings)

Properties

delegate

open override val delegate: ERROR CLASS: Symbol not found for Settings

logger

val logger: ERROR CLASS: Symbol not found for Logger

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

logging

val logging: ERROR CLASS: Symbol not found for ConfigurableFileCollection

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.

resources

val resources: ERROR CLASS: Symbol not found for ResourceHandler

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

Functions

apply

open fun apply(action: org/gradle/api/Action<in org/gradle/api/plugins/ObjectConfigurationAction>)

open fun apply(closure: Closure<Any>)

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

buildCache

open fun buildCache(action: org/gradle/api/Action<in org/gradle/caching/configuration/BuildCacheConfiguration>)

buildscript

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

Configures the build script classpath for settings.

caches

open fun caches(cacheConfigurations: org/gradle/api/Action<in org/gradle/api/cache/CacheConfigurations>)

copy

fun copy(configuration: ERROR CLASS: Symbol not found for CopySpec.() -> Unit): ERROR CLASS: Symbol not found for WorkResult

Copies the specified files.

copySpec

fun copySpec(): ERROR CLASS: Symbol not found for CopySpec

fun copySpec(configuration: ERROR CLASS: Symbol not found for CopySpec.() -> Unit): ERROR CLASS: Symbol not found for CopySpec

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

defaults

open fun defaults(action: org/gradle/api/Action<in org/gradle/api/initialization/SharedModelDefaults>)

delete

fun delete(configuration: ERROR CLASS: Symbol not found for DeleteSpec.() -> Unit): ERROR CLASS: Symbol not found for WorkResult

Deletes the specified files.

fun delete(vararg paths: Any): Boolean

Deletes files and directories.

dependencyResolutionManagement

open fun dependencyResolutionManagement(dependencyResolutionConfiguration: org/gradle/api/Action<in org/gradle/api/initialization/resolve/DependencyResolutionManagement>)

enableFeaturePreview

open fun enableFeaturePreview(name: String)

file

fun file(path: Any): File

fun file(path: Any, validation: ERROR CLASS: Symbol not found for PathValidation): File

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

files

fun files(vararg paths: Any): ERROR CLASS: Symbol not found for ConfigurableFileCollection

fun files(paths: Any, configuration: ERROR CLASS: Symbol not found for ConfigurableFileCollection.() -> Unit): ERROR CLASS: Symbol not found for ConfigurableFileCollection

Creates a ConfigurableFileCollection containing the given files.

fileTree

fun fileTree(baseDir: Any): ERROR CLASS: Symbol not found for ConfigurableFileTree

fun fileTree(baseDir: Any, configuration: ERROR CLASS: Symbol not found for ConfigurableFileTree.() -> Unit): ERROR CLASS: Symbol not found for ConfigurableFileTree

Creates a new ConfigurableFileTree using the given base directory.

findProject

open fun findProject(projectDir: File): org/gradle/api/initialization/ProjectDescriptor??

open fun findProject(path: String): org/gradle/api/initialization/ProjectDescriptor??

getBuildCache

open fun getBuildCache(): org/gradle/caching/configuration/BuildCacheConfiguration

getBuildscript

open fun getBuildscript(): org/gradle/api/initialization/dsl/ScriptHandler

getCaches

open fun getCaches(): org/gradle/api/cache/CacheConfigurations

getDefaults

open fun getDefaults(): org/gradle/api/initialization/SharedModelDefaults

getDependencyResolutionManagement

open fun getDependencyResolutionManagement(): org/gradle/api/initialization/resolve/DependencyResolutionManagement

getExtensions

open fun getExtensions(): org/gradle/api/plugins/ExtensionContainer

getGradle

open fun getGradle(): org/gradle/api/invocation/Gradle

getLayout

open fun getLayout(): org/gradle/api/file/BuildLayout

getPluginManagement

open fun getPluginManagement(): org/gradle/plugin/management/PluginManagementSpec

getPluginManager

open fun getPluginManager(): org/gradle/api/plugins/PluginManager

getPlugins

open fun getPlugins(): org/gradle/api/plugins/PluginContainer

getProviders

open fun getProviders(): org/gradle/api/provider/ProviderFactory

getRootDir

open fun getRootDir(): File

getRootProject

open fun getRootProject(): org/gradle/api/initialization/ProjectDescriptor

getSettings

open fun getSettings(): org/gradle/api/initialization/Settings

getSettingsDir

open fun getSettingsDir(): File

getSourceControl

open fun getSourceControl(): org/gradle/vcs/SourceControl

getStartParameter

open fun getStartParameter(): org/gradle/StartParameter

getToolchainManagement

open fun getToolchainManagement(): org/gradle/api/toolchain/management/ToolchainManagement

include

open fun include(projectPaths: Iterable<String>)

includeBuild

open fun includeBuild(rootProject: Any)

open fun includeBuild(rootProject: Any, configuration: org/gradle/api/Action<org/gradle/api/initialization/ConfigurableIncludedBuild>)

includeFlat

open fun includeFlat(projectNames: Iterable<String>)

open fun includeFlat(vararg projectNames: String)

mkdir

fun mkdir(path: Any): File

Creates a directory and returns a file pointing to it.

pluginManagement

open fun pluginManagement(block: ERROR CLASS: Symbol not found for PluginManagementSpec.() -> Unit)

Configures the plugin management for the entire build.

open fun pluginManagement(pluginManagementSpec: org/gradle/api/Action<in org/gradle/plugin/management/PluginManagementSpec>)

project

open fun project(projectDir: File): org/gradle/api/initialization/ProjectDescriptor

open fun project(path: String): org/gradle/api/initialization/ProjectDescriptor

relativePath

fun relativePath(path: Any): String

Returns the relative path from this script's target base directory to the given path.

sourceControl

open fun sourceControl(configuration: org/gradle/api/Action<in org/gradle/vcs/SourceControl>)

tarTree

fun tarTree(tarPath: Any): ERROR CLASS: Symbol not found for FileTree

Creates a new FileTree which contains the contents of the given TAR file.

toolchainManagement

open fun toolchainManagement(toolchainManagementConfiguration: org/gradle/api/Action<in org/gradle/api/toolchain/management/ToolchainManagement>)

uri

fun uri(path: Any): URI

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

zipTree

fun zipTree(zipPath: Any): ERROR CLASS: Symbol not found for FileTree

Creates a new FileTree which contains the contents of the given ZIP file.