DefaultFileSystemOperations (grolifant5-70 5.0.0-alpha.1 API)

org.ysb33r.grolifant5.loadable.v7.DefaultFileSystemOperations

@groovy.transform.CompileStatic
class DefaultFileSystemOperations
extends org.ysb33r.grolifant5.loadable.core.FileSystemOperationsProxy

Implements org.ysb33r.grolifant5.api.core.FileSystemOperations for Gradle 7.x.

Authors:: Schalk W. Cronjé

Since:: 2.0

Inherited fields
Fields inherited from class	Fields
`class org.ysb33r.grolifant5.loadable.core.FileSystemOperationsProxy`	`__$stMC`

Constructor Summary

Constructors
Constructor and description
`DefaultFileSystemOperations (FileSystemOperations fso, ArchiveOperations archives, Project project)`

Methods Summary

Methods
Type Params	Return Type	Name and description
	`ReadableResource`	`bzip2Resource(Object file)` Creates resource that points to a bzip2 compressed file at the given path.
	`WorkResult`	`copy(Action<? super CopySpec> action)` Copies the specified files.
	`WorkResult`	`delete(Action<? super DeleteSpec> action)` Deletes the specified files.
	`ConfigurableFileCollection`	`emptyFileCollection()` Creates an empty file collection.
	`File`	`file(Object file)` Converts a file-like object to a File instance with project context.
	`File`	`fileOrNull(Object file)` Similar to { Link: #file}, but does not throw an exception if the object is `null` or an empty provider.
	`ReadableResource`	`gzipResource(Object file)` Creates resource that points to a gzip compressed file at the given path.
	`WorkResult`	`sync(Action<? super CopySpec> action)` Synchronizes the contents of a destination directory with some source directories and files.
	`FileTree`	`tarTree(Object tarPath)` Expands a tar file into a FileTree.
	`FileTree`	`zipTree(Object zipPath)` Expands a ZIP file into a FileTree.

Inherited Methods Summary

Inherited Methods
Methods inherited from class	Name
`class org.ysb33r.grolifant5.loadable.core.FileSystemOperationsProxy`	org.ysb33r.grolifant5.loadable.core.FileSystemOperationsProxy#provideFile(java.lang.Object), org.ysb33r.grolifant5.loadable.core.FileSystemOperationsProxy#provideProjectCacheDir(), org.ysb33r.grolifant5.loadable.core.FileSystemOperationsProxy#provideProjectDir(), org.ysb33r.grolifant5.loadable.core.FileSystemOperationsProxy#provideRootDir(), org.ysb33r.grolifant5.loadable.core.FileSystemOperationsProxy#provideProjectCacheDirDescendant(java.lang.Object), org.ysb33r.grolifant5.loadable.core.FileSystemOperationsProxy#providePropertiesFromResource(java.lang.String), org.ysb33r.grolifant5.loadable.core.FileSystemOperationsProxy#relativePath(java.lang.Object), org.ysb33r.grolifant5.loadable.core.FileSystemOperationsProxy#updateFileProperty(org.gradle.api.provider.Property, java.lang.Object), org.ysb33r.grolifant5.loadable.core.FileSystemOperationsProxy#this$dist$invoke$1(java.lang.String, java.lang.Object), org.ysb33r.grolifant5.loadable.core.FileSystemOperationsProxy#this$dist$set$1(java.lang.String, java.lang.Object), org.ysb33r.grolifant5.loadable.core.FileSystemOperationsProxy#this$dist$get$1(java.lang.String), org.ysb33r.grolifant5.loadable.core.FileSystemOperationsProxy#loadPropertiesFromResource(java.lang.String), org.ysb33r.grolifant5.loadable.core.FileSystemOperationsProxy#buildDirDescendant(java.lang.Object), org.ysb33r.grolifant5.loadable.core.FileSystemOperationsProxy#getProjectRootDir(), org.ysb33r.grolifant5.loadable.core.FileSystemOperationsProxy#listDirs(java.io.File), org.ysb33r.grolifant5.loadable.core.FileSystemOperationsProxy#filesDropNull(java.util.Collection), org.ysb33r.grolifant5.loadable.core.FileSystemOperationsProxy#relativeRootPath(java.lang.Object), org.ysb33r.grolifant5.loadable.core.FileSystemOperationsProxy#relativePathToProjectDir(java.lang.Object), org.ysb33r.grolifant5.loadable.core.FileSystemOperationsProxy#relativePathToRootDir(java.lang.Object), org.ysb33r.grolifant5.loadable.core.FileSystemOperationsProxy#resolveFilesFromCopySpec(org.gradle.api.file.CopySpec), org.ysb33r.grolifant5.loadable.core.FileSystemOperationsProxy#toSafePath([Ljava.lang.String;), org.ysb33r.grolifant5.loadable.core.FileSystemOperationsProxy#copyResourceToFile(java.lang.String, java.io.File), org.ysb33r.grolifant5.loadable.core.FileSystemOperationsProxy#files(java.util.Collection), org.ysb33r.grolifant5.loadable.core.FileSystemOperationsProxy#relativize(java.io.File, java.io.File), org.ysb33r.grolifant5.loadable.core.FileSystemOperationsProxy#relativize(java.nio.file.Path, java.nio.file.Path), org.ysb33r.grolifant5.loadable.core.FileSystemOperationsProxy#createTempDirectory(java.lang.String), org.ysb33r.grolifant5.loadable.core.FileSystemOperationsProxy#fileTree(java.lang.Object), org.ysb33r.grolifant5.loadable.core.FileSystemOperationsProxy#getMetaClass(), org.ysb33r.grolifant5.loadable.core.FileSystemOperationsProxy#setMetaClass(groovy.lang.MetaClass), org.ysb33r.grolifant5.loadable.core.FileSystemOperationsProxy#toSafeFileName(java.lang.String), org.ysb33r.grolifant5.loadable.core.FileSystemOperationsProxy#getGradleHomeDir(), org.ysb33r.grolifant5.loadable.core.FileSystemOperationsProxy#getProjectCacheDir(), org.ysb33r.grolifant5.loadable.core.FileSystemOperationsProxy#getGradleUserHomeDir(), org.ysb33r.grolifant5.loadable.core.FileSystemOperationsProxy#getProjectDir(), org.ysb33r.grolifant5.loadable.core.FileSystemOperationsProxy#equals(java.lang.Object), org.ysb33r.grolifant5.loadable.core.FileSystemOperationsProxy#toString(), org.ysb33r.grolifant5.loadable.core.FileSystemOperationsProxy#hashCode(), org.ysb33r.grolifant5.loadable.core.FileSystemOperationsProxy#getClass(), org.ysb33r.grolifant5.loadable.core.FileSystemOperationsProxy#notify(), org.ysb33r.grolifant5.loadable.core.FileSystemOperationsProxy#notifyAll(), org.ysb33r.grolifant5.loadable.core.FileSystemOperationsProxy#wait(long), org.ysb33r.grolifant5.loadable.core.FileSystemOperationsProxy#wait(long, int), org.ysb33r.grolifant5.loadable.core.FileSystemOperationsProxy#wait(), org.ysb33r.grolifant5.loadable.core.FileSystemOperationsProxy#zipTree(java.lang.Object), org.ysb33r.grolifant5.loadable.core.FileSystemOperationsProxy#tarTree(java.lang.Object), org.ysb33r.grolifant5.loadable.core.FileSystemOperationsProxy#fileOrNull(java.lang.Object), org.ysb33r.grolifant5.loadable.core.FileSystemOperationsProxy#bzip2Resource(java.lang.Object), org.ysb33r.grolifant5.loadable.core.FileSystemOperationsProxy#gzipResource(java.lang.Object), org.ysb33r.grolifant5.loadable.core.FileSystemOperationsProxy#emptyFileCollection(), org.ysb33r.grolifant5.loadable.core.FileSystemOperationsProxy#relativePathNotEmpty(java.lang.Object), org.ysb33r.grolifant5.loadable.core.FileSystemOperationsProxy#toSafeFile([Ljava.lang.String;), org.ysb33r.grolifant5.loadable.core.FileSystemOperationsProxy#file(java.lang.Object), org.ysb33r.grolifant5.loadable.core.FileSystemOperationsProxy#delete(org.gradle.api.Action), org.ysb33r.grolifant5.loadable.core.FileSystemOperationsProxy#copy(org.gradle.api.Action), org.ysb33r.grolifant5.loadable.core.FileSystemOperationsProxy#sync(org.gradle.api.Action), org.ysb33r.grolifant5.loadable.core.FileSystemOperationsProxy#getProperty(java.lang.String), org.ysb33r.grolifant5.loadable.core.FileSystemOperationsProxy#setProperty(java.lang.String, java.lang.Object), org.ysb33r.grolifant5.loadable.core.FileSystemOperationsProxy#invokeMethod(java.lang.String, java.lang.Object)

- Constructor Detail
  - @javax.inject.Inject DefaultFileSystemOperations(FileSystemOperations fso, ArchiveOperations archives, Project project)
- Method Detail
  - @Override 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
  - @Override 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.
  - @Override 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.
  - @Override ConfigurableFileCollection emptyFileCollection()
    
    Creates an empty file collection.
    Returns:
    Empty file collection.
  - @Override 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.
  - @Override 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.
  - @Override 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
  - @Override 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.
  - @Override 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
  - @Override 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:
Constructor
Method

| Detail:
Constructor
Method

Groovy Documentation

[Groovy] Class DefaultFileSystemOperations

Constructor Summary

Methods Summary

Inherited Methods Summary

Constructor Detail

@javax.inject.Inject DefaultFileSystemOperations(FileSystemOperations fso, ArchiveOperations archives, Project project)

Method Detail

@Override ReadableResource bzip2Resource(Object file)

@Override WorkResult copy(Action<? super CopySpec> action)

@Override WorkResult delete(Action<? super DeleteSpec> action)

@Override ConfigurableFileCollection emptyFileCollection()

@Override File file(Object file)

@Override File fileOrNull(Object file)

@Override ReadableResource gzipResource(Object file)

@Override WorkResult sync(Action<? super CopySpec> action)

@Override FileTree tarTree(Object tarPath)

@Override FileTree zipTree(Object zipPath)