FileSystemOperationsProxy (grolifant-core 2.0.0-alpha.4 API)

org.ysb33r.grolifant.loadable.core.FileSystemOperationsProxy

All Implemented Interfaces and Traits:

org.ysb33r.grolifant.api.core.FileSystemOperations
```
@SuppressWarnings('AbstractClassWithoutAbstractMethod')
@groovy.transform.CompileStatic
abstract class FileSystemOperationsProxy
extends Object
```
Common filesystem operations
Authors:
Schalk W. Cronjé
Since:
1.3

Field Summary

Fields
Modifiers	Name	Description
`protected File`	`projectDir`	The project directory.
`protected java.nio.file.Path`	`projectDirPath`	The project directory as java.nio.file.Path.
`protected ProviderFactory`	`providerFactory`	Provider factory
`protected File`	`rootDir`	The root project directory.
`protected java.nio.file.Path`	`rootDirPath`	The project root directory as java.nio.file.Path.

Constructor Summary

Constructors
Constructor and description
`protected FileSystemOperationsProxy (org.ysb33r.grolifant.api.core.ProjectOperations incompleteReference, Project tempProjectReference)`

Methods Summary

Methods
Type Params	Return Type	Name and description
	`File`	`createTempDirectory(String prefix)` Creates a temporary directory with the given prefix.
	`ConfigurableFileCollection`	`files(java.util.Collection<?> files)` Converts a file-like objects to File instances with project context.
	`ConfigurableFileCollection`	`filesDropNull(java.util.Collection<?> files)` Converts a file-like objects to File instances with project context.
	`java.util.List<File>`	`listDirs(File distDir)` Provides a list of directories below another directory
	`String`	`relativePath(Object f)` Returns the relative path from the project directory to the given path.
	`String`	`relativePathToProjectDir(Object f)` Returns the relative path from the given path to the project directory.
	`String`	`relativePathToRootDir(Object f)` Returns the relative path from the given path to the root project directory.
	`String`	`relativeRootPath(Object f)` Returns the relative path from the root project directory to the given path.
	`FileTree`	`resolveFilesFromCopySpec(CopySpec copySpec)` Given a {@Link CopySpec}, resolve all of the input files in to a collection.
	`String`	`toSafeFileName(String name)` Converts a string into a string that is safe to use as a file name.
	`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
	`void`	`updateFileProperty(Property<File> provider, Object fileTarget)` Updates a `Property<File>`.

Inherited Methods Summary

Inherited Methods
Methods inherited from class	Name
`class Object`	`wait, wait, wait, equals, toString, hashCode, getClass, notify, notifyAll`

- Field Detail
  - protected final File projectDir
    
    The project directory.
  - protected final java.nio.file.Path projectDirPath
    
    The project directory as java.nio.file.Path.
  - protected final ProviderFactory providerFactory
    
    Provider factory
  - protected final File rootDir
    
    The root project directory.
  - protected final java.nio.file.Path rootDirPath
    
    The project root directory as java.nio.file.Path.
- Constructor Detail
  - protected FileSystemOperationsProxy(org.ysb33r.grolifant.api.core.ProjectOperations incompleteReference, Project tempProjectReference)
- Method Detail
  - @Override 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
  - @Override 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.
  - @Override 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.
  - @Override 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.
  - @Override 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.
  - @Override 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.
  - @Override 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.
  - @Override 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.
  - @Override FileTree resolveFilesFromCopySpec(CopySpec copySpec)
    
    Given a {
    Link:
    CopySpec}, resolve all of the input files in to a collection.
    
    Parameters:
    copySpec - Input specification
    Returns:
    Colelction of files.
  - @Override @groovy.transform.CompileDynamic 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.
  - @Override 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
  - @Override void updateFileProperty(Property<File> provider, Object fileTarget)
    
    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
    fileTarget - Value that should be lazy-resolved.
    Since:
    2.0

Summary:
Field
Constructor
Method

| Detail:
Field
Constructor
Method

Groovy Documentation

[Groovy] Class FileSystemOperationsProxy

Field Summary

Constructor Summary

Methods Summary

Inherited Methods Summary

Field Detail

protected final File projectDir

protected final java.nio.file.Path projectDirPath

protected final ProviderFactory providerFactory

protected final File rootDir

protected final java.nio.file.Path rootDirPath

Constructor Detail

protected FileSystemOperationsProxy(org.ysb33r.grolifant.api.core.ProjectOperations incompleteReference, Project tempProjectReference)

Method Detail

@Override File createTempDirectory(String prefix)

@Override ConfigurableFileCollection files(java.util.Collection<?> files)

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

@Override java.util.List<File> listDirs(File distDir)

@Override String relativePath(Object f)

@Override String relativePathToProjectDir(Object f)

@Override String relativePathToRootDir(Object f)

@Override String relativeRootPath(Object f)

@Override FileTree resolveFilesFromCopySpec(CopySpec copySpec)

@Override @groovy.transform.CompileDynamic String toSafeFileName(String name)

@Override java.nio.file.Path toSafePath(String... parts)

@Override void updateFileProperty(Property<File> provider, Object fileTarget)