Field Detail

• public static final java.util.regex.Pattern SAFE_FILENAME_REGEX

Method Detail

• static File fileize(Project project, 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:

  project - Project context

  file

  Returns:

  File instance.

  Since:

  0.17.0

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

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

  Parameters:

  project - Project context

  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 File projectCacheDirFor(Project project)

  Returns the project cache directory for the given project.

  Parameters:

  project - Project to query.

  Returns:

  Project cache directory. Never null.

  Since:

  0.14

• @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*

  Since:

  0.9

• static File toSafeFile(String... parts)

  Converts a collection of String into a {@

  link:

  File

  Parameters:

  parts - File path parts

  Returns:

  File path

  Since:

  0.8

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

  Since:

  0.8

• static void updateFileProperty(Project project, Provider<File> provider, Object file)

  Updates a Provider. If the Provider is a Property it will be updated in place, otherwise the provider will be assigned a new Provider instance. This requires Gradle 4.3 at minimum. Alternatively if the Provider is PropertyStore it will also be updated in place.

  Parameters:

  project - Project context for creating providers

  provider - Current provider

  stringy - Value that should be lazy-resolved.

  Since:

  0.17.0