Package org.gradle.api.file

Interface FileCollection

All Superinterfaces:
AntBuilderAware,Buildable,Iterable<File>
All Known Subinterfaces:
AntlrSourceDirectorySet,ConfigurableFileCollection,ConfigurableFileTree,Configuration,ConsumableConfiguration,DependencyScopeConfiguration,FileTree,GroovySourceDirectorySet,LegacyConfiguration,ResolvableConfiguration,ScalaSourceDirectorySet,SourceDirectorySet,SourceSetOutput
public interfaceFileCollectionextendsIterable<File>,AntBuilderAware,Buildable

AFileCollection represents a collection of file system locations which you can query in certain ways. A file collection is can be used to define a classpath, or a set of source files, or to add files to an archive.

There are no methods on this interface that allow the contents of the collection to be modified. However, there are a number of sub-interfaces, such asConfigurableFileCollection that allow changes to be made.

A file collection may contain task outputs. The file collection tracks not just a set of files, but also the tasks that produce those files. When a file collection is used as a task input property, Gradle will take care of automatically adding dependencies between the consuming task and the producing tasks.

You can obtain aFileCollection instance usingProject.files(java.lang.Object...).

  • Method Details

    • getSingleFile

      File getSingleFile() throwsIllegalStateException
      Returns the content of this collection, asserting it contains exactly one file.
      Returns:
      The file.
      Throws:
      IllegalStateException - when this collection does not contain exactly one file.

    • getFiles

      Set<File> getFiles()
      Returns the contents of this collection as aSet. The contents of a file collection may change over time.

      Note that this method returnsFile objects that represent locations on the file system. TheseFile objects do not necessarily refer to regular files. Depending on the implementation of this file collection and how it has been configured, the returned set may contain directories, or missing files, or any other kind of file system element.

      Returns:
      The files. Returns an empty set if this collection is empty.

    • contains

      boolean contains(File file)
      Determines whether this collection contains the given file. Generally, this method is more efficient than callinggetFiles().contains(file).
      Parameters:
      file - The file to check for.
      Returns:
      true if this collection contains the given file, false otherwise.

    • getAsPath

      String getAsPath()
      Returns the contents of this collection as a platform-specific path. This can be used, for example, in an Ant <path> element.
      Returns:
      The path. Returns an empty string if this collection is empty.

    • plus

      FileCollection plus(FileCollection collection)

      Returns aFileCollection which contains the union of this collection and the given collection. The returned collection is live, and tracks changes to both source collections.

      You can call this method in your build script using the+ operator.

      Parameters:
      collection - The other collection. Should not be null.
      Returns:
      A new collection containing the union.

    • minus

      FileCollection minus(FileCollection collection)

      Returns aFileCollection which contains the difference between this collection and the given collection. The returned collection is live, and tracks changes to both source collections.

      You can call this method in your build script using the- operator.

      Parameters:
      collection - The other collection. Should not be null.
      Returns:
      A new collection containing the difference.

    • filter

      FileCollection filter(Closure filterClosure)

      Restricts the contents of this collection to those files which match the given criteria. The filtered collection is live, so that it reflects any changes to this collection.

      The given closure is passed the @{link File} as a parameter, and should return a boolean value. The closure should returntrue to include the file in the result andfalse to exclude the file from the result.

      Parameters:
      filterClosure - The closure to use to select the contents of the filtered collection.
      Returns:
      The filtered collection.

    • filter

      FileCollection filter(Spec<? superFile> filterSpec)

      Restricts the contents of this collection to those files which match the given criteria. The filtered collection is live, so that it reflects any changes to this collection.

      Parameters:
      filterSpec - The criteria to use to select the contents of the filtered collection.
      Returns:
      The filtered collection.

    • isEmpty

      boolean isEmpty()
      Returns true if this collection is empty. Generally, calling this method is more efficient than calling getFiles().isEmpty().
      Returns:
      true if this collection is empty, false otherwise.

    • getAsFileTree

      FileTree getAsFileTree()
      Converts this collection to aFileTree, if not already. For each file in this collection, the resulting file tree will contain the source file at the root of the tree. For each directory in this collection, the resulting file tree will contain all the files under the source directory.

      The returnedFileTree is live, and tracks changes to this file collection and the producer tasks of this file collection.

      Returns:
      this collection as aFileTree. Never returns null.

    • getElements

      Returns the contents of this file collection as aProvider ofFileSystemLocation instances. SeegetFiles() for more details.

      The returnedProvider is live, and tracks changes to this file collection and the producer tasks of this file collection.

      Since:
      5.6

    • addToAntBuilder

      void addToAntBuilder(Object builder,String nodeName,FileCollection.AntType type)
      Adds this collection to an Ant task as a nested node. The given type determines how this collection is added:
      • FileCollection.AntType.MatchingTask: adds this collection to an Ant MatchingTask. The collection is converted to a set of source directories and include and exclude patterns. The source directories as added as an Ant Path with the given node name. The patterns are added using 'include' and 'exclude' nodes.
      • FileCollection.AntType.FileSet: adds this collection as zero or more Ant FileSets with the given node name.
      • FileCollection.AntType.ResourceCollection: adds this collection as zero or more Ant ResourceCollections with the given node name.
      You should prefer usingFileCollection.AntType.ResourceCollection, if the target Ant task supports it, as this is generally the most efficient. Using the other types may involve copying the contents of this collection to a temporary directory.
      Parameters:
      builder - The builder to add this collection to.
      nodeName - The target node name.
      type - The target Ant type

    • addToAntBuilder

      Object addToAntBuilder(Object builder,String nodeName)
      Adds this collection to an Ant task as a nested node. Equivalent to callingaddToAntBuilder(builder, nodeName,AntType.ResourceCollection).
      Specified by:
      addToAntBuilder in interface AntBuilderAware