gradle/org.gradle.kotlin.dsl/KotlinScript

KotlinScript

Base contract for all Gradle Kotlin DSL scripts.

This is the Kotlin flavored equivalent of org.gradle.api.Script.

It is not implemented directly by the IDE script templates to overcome ambiguous conflicts and Kotlin language limitations.

Since

6.0

Properties

logger

abstract val logger: ERROR CLASS: Symbol not found for Logger

Logger for scripts. You can use this in your script to write log messages.

logging

abstract val logging: ERROR CLASS: Symbol not found for 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.

resources

abstract 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

copy

abstract fun copy(configuration: ERROR CLASS: Symbol not found for Action<ERROR CLASS: Symbol not found for CopySpec>): ERROR CLASS: Symbol not found for WorkResult

Copies the specified files.

copySpec

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

abstract fun copySpec(configuration: ERROR CLASS: Symbol not found for Action<ERROR CLASS: Symbol not found for CopySpec>): ERROR CLASS: Symbol not found for CopySpec

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

delete

abstract fun delete(configuration: ERROR CLASS: Symbol not found for Action<ERROR CLASS: Symbol not found for DeleteSpec>): ERROR CLASS: Symbol not found for WorkResult

Deletes the specified files.

abstract fun delete(vararg paths: Any): Boolean

Deletes files and directories.

file

abstract fun file(path: Any): File

abstract 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

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

abstract fun files(paths: Any, configuration: ERROR CLASS: Symbol not found for Action<ERROR CLASS: Symbol not found for ConfigurableFileCollection>): ERROR CLASS: Symbol not found for ConfigurableFileCollection

Creates a ConfigurableFileCollection containing the given files.

fileTree

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

abstract fun fileTree(baseDir: Any, configuration: ERROR CLASS: Symbol not found for Action<ERROR CLASS: Symbol not found for ConfigurableFileTree>): ERROR CLASS: Symbol not found for ConfigurableFileTree

Creates a new ConfigurableFileTree using the given base directory.

mkdir

abstract fun mkdir(path: Any): File

Creates a directory and returns a file pointing to it.

relativePath

abstract fun relativePath(path: Any): String

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

tarTree

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

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

uri

abstract fun uri(path: Any): URI

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

zipTree

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

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