FileSystemOperations (Grolifant Core API)

```
public interface FileSystemOperations
```
Abstracts a number of file operations.
Also Acts as a proxy for the FileSystemOperations that was implemented in Gradle 6.0, but allows for a substitute operation on old Gradle versions.
Since:
1.3

Methods Summary

Methods
Type Params	Return Type	Name and description
	`public Provider<File>`	`buildDirDescendant(Object stringy)` Safely resolve the stringy item as a path relative to the build directory.
	`public ReadableResource`	`bzip2Resource(Object file)` Creates resource that points to a bzip2 compressed file at the given path.
	`public WorkResult`	`copy(Action<? super CopySpec> action)` Copies the specified files.
	`public void`	`copyResourceToFile(String resourcePath, File destFile)` Copies the file at the resource path to a local file.
	`public CopySpec`	`copySpec()` Creates an empty CopySpec
	`public CopySpec`	`copySpec(Action<? super CopySpec> action)` Creates a copy specification and configures it.
	`public CopySpec`	`copySpec(groovy.lang.Closure<?> action)` Creates a copy specification and configures it.
	`public File`	`createTempDirectory(String prefix)` Creates a temporary directory with the given prefix.
	`public WorkResult`	`delete(Action<? super DeleteSpec> action)` Deletes the specified files.
	`public ConfigurableFileCollection`	`emptyFileCollection()` Creates an empty file collection.
	`public File`	`file(Object file)` Converts a file-like object to a File instance with project context.
	`public File`	`fileOrNull(Object file)` Similar to { Link: #file}, but does not throw an exception if the object is `null` or an empty provider.
	`public ConfigurableFileTree`	`fileTree(Object file)` Obtain a file tree given a starting location
	`public ConfigurableFileCollection`	`files(java.util.Collection<?> files)` Converts a file-like objects to File instances with project context.
	`public ConfigurableFileCollection`	`filesDropNull(java.util.Collection<?> files)` Converts a file-like objects to File instances with project context.
	`public Provider<File>`	`getGradleHomeDir()` Gradle distribution home directory.
	`public Provider<File>`	`getGradleUserHomeDir()` Gradle user home directory.
	`public File`	`getProjectCacheDir()` Returns the project's local cache directory
	`public File`	`getProjectDir()` Returns the project directory.
	`public File`	`getProjectRootDir()` The project root dir.
	`public ReadableResource`	`gzipResource(Object file)` Creates resource that points to a gzip compressed file at the given path.
	`public java.util.List<File>`	`listDirs(File distDir)` Provides a list of directories below another directory
	`public java.util.Properties`	`loadPropertiesFromResource(String resourcePath)` Loads properties from a resource file.
	`public java.util.Properties`	`loadPropertiesFromResource(String resourcePath, ClassLoader classLoader)` Loads properties from a resource file.
	`public Provider<File>`	`provideFile(Object file)` Like file, but does not immediately evaluate the passed parameter.
	`public Provider<File>`	`provideProjectCacheDir()` Like getProjectCacheDir(), but returns a provider instead.
	`public Provider<File>`	`provideProjectCacheDirDescendant(Object subpath)` Provides a subpath below the project's cache directory.
	`public Provider<File>`	`provideProjectDir()` Like getProjectDir(), but returns a provider instead.
	`public Provider<java.util.Properties>`	`providePropertiesFromResource(String resourcePath)` Lazy-load properties from a resource file.
	`public Provider<java.util.Properties>`	`providePropertiesFromResource(String resourcePath, ClassLoader classLoader)` Lazy-load properties from a resource file.
	`public Provider<File>`	`provideRootDir()` The root directory of the project.
	`public String`	`relativePath(Object f)` Returns the relative path from the project directory to the given path.
	`public String`	`relativePathNotEmpty(Object f)` Returns a relative path from the project directory to the given path.
	`public String`	`relativePathToProjectDir(Object f)` Returns the relative path from the given path to the project directory.
	`public String`	`relativePathToRootDir(Object f)` Returns the relative path from the given path to the root project directory.
	`public String`	`relativeRootPath(Object f)` Returns the relative path from the root project directory to the given path.
	`public String`	`relativize(File base, File target)` Returns the path of one File relative to another.
	`public String`	`relativize(java.nio.file.Path base, java.nio.file.Path target)` Returns the path of one Path relative to another.
	`public FileTree`	`resolveFilesFromCopySpec(CopySpec copySpec)` Given a { Link: CopySpec}, resolve all of the input files in to a collection.
	`public WorkResult`	`sync(Action<? super CopySpec> action)` Synchronizes the contents of a destination directory with some source directories and files.
	`public FileTree`	`tarTree(Object tarPath)` Expands a tar file into a FileTree.
	`public File`	`toSafeFile(String parts)` Converts a collection of String into a {@ link: File
	`public String`	`toSafeFileName(String name)` Converts a string into a string that is safe to use as a file name.
	`public java.nio.file.Path`	`toSafePath(String parts)` Converts a collection of String into a java.nio.file.Path with all parts guarantee to be safe file parts
	`public void`	`updateFileProperty(Property<File> provider, Object file)` Updates a `Property<File>`.
	`public FileTree`	`zipTree(Object zipPath)` Expands a ZIP file into a FileTree.

- Method Detail
  - public Provider<File> buildDirDescendant(Object stringy)
    
    Safely resolve the stringy item as a path relative to the build directory.
    Parameters:
    stringy - Any item that can be resolved to a string using org.ysb33r.grolifant5.core.api.grolifant.StringTools#stringize.
    Returns:
    Provider to a file
    Since:
    5.0
  - public ReadableResource bzip2Resource(Object file)
    
    Creates resource that points to a bzip2 compressed file at the given path.
    Parameters:
    file - File evaluated as per file.
    Returns:
    Readable resource
  - public WorkResult copy(Action<? super CopySpec> action)
    
    Copies the specified files.
    Parameters:
    action - Configures a CopySpec
    Returns:
    Result of copy to check whether it was successful.
  - public void copyResourceToFile(String resourcePath, File destFile)
    
    Copies the file at the resource path to a local file.
    throws:
    org.gradle.api.resources.ResourceException
    
    Parameters:
    resourcePath - Resource path.
    destFile - Destination file.
    Since:
    5.0
  - public CopySpec copySpec()
    
    Creates an empty CopySpec
    Returns:
    Empty copy specification.
    Since:
    5.1
  - public CopySpec copySpec(Action<? super CopySpec> action)
    
    Creates a copy specification and configures it.
    Parameters:
    action - Configurator for copy specification
    Returns:
    Configured copy specification
  - public CopySpec copySpec(@groovy.lang.DelegatesTo(CopySpec.class) groovy.lang.Closure<?> action)
    
    Creates a copy specification and configures it.
    Parameters:
    action - Configurator for copy specification
    Returns:
    Configured copy specification
  - public File createTempDirectory(String prefix)
    
    Creates a temporary directory with the given prefix.
    Directory will be set to delete on VM exit, but consumers are allowed to delete earlier.
    The directory will be created somewhere in the build directory.
    Parameters:
    prefix - Prefix for directory.
    Returns:
    Directory
    Since:
    2.0
  - public WorkResult delete(Action<? super DeleteSpec> action)
    
    Deletes the specified files.
    Parameters:
    action - Configures a DeleteSpec
    Returns:
    Result of deletion to check whether it was successful.
  - public ConfigurableFileCollection emptyFileCollection()
    
    Creates an empty file collection.
    Returns:
    Empty file collection.
    Since:
    2.0
  - public File file(Object file)
    
    Converts a file-like object to a File instance with project context.
    Converts any of the following recursively until it gets to a file:
    - CharSequence including String and GString.
    - File.
    - java.nio.file.Path is it is associated with the default provider
    - URLs and URis of file: schemes.
    - Groovy Closures.
    - java.util.concurrent.Callable.
    - Provider.
    - Directory (Gradle 4.1+)
    - TextResource
    Parameters:
    file - Potential File object
    Returns:
    File instance.
  - public File fileOrNull(Object file)
    
    Similar to {
    Link:
    #file}, but does not throw an exception if the object is null or an empty provider.
    
    Parameters:
    file - Potential File object
    Returns:
    File instance or null.
  - public ConfigurableFileTree fileTree(Object file)
    
    Obtain a file tree given a starting location
    Parameters:
    file - Starting location. Anything convertible with file will do.
    Returns:
    File tree
    Since:
    5.0
  - public ConfigurableFileCollection files(java.util.Collection<?> files)
    
    Converts a file-like objects to File instances with project context.
    Converts collections of the following recursively until it gets to a file:
    - CharSequence including String and GString.
    - File.
    - java.nio.file.Path is it is associated with the default provider
    - URLs and URis of file: schemes.
    - Groovy Closures.
    - java.util.concurrent.Callable.
    - Provider.
    - Directory
    - TextResource
    Collections are flattened. Null instances are not allowed.
    Parameters:
    files - Potential File objects
    Returns:
    File collection.
  - public ConfigurableFileCollection filesDropNull(java.util.Collection<?> files)
    
    Converts a file-like objects to File instances with project context.
    Converts collections of the following recursively until it gets to a file:
    - CharSequence including String and GString.
    - File.
    - java.nio.file.Path is it is associated with the default provider
    - URLs and URis of file: schemes.
    - Groovy Closures.
    - java.util.concurrent.Callable.
    - Provider.
    - Directory
    - TextResource
    Collections are flattened. Null instances are removed.
    Parameters:
    files - Potential File objects
    Returns:
    File collection.
  - public Provider<File> getGradleHomeDir()
    
    Gradle distribution home directory.
    Returns:
    Directory.
    Since:
    5.0
  - public Provider<File> getGradleUserHomeDir()
    
    Gradle user home directory. Usually ~/.gradle on non -Windows.
    Returns:
    Directory.
    Since:
    5.0
  - public File getProjectCacheDir()
    
    Returns the project's local cache directory
    Returns:
    Project cache directory.
    Since:
    5.0
  - public File getProjectDir()
    
    Returns the project directory.
    Returns:
    Project directory.
    Since:
    5.0
  - public File getProjectRootDir()
    
    The project root dir.
    Returns:
    Root directory.
    Since:
    5.0
  - public ReadableResource gzipResource(Object file)
    
    Creates resource that points to a gzip compressed file at the given path.
    Parameters:
    file - File evaluated as per file.
    Returns:
    Readable resource
  - public java.util.List<File> listDirs(File distDir)
    
    Provides a list of directories below another directory
    Parameters:
    distDir - Directory
    Returns:
    List of directories. Can be empty if, but never null supplied directory.
  - public java.util.Properties loadPropertiesFromResource(String resourcePath)
    
    Loads properties from a resource file.
    throws:
    org.ysb33r.grolifant5.api.errors.ResourceAccessException when resource if not available.
    
    Parameters:
    resourcePath - Resource path.
    Returns:
    Properties
    Since:
    5.0
  - public java.util.Properties loadPropertiesFromResource(String resourcePath, ClassLoader classLoader)
    
    Loads properties from a resource file.
    throws:
    org.ysb33r.grolifant5.api.errors.ResourceAccessException when resource if not available.
    
    Parameters:
    resourcePath - Resource path.
    classLoader - Classloader to use for loading the content.
    Returns:
    Properties
    Since:
    5.0
  - public Provider<File> provideFile(Object file)
    
    Like file, but does not immediately evaluate the passed parameter.
    Parameters:
    file - Potential File object
    Returns:
    A provider that will evaluate to a file.
    Since:
    5.0
  - public Provider<File> provideProjectCacheDir()
    
    Like getProjectCacheDir(), but returns a provider instead.
    Returns:
    Provider to the project's cache directory.
    Since:
    5.0
  - public Provider<File> provideProjectCacheDirDescendant(Object subpath)
    
    Provides a subpath below the project's cache directory. Anything that can evaluater to a string using StringTools.
    Returns:
    Provider to a file or directory below the project's cache directory.
    Since:
    5.0
  - public Provider<File> provideProjectDir()
    
    Like getProjectDir(), but returns a provider instead.
    Returns:
    Provider to the project directory.
    Since:
    5.0
  - public Provider<java.util.Properties> providePropertiesFromResource(String resourcePath)
    
    Lazy-load properties from a resource file.
    throws:
    org.ysb33r.grolifant5.api.errors.ResourceAccessException when resource if not available.
    
    Parameters:
    resourcePath - Resource path.
    Returns:
    Provider to properties.
    Since:
    5.0
  - public Provider<java.util.Properties> providePropertiesFromResource(String resourcePath, ClassLoader classLoader)
    
    Lazy-load properties from a resource file.
    throws:
    org.ysb33r.grolifant5.api.errors.ResourceAccessException when resource if not available.
    
    Parameters:
    resourcePath - Resource path.
    classLoader - Classloader to use for loading the resource.
    Returns:
    Provider to properties.
    Since:
    5.0
  - public Provider<File> provideRootDir()
    
    The root directory of the project.
    Returns:
    Provider to the root directory.
    Since:
    5.0
  - public String relativePath(Object f)
    
    Returns the relative path from the project directory to the given path.
    Parameters:
    f - Object that is resolvable to a file within project context
    Returns:
    Relative path. Never null.
  - public String relativePathNotEmpty(Object f)
    
    Returns a relative path from the project directory to the given path. When the path is empty, return a dot
    Parameters:
    f - Object that is resolvable to a file within project context
    Returns:
    Relative path. Never null. Will at minimum contain a dot.
    Since:
    2.0
  - public String relativePathToProjectDir(Object f)
    
    Returns the relative path from the given path to the project directory.
    Parameters:
    f - Object that is resolvable to a file within project context
    Returns:
    Relative path. Never null.
  - public String relativePathToRootDir(Object f)
    
    Returns the relative path from the given path to the root project directory.
    Parameters:
    f - Object that is resolvable to a file within project context
    Returns:
    Relative path. Never null.
  - public String relativeRootPath(Object f)
    
    Returns the relative path from the root project directory to the given path.
    Parameters:
    f - Object that is resolvable to a file within project context
    Returns:
    Relative path. Never null.
  - public String relativize(File base, File target)
    
    Returns the path of one File relative to another.
    throws:
    IOException if an error occurs while resolving the files' canonical names.
    
    Parameters:
    target - the target directory
    base - the base directory
    Returns:
    target's path relative to the base directory
    Since:
    2.0
  - public String relativize(java.nio.file.Path base, java.nio.file.Path target)
    
    Returns the path of one Path relative to another.
    throws:
    IOException if an error occurs while resolving the files' canonical names.
    
    Parameters:
    target - the target directory
    base - the base directory
    Returns:
    target's path relative to the base directory
    Since:
    2.0
  - public FileTree resolveFilesFromCopySpec(CopySpec copySpec)
    
    Given a {
    Link:
    CopySpec}, resolve all of the input files in to a collection.
    
    Parameters:
    copySpec - Input specification
    Returns:
    Collection of files.
    Since:
    2.0
  - public WorkResult sync(Action<? super CopySpec> action)
    
    Synchronizes the contents of a destination directory with some source directories and files.
    Parameters:
    action - Action to configure the CopySpec.
    Returns:
    WorkResult that can be used to check if the sync did any work.
  - public FileTree tarTree(Object tarPath)
    
    Expands a tar file into a FileTree.
    Parameters:
    tarPath - Path to tar file. Anything that can be converted with file
    Returns:
    Tree of tar contents.
    Since:
    5.0
  - public File toSafeFile(String parts)
    
    Converts a collection of String into a {@
    link:
    File
    
    Parameters:
    parts - File path parts
    Returns:
    File path
    Since:
    2.0
  - public String toSafeFileName(String name)
    
    Converts a string into a string that is safe to use as a file name. T
    The result will only include ascii characters and numbers, and the "-","_", #, $ and "." characters.
    Parameters:
    name - A potential file name
    Returns:
    A name that is safe on the local filesystem of the current operating system.
  - public java.nio.file.Path toSafePath(String parts)
    
    Converts a collection of String into a java.nio.file.Path with all parts guarantee to be safe file parts
    Parameters:
    parts - File path parts
    Returns:
    File path
    Since:
    2.0
  - public void updateFileProperty(Property<File> provider, Object file)
    
    Updates a Property<File>.
    This method deals with a wide range of possibilities and works around the limitations of Property.set()
    
    Parameters:
    provider - Current provider
    file - Value that should be lazy-resolved.
    Since:
    2.0
  - public FileTree zipTree(Object zipPath)
    
    Expands a ZIP file into a FileTree.
    Parameters:
    zipPath - Path to tar file. Anything that can be converted with file
    Returns:
    Tree of ZIP contents.
    Since:
    5.0

Summary:
Method

| Detail:
Method

Groovy Documentation

[Java] Interface FileSystemOperations

Methods Summary

Method Detail

public Provider<File> buildDirDescendant(Object stringy)

public ReadableResource bzip2Resource(Object file)

public WorkResult copy(Action<? super CopySpec> action)

public void copyResourceToFile(String resourcePath, File destFile)

public CopySpec copySpec()

public CopySpec copySpec(Action<? super CopySpec> action)

public CopySpec copySpec(@groovy.lang.DelegatesTo(CopySpec.class) groovy.lang.Closure<?> action)

public File createTempDirectory(String prefix)

public WorkResult delete(Action<? super DeleteSpec> action)

public ConfigurableFileCollection emptyFileCollection()

public File file(Object file)

public File fileOrNull(Object file)

public ConfigurableFileTree fileTree(Object file)

public ConfigurableFileCollection files(java.util.Collection<?> files)

public ConfigurableFileCollection filesDropNull(java.util.Collection<?> files)

public Provider<File> getGradleHomeDir()

public Provider<File> getGradleUserHomeDir()

public File getProjectCacheDir()

public File getProjectDir()

public File getProjectRootDir()

public ReadableResource gzipResource(Object file)

public java.util.List<File> listDirs(File distDir)

public java.util.Properties loadPropertiesFromResource(String resourcePath)

public java.util.Properties loadPropertiesFromResource(String resourcePath, ClassLoader classLoader)

public Provider<File> provideFile(Object file)

public Provider<File> provideProjectCacheDir()

public Provider<File> provideProjectCacheDirDescendant(Object subpath)

public Provider<File> provideProjectDir()

public Provider<java.util.Properties> providePropertiesFromResource(String resourcePath)

public Provider<java.util.Properties> providePropertiesFromResource(String resourcePath, ClassLoader classLoader)

public Provider<File> provideRootDir()

public String relativePath(Object f)

public String relativePathNotEmpty(Object f)

public String relativePathToProjectDir(Object f)

public String relativePathToRootDir(Object f)

public String relativeRootPath(Object f)

public String relativize(File base, File target)

public String relativize(java.nio.file.Path base, java.nio.file.Path target)

public FileTree resolveFilesFromCopySpec(CopySpec copySpec)

public WorkResult sync(Action<? super CopySpec> action)

public FileTree tarTree(Object tarPath)

public File toSafeFile(String parts)

public String toSafeFileName(String name)

public java.nio.file.Path toSafePath(String parts)

public void updateFileProperty(Property<File> provider, Object file)

public FileTree zipTree(Object zipPath)