Method Detail

• static File fileize(ProjectLayout projectLayout, 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
  • TextResource
  • java.util.Optional of any of the above

  Parameters:

  projectLayout - Project layout

  file

  Returns:

  File instance.

• static java.util.List<File> fileize(ProjectLayout projectLayout, Iterable<Object> files)

  Converts a collection of file-like objects to a a list of File instances within a project layout. It will convert anything that the singular version of fileize(ProjectLayout projectLayout, Object o) can do. In addition it will recursively resolve any collections that result out of resolving the supplied items.

  Parameters:

  project - projectLayout Project layout

  files - List of object to evaluate

  Returns:

  List of resolved files.

• static FileCollection filesFromCopySpec(CopySpec copySpec)

  Returns the file collection that a CopySpec describes.

  Parameters:

  copySpec - An instance of a CopySpec

  Returns:

  Result collection of files.

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

• static 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:

  1.0.0

• static 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:

  1.0.0

• @SuppressWarnings('DuplicateStringLiteral') static ClassLocation resolveClassLocation(Class aClass)

  Returns the classpath location for a specific class

  Parameters:

  aClass - Class to find.

  Returns:

  Location of class. Can be null which means class has been found, but cannot be placed on classpath

  Throws:

  ClassNotFoundException*

• static File toSafeFile(String... parts)

  Converts a collection of String into a {@

  link:

  File

  Parameters:

  parts - File path parts

  Returns:

  File path

• @groovy.transform.CompileDynamic static 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:

  A - potential file name

  Returns:

  A name that is safe on the local filesystem of the current operating system.

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

• static void updateFileProperty(ProjectLayout projectLayout, ProviderFactory providers, Property<File> provider, Object file)

  Updates a Provider. Update property otherwise the provider will be assigned a new Provider instance.

  Parameters:

  projectLayout - Project layout

  providers - Provider factory

  provider - Current property

  stringy - Value that should be lazy-resolved.