api / org.gradle.api.file / Directory

Directory

@Incubating interface Directory : FileSystemLocation

Represents a directory at some fixed location on the file system.

Note: This interface is not intended for implementation by build script or plugin authors. An instance of this class can be created using the #dir(String) method or using various methods on ProjectLayout such as ProjectLayout#getProjectDirectory().

Since
4.1

Functions

dir

abstract fun dir(path: String): Directory

Returns a Directory whose location is the given path, resolved relative to this directory.

abstract fun dir(path: Provider<out CharSequence>): Provider<Directory>

Returns a Provider whose value is a Directory whose location is the given path resolved relative to this directory.

The return value is live and the provided path is queried each time the return value is queried.

file

abstract fun file(path: String): RegularFile

Returns a RegularFile whose location is the given path, resolved relative to this directory.

abstract fun file(path: Provider<out CharSequence>): Provider<RegularFile>

Returns a Provider whose value is a RegularFile whose location is the given path resolved relative to this directory.

The return value is live and the provided path is queried each time the return value is queried.

getAsFile

abstract fun getAsFile(): File

Returns the location of this directory, as an absolute File.

getAsFileTree

abstract fun getAsFileTree(): FileTree

Returns a FileTree that allows the files and directories contained in this directory to be queried.