gradle/org.gradle.api.file/DirectoryProperty

DirectoryProperty

@ManagedType
interface DirectoryProperty : FileSystemLocationProperty<T> (source)

Represents some configurable directory location, whose value is mutable.

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

Since

4.3

See also

Create an instance of this as a managed property (preferred).

Create an instance of this manually.

Functions

Link copied to clipboard
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 : Any> Property<T>.assign(value: T?)

Assign value: T to a property with assign operator

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

Assign value: Provider to a property with assign operator

Link copied to clipboard
abstract fun convention(@Nullable value: @Nullable Directory): DirectoryProperty
abstract fun convention(provider: Provider<out Directory>): DirectoryProperty
Link copied to clipboard
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.
Link copied to clipboard
abstract fun disallowChanges()
Link copied to clipboard
abstract fun disallowUnsafeRead()
Link copied to clipboard
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.
Link copied to clipboard
abstract fun fileProvider(provider: Provider<File>): DirectoryProperty
Link copied to clipboard
abstract fun files(@Nullable paths: Array<@Nullable Any>): FileCollection
Returns a FileCollection containing the given files, whose locations are the given paths resolved relative to this directory, as defined by files.
Link copied to clipboard
abstract fun fileValue(@Nullable file: @Nullable File): DirectoryProperty
Link copied to clipboard
abstract fun filter(spec: Spec<in T>): Provider<T>
Link copied to clipboard
abstract fun finalizeValue()
Link copied to clipboard
abstract fun finalizeValueOnRead()
Link copied to clipboard
abstract fun <S> flatMap(transformer: Transformer<out @Nullable Provider<out S>, in T>): Provider<S>
Link copied to clipboard
abstract fun get(): T
Link copied to clipboard
abstract fun getAsFile(): Provider<File>
Link copied to clipboard
abstract fun getAsFileTree(): FileTree
Returns a FileTree that allows the files and directories contained in this directory to be queried.
Link copied to clipboard
abstract fun getLocationOnly(): Provider<T>
Link copied to clipboard
abstract fun getOrElse(defaultValue: T): T
Link copied to clipboard
abstract fun getOrNull(): @Nullable T
Link copied to clipboard
operator fun <T : Any> Property<T>.getValue(receiver: Any?, property: KProperty<*>): T

Property delegate for Property instances.

Link copied to clipboard
abstract fun isPresent(): Boolean
Link copied to clipboard
abstract fun <S> map(transformer: Transformer<out @Nullable S, in T>): Provider<S>
Link copied to clipboard
abstract fun orElse(value: T): Provider<T>
Link copied to clipboard
abstract fun set(file: @Nullable File)
Link copied to clipboard
operator fun <T : Any> Property<T>.setValue(receiver: Any?, property: KProperty<*>, value: T)

Property delegate for Property instances.

Link copied to clipboard
abstract fun unset(): Property<T>
abstract fun unset(): SupportsConvention
Link copied to clipboard
abstract fun unsetConvention(): Property<T>
abstract fun unsetConvention(): SupportsConvention
Link copied to clipboard
abstract fun value(@Nullable value: @Nullable Directory): DirectoryProperty
abstract fun value(provider: Provider<out Directory>): DirectoryProperty
Link copied to clipboard
abstract fun <U, R> zip(right: Provider<U>, combiner: BiFunction<in T, in U, out @Nullable R>): Provider<R>