gradle/org.gradle.kotlin.dsl/KotlinSettingsScript

KotlinSettingsScript

abstract class ~~KotlinSettingsScript~~(host: KotlinScriptHost<Settings>) : SettingsScriptApi(source)

Deprecated

Will be removed in Gradle 9.0

Legacy base class for Gradle Kotlin DSL standalone Settings scripts IDE support.

See also

KotlinSettingsScriptTemplate

Constructors

KotlinSettingsScript

constructor(host: KotlinScriptHost<Settings>)

Properties

open val delegate: Settings

val ExtensionAware.extra: ExtraPropertiesExtension

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

val logger: Logger

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

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.

val resources: ResourceHandler

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

Functions

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

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

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

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.

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.

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

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

Configures the build script classpath for settings.

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

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

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

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

Copies the specified files.

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.

fun delete(vararg paths: Any): Boolean

Deletes files and directories.

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

Deletes the specified files.

dependencyResolutionManagement

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

enableFeaturePreview

open override fun enableFeaturePreview(name: String)

fun exec(configuration: ExecSpec.() -> Unit): ExecResult

Executes an external command.

fun file(path: Any): File

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

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

fun files(vararg paths: Any): ConfigurableFileCollection

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

Creates a ConfigurableFileCollection containing the given files.

fun fileTree(baseDir: Any): ConfigurableFileTree

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

Creates a new ConfigurableFileTree using the given base directory.

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

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

open override fun getBuildCache(): BuildCacheConfiguration

open override fun getBuildscript(): ScriptHandler

The ScriptHandler for this script.

open override fun getCaches(): CacheConfigurations

getDependencyResolutionManagement

open override fun getDependencyResolutionManagement(): DependencyResolutionManagement

open override fun getExtensions(): ExtensionContainer

open override fun getGradle(): Gradle

open override fun getLayout(): BuildLayout

getPluginManagement

open override fun getPluginManagement(): PluginManagementSpec

getPluginManager

open override fun getPluginManager(): PluginManager

open override fun getPlugins(): PluginContainer

open override fun getProviders(): ProviderFactory

open override fun getRootDir(): File

open override fun getRootProject(): ProjectDescriptor

open override fun getSettings(): Settings

open override fun getSettingsDir(): File

getSourceControl

open override fun getSourceControl(): SourceControl

getStartParameter

open override fun getStartParameter(): StartParameter

getToolchainManagement

open override fun getToolchainManagement(): ToolchainManagement

open fun include(vararg projectPaths: String)

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

open override fun includeBuild(rootProject: Any)

open override fun includeBuild(rootProject: Any, configuration: Action<ConfigurableIncludedBuild>)

open override fun includeFlat(vararg projectNames: String?)

open override fun includeFlat(projectNames: Iterable<String>)

fun javaexec(configuration: JavaExecSpec.() -> Unit): ExecResult

Executes an external Java process.

fun mkdir(path: Any): File

Creates a directory and returns a file pointing to it.

pluginManagement

open fun pluginManagement(block: PluginManagementSpec.() -> Unit)

Configures the plugin management for the entire build.

open override fun pluginManagement(pluginManagementSpec: Action<in PluginManagementSpec>)

open fun plugins(block: PluginDependenciesSpecScope.() -> Unit)

Configures the plugin dependencies for the project's settings.

open override fun project(projectDir: File): ProjectDescriptor

open override fun project(path: String): ProjectDescriptor

provideDelegate

operator fun Settings.provideDelegate(any: Any?, property: KProperty<*>): PropertyDelegate

Locates a property on Settings.

fun relativePath(path: Any): String

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

open override fun sourceControl(configuration: Action<in SourceControl>)

fun tarTree(tarPath: Any): FileTree

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

inline fun <T : Any> ExtensionAware.the(): T

Returns the extension of the specified type.

fun <T : Any> ExtensionAware.the(extensionType: KClass<T>): T

Returns the extension of the specified extensionType.

toolchainManagement

open override fun toolchainManagement(toolchainManagementConfiguration: Action<in ToolchainManagement>)

fun uri(path: Any): URI

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

fun zipTree(zipPath: Any): FileTree

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