gradle/org.gradle.api.file/DirectoryProperty

DirectoryProperty

@ManagedType
interface DirectoryProperty : FileSystemLocationProperty<Directory> (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
abstract fun convention(@Nullable value: @Nullable Directory): DirectoryProperty
Specifies the value to use as the convention (default value) for this property.
abstract fun convention(provider: Provider<out Directory>): DirectoryProperty
Specifies the provider to be used to query the convention (default value) for this property.
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()
Disallows further direct changes to this object.
Link copied to clipboard
abstract fun disallowUnsafeRead()
Disallows reading the value of this object when its value may not yet be available or may still change.
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
Sets the location of this file, using a instance.
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
Sets the location of this file, using a instance.
Link copied to clipboard
@Incubating
abstract fun filter(spec: Spec<in T>): Provider<T>
Returns a new Provider with the value of this provider if the passed spec is satisfied and no value otherwise.
Link copied to clipboard
abstract fun finalizeValue()
Disallows further changes to the value of this property.
Link copied to clipboard
abstract fun finalizeValueOnRead()
Requests that the final value of this object be calculated on the next read of the value, if not already known.
Link copied to clipboard
abstract fun <S> flatMap(transformer: Transformer<out @Nullable Provider<out S>, in T>): Provider<S>
Returns a new Provider from the value of this provider transformed using the given function.
Link copied to clipboard
abstract fun get(): T
Returns the value of this provider if it has a value present, otherwise throws java.lang.IllegalStateException.
Link copied to clipboard
abstract fun getAsFile(): Provider<File>
Views the location of this file as a 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>
Returns the location of the file system element, and discards details of the task that produces its content.
Link copied to clipboard
abstract fun getOrElse(defaultValue: T): T
Returns the value of this provider if it has a value present.
Link copied to clipboard
@Nullable
abstract fun getOrNull(): @Nullable T
Returns the value of this provider if it has a value present.
Link copied to clipboard
abstract fun isPresent(): Boolean
Returns true if there is a value present, otherwise false.
Link copied to clipboard
abstract fun <S> map(transformer: Transformer<out @Nullable S, in T>): Provider<S>
Returns a new Provider whose value is the value of this provider transformed using the given function.
Link copied to clipboard
abstract fun orElse(value: T): Provider<T>
Returns a Provider whose value is the value of this provider, if present, otherwise the given default value.
abstract fun orElse(provider: Provider<out T>): Provider<T>
Returns a Provider whose value is the value of this provider, if present, otherwise uses the value from the given provider, if present.
Link copied to clipboard
abstract fun set(@Nullable file: @Nullable File)
Sets the location of this file, using a File instance.
abstract fun set(@Nullable value: @Nullable T)
Sets the value of the property to the given value, replacing whatever value the property already had.
abstract fun set(provider: Provider<out T>)
Sets the property to have the same value as the given provider, replacing whatever value the property already had.
Link copied to clipboard
abstract fun unset(): Property<T>
abstract fun unset(): SupportsConvention
Unsets this object's explicit value, allowing the convention to be selected when evaluating this object's value.
Link copied to clipboard
abstract fun unsetConvention(): Property<T>
abstract fun unsetConvention(): SupportsConvention
Unsets this object's convention value.
Link copied to clipboard
abstract fun value(@Nullable value: @Nullable Directory): DirectoryProperty
Sets the value of the property to the given value, replacing whatever value the property already had.
abstract fun value(provider: Provider<out Directory>): DirectoryProperty
Sets the property to have the same value as the given provider, replacing whatever value the property already had.
Link copied to clipboard
abstract fun <U, R> zip(right: Provider<U>, combiner: BiFunction<in T, in U, out @Nullable R>): Provider<R>
Returns a provider which value will be computed by combining this provider value with another provider value using the supplied combiner function.
Generated by Dokka
Gradle Kotlin DSL Reference