Package org.gradle.api.file

Interface ConfigurableFileTree

All Superinterfaces:
AntBuilderAware, Buildable, DirectoryTree, FileCollection, FileTree, Iterable<File>, PatternFilterable
public interface ConfigurableFileTree extends FileTree, DirectoryTree, PatternFilterable, Buildable

A FileTree with a single base directory, which can be configured and modified.

You can obtain a ConfigurableFileTree instance by calling Project.fileTree(java.util.Map).

  • Method Details

    • from

      ConfigurableFileTree from(Object dir)
      Specifies base directory for this file tree using the given path. The path is evaluated as per Project.file(Object).
      Parameters:
      dir - The base directory.
      Returns:
      this

    • getDir

      File getDir()
      Returns the base directory of this file tree.
      Specified by:
      getDir in interface DirectoryTree
      Returns:
      The base directory. Never returns null.

    • setDir

      ConfigurableFileTree setDir(Object dir)
      Specifies base directory for this file tree using the given path. The path is evaluated as per Project.file(Object).
      Parameters:
      dir - The base directory.
      Returns:
      this

    • getBuiltBy

      Set<Object> getBuiltBy()
      Returns the set of tasks which build the files of this collection.
      Returns:
      The set. Returns an empty set when there are no such tasks.

    • setBuiltBy

      ConfigurableFileTree setBuiltBy(Iterable<?> tasks)
      Sets the tasks which build the files of this collection.
      Parameters:
      tasks - The tasks. These are evaluated as per Task.dependsOn(Object...).
      Returns:
      this

    • builtBy

      ConfigurableFileTree builtBy(Object... tasks)
      Registers some tasks which build the files of this collection.
      Parameters:
      tasks - The tasks. These are evaluated as per Task.dependsOn(Object...).
      Returns:
      this