Method Detail

• 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 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 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 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 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 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.