Package org.gradle.api.file
Interface FileSystemLocationProperty<T extends FileSystemLocation>
- Type Parameters:
- T- The type of location.
- All Superinterfaces:
- HasConfigurableValue,- Property<T>,- Provider<T>,- SupportsConvention
- All Known Subinterfaces:
- DirectoryProperty,- RegularFileProperty
Represents some element of the file system. A file system element has two parts: its location and its content. A file system element's content, may be the output of a task
 or tasks. This property object keeps track of both the location and the task or tasks that produce the content of the element.
 
Note: This interface is not intended for implementation by build script or plugin authors.
- Since:
- 5.6
- 
Method SummaryModifier and TypeMethodDescriptionfileProvider(Provider<File> provider) Sets the location of this file, using aFileinstance.Views the location of this file as aFile.Returns the location of the file system element, and discards details of the task that produces its content.voidSets the location of this file, using aFileinstance.Methods inherited from interface org.gradle.api.provider.HasConfigurableValuedisallowChanges, disallowUnsafeRead, finalizeValueOnReadMethods inherited from interface org.gradle.api.provider.Propertyconvention, convention, finalizeValue, set, set, unset, unsetConvention, value, value
- 
Method Details- 
getAsFileViews the location of this file as aFile.
- 
set
- 
fileValueSets the location of this file, using aFileinstance.Fileinstances with relative paths are resolved relative to the project directory of the project that owns this property instance.This method is the same as set(File)but allows method chaining.- Returns:
- this
- Since:
- 6.0
 
- 
fileProviderSets the location of this file, using aFileProviderinstance.Fileinstances with relative paths are resolved relative to the project directory of the project that owns this property instance.- Returns:
- this
- Since:
- 6.0
 
- 
getLocationOnlyReturns the location of the file system element, and discards details of the task that produces its content. This allows the location, or a value derived from it, to be used as an input to some other task without implying any dependency on the producing task. This should only be used when the task does, in fact, not use the content of this file system element.- Since:
- 5.6
 
 
-