gradle/org.gradle.api.file/DirectoryProperty

DirectoryProperty

interface DirectoryProperty : FileSystemLocationProperty<T> (source)

Represents some configurable directory location, whose value is mutable.

You can create a DirectoryProperty using directoryProperty.

Note: This interface is not intended for implementation by build script or plugin authors.

Since

4.3

Functions

assign

fun <T : FileSystemLocation> FileSystemLocationProperty<T>.assign(file: File?)

Assign file to a FileSystemLocationProperty with assign operator

fun <T : FileSystemLocation> FileSystemLocationProperty<T>.assign(provider: Provider<File?>)

Assign file provided by a Provider to a FileSystemLocationProperty with assign operator

fun <T> Property<T>.assign(value: T?)

Assign value: T to a property with assign operator

fun <T> Property<T>.assign(value: Provider<out T?>)

Assign value: Provider to a property with assign operator

convention

abstract fun convention(@Nullable value: Directory): DirectoryProperty

abstract fun convention(provider: Provider<out Directory>): DirectoryProperty

dir

abstract fun dir(path: String): Provider<Directory>

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

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

disallowChanges

abstract fun disallowChanges()

disallowUnsafeRead

abstract fun disallowUnsafeRead()

file

abstract fun file(path: String): Provider<RegularFile>

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

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

fileProvider

abstract fun fileProvider(provider: Provider<File>): DirectoryProperty

files

abstract fun files(paths: Array<Any>): FileCollection

Returns a FileCollection containing the given files, whose locations are the given paths resolved relative to this directory, as defined by files.

fileValue

abstract fun fileValue(@Nullable file: File): DirectoryProperty

filter

abstract fun filter(spec: Spec<in T>): Provider<T>

finalizeValue

abstract fun finalizeValue()

finalizeValueOnRead

abstract fun finalizeValueOnRead()

flatMap

abstract fun <S> flatMap(transformer: Transformer<out @Nullable Provider<out S>, in T>): Provider<S>

forUseAtConfigurationTime

abstract fun forUseAtConfigurationTime(): Provider<T>

get

abstract fun get(): T

getAsFile

abstract fun getAsFile(): Provider<File>

getAsFileTree

abstract fun getAsFileTree(): FileTree

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

getLocationOnly

abstract fun getLocationOnly(): Provider<T>

getOrElse

abstract fun getOrElse(defaultValue: T): T

getOrNull

abstract fun getOrNull(): T

getValue

operator fun <T> Property<T>.getValue(receiver: Any?, property: KProperty<*>): T

Property delegate for Property instances.

isPresent

abstract fun isPresent(): Boolean

map

abstract fun <S> map(transformer: Transformer<out @Nullable S, in T>): Provider<S>

orElse

abstract fun orElse(value: T): Provider<T>

set

abstract fun set(file: File)

setValue

operator fun <T> Property<T>.setValue(receiver: Any?, property: KProperty<*>, value: T)

Property delegate for Property instances.

unset

abstract fun unset(): Property<T>

abstract fun unset(): SupportsConvention

unsetConvention

abstract fun unsetConvention(): Property<T>

abstract fun unsetConvention(): SupportsConvention

value

abstract fun value(@Nullable value: Directory): DirectoryProperty

abstract fun value(provider: Provider<out Directory>): DirectoryProperty

zip

abstract fun <U, R> zip(right: Provider<U>, combiner: BiFunction<in T, in U, out @Nullable R>): Provider<R>