# Package-level declarations

Classes for working with files.

## Types

ArchiveOperations
Link copied to clipboard
@ServiceScope(value = [Build::class, Project::class])
interface ArchiveOperations
Operations on archives such as ZIP or TAR files.
BuildLayout
Link copied to clipboard
@Incubating
@ServiceScope(value = Settings::class)
interface BuildLayout
Provides access to important locations for a Gradle build.
ConfigurableFileCollection
Link copied to clipboard
@SupportsKotlinAssignmentOverloading
interface ConfigurableFileCollection : FileCollection, HasConfigurableValue, SupportsConvention
A `ConfigurableFileCollection` is a mutable `FileCollection`.
ConfigurableFilePermissions
Link copied to clipboard
interface ConfigurableFilePermissions : FilePermissions
Provides the means of specifying file and directory access permissions for all classes of system users.
ConfigurableFileTree
Link copied to clipboard
interface ConfigurableFileTree : FileTree, DirectoryTree, PatternFilterable, Buildable
A FileTree with a single base directory, which can be configured and modified.
ConfigurableUserClassFilePermissions
Link copied to clipboard
interface ConfigurableUserClassFilePermissions : UserClassFilePermissions
Provides the means of specifying file and directory access permissions for a certain class of users (see ConfigurableFilePermissions).
ContentFilterable
Link copied to clipboard
interface ContentFilterable
Represents some binary resource whose content can be filtered.
CopyProcessingSpec
Link copied to clipboard
interface CopyProcessingSpec : ContentFilterable
Specifies the destination of a copy.
CopySourceSpec
Link copied to clipboard
interface CopySourceSpec
Specifies sources for a file copy.
CopySpec
Link copied to clipboard
interface CopySpec : CopySourceSpec, CopyProcessingSpec, PatternFilterable
A set of specifications for copying files.
DeleteSpec
Link copied to clipboard
interface DeleteSpec
A specification for deleting files from the filesystem.
Directory
Link copied to clipboard
interface Directory : FileSystemLocation
Represents a directory at some fixed location on the file system.
DirectoryProperty
Link copied to clipboard
interface DirectoryProperty : FileSystemLocationProperty<T>
Represents some configurable directory location, whose value is mutable.
DirectoryTree
Link copied to clipboard
interface DirectoryTree
A directory with some associated include and exclude patterns.
DuplicateFileCopyingException
Link copied to clipboard
open class DuplicateFileCopyingException : GradleException
Thrown when more than one file with the same relative path name is to be copied and the DuplicatesStrategy is set to DuplicatesStrategy.
DuplicatesStrategy
Link copied to clipboard
enum DuplicatesStrategy
Strategies for dealing with the potential creation of duplicate files or archive entries.
EmptyFileVisitor
Link copied to clipboard
open class EmptyFileVisitor : FileVisitor
The EmptyFileVisitor can be extends by implementations that only require to implement one of the 2 visit methods (dir or file).
ExpandDetails
Link copied to clipboard
interface ExpandDetails
Additional configuration parameters for expand action.
FileCollection
Link copied to clipboard
interface FileCollection : Iterable<T> , AntBuilderAware, Buildable
A `FileCollection` represents a collection of file system locations which you can query in certain ways.
FileContents
Link copied to clipboard
interface FileContents
Provides lazy access to the contents of a given file.
FileCopyDetails
Link copied to clipboard
@NonExtensible
interface FileCopyDetails : FileTreeElement, ContentFilterable, Describable
Provides details about a file or directory about to be copied, and allows some aspects of the destination file to be modified.
FilePermissions
Link copied to clipboard
interface FilePermissions
Describes file and directory access permissions for all classes of system users.
FileSystemLocation
Link copied to clipboard
interface FileSystemLocation
Represents some immutable location on the file system.
FileSystemLocationProperty
Link copied to clipboard
interface FileSystemLocationProperty<T : FileSystemLocation?> : Property<T>
Represents some element of the file system.
FileSystemOperations
Link copied to clipboard
@ServiceScope(value = [Build::class, Project::class])
interface FileSystemOperations
Operations on the file system.
FileTree
Link copied to clipboard
interface FileTree : FileCollection
A `FileTree` represents a hierarchy of files.
FileTreeElement
Link copied to clipboard
interface FileTreeElement
Information about a file in a directory/file tree.
FileType
Link copied to clipboard
enum FileType
The type of a file.
FileVisitDetails
Link copied to clipboard
interface FileVisitDetails : FileTreeElement
Provides access to details about a file or directory being visited by a FileVisitor.
FileVisitor
Link copied to clipboard
interface FileVisitor
A `FileVisitor` is used to visit each of the files in a FileTree.
ProjectLayout
Link copied to clipboard
@ServiceScope(value = Project::class)
interface ProjectLayout
Provides access to several important locations for a project.
RegularFile
Link copied to clipboard
interface RegularFile : FileSystemLocation
Represents a regular file at a fixed location on the file system.
RegularFileProperty
Link copied to clipboard
interface RegularFileProperty : FileSystemLocationProperty<T>
Represents some configurable regular file location, whose value is mutable.
RelativePath
Link copied to clipboard
open class RelativePath : Serializable, Comparable<T> , CharSequence
Represents a relative path from some base directory to a file.
ReproducibleFileVisitor
Link copied to clipboard
interface ReproducibleFileVisitor : FileVisitor
Visitor which can request a reproducible file order.
SourceDirectorySet
Link copied to clipboard
interface SourceDirectorySet : FileTree, PatternFilterable, Named, Describable
A `SourceDirectorySet` represents a set of source files composed from a set of source directories, along with associated include and exclude patterns.
SyncSpec
Link copied to clipboard
interface SyncSpec : CopySpec
Synchronizes the contents of a destination directory with some source directories and files.
UserClassFilePermissions
Link copied to clipboard
interface UserClassFilePermissions
Describes file and directory access permissions for a certain class of users (see FilePermissions).