Package org.gradle.api.file

Interface ConfigurableFileCollection

All Superinterfaces:
AntBuilderAware, Buildable, FileCollection, HasConfigurableValue, Iterable<File>, SupportsConvention
@SupportsKotlinAssignmentOverloading public interface ConfigurableFileCollection extends FileCollection, HasConfigurableValue, SupportsConvention

A ConfigurableFileCollection is a mutable FileCollection.

You can obtain an instance of ConfigurableFileCollection by calling Project.files(Object...) or ObjectFactory.fileCollection().

Note: This interface is not intended for implementation by build script or plugin authors.

  • Method Details

    • getFrom

      Set<Object> getFrom()
      Returns the set of source paths for this collection. The paths are evaluated as per Project.files(Object...).
      Returns:
      The set of source paths. Returns an empty set if none.

    • setFrom

      void setFrom(Iterable<?> paths)
      Sets the source paths for this collection. The given paths are evaluated as per Project.files(Object...).
      Parameters:
      paths - The paths.

    • setFrom

      void setFrom(Object... paths)
      Sets the source paths for this collection. The given paths are evaluated as per Project.files(Object...).
      Parameters:
      paths - The paths.

    • convention

      @Incubating ConfigurableFileCollection convention(Iterable<?> paths)
      Specifies the value to use as the convention (default value) to be used when resolving this file collection, if no source paths are explicitly defined. If, at the time this method is invoked, the set of source paths for this collection is empty, the convention will be used to resolve this file collection.
      Parameters:
      paths - The paths.
      Returns:
      this collection
      Since:
      8.8

    • convention

      @Incubating ConfigurableFileCollection convention(Object... paths)
      Specifies the value to use as the convention (default value) to be used when resolving this file collection, if no source paths are explicitly defined. If, at the time this method is invoked, the set of source paths for this collection is empty, the convention will be used to resolve this file collection.
      Parameters:
      paths - The paths.
      Returns:
      this collection
      Since:
      8.8

    • from

      ConfigurableFileCollection from(Object... paths)
      Adds a set of source paths to this collection. The given paths are evaluated as per Project.files(Object...).
      Parameters:
      paths - The files to add.
      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

      ConfigurableFileCollection 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

      ConfigurableFileCollection 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