gradle/org.gradle.api.file

Package-level declarations

Classes for working with files.

Types

ArchiveOperations

@ServiceScope(value = [Build::class, Project::class])

interface ArchiveOperations

Operations on archives such as ZIP or TAR files.

@ServiceScope(value = Settings::class)

interface BuildLayout

Provides access to important locations for a Gradle build.

ConfigurableFileCollection

@SupportsKotlinAssignmentOverloading

interface ConfigurableFileCollection : FileCollection, HasConfigurableValue, SupportsConvention

A ConfigurableFileCollection is a mutable FileCollection.

ConfigurableFilePermissions

interface ConfigurableFilePermissions : FilePermissions

Provides the means of specifying file and directory access permissions for all classes of system users.

ConfigurableFileTree

interface ConfigurableFileTree : FileTree, DirectoryTree, PatternFilterable, Buildable

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

ConfigurableUserClassFilePermissions

interface ConfigurableUserClassFilePermissions : UserClassFilePermissions

Provides the means of specifying file and directory access permissions for a certain class of users (see ConfigurableFilePermissions).

ContentFilterable

interface ContentFilterable

Represents some binary resource whose content can be filtered.

CopyProcessingSpec

interface CopyProcessingSpec : ContentFilterable

Specifies the destination of a copy.

interface CopySourceSpec

Specifies sources for a file copy.

interface CopySpec : CopySourceSpec, CopyProcessingSpec, PatternFilterable

A set of specifications for copying files.

interface DeleteSpec

A specification for deleting files from the filesystem.

interface Directory : FileSystemLocation

Represents a directory at some fixed location on the file system.

DirectoryProperty

interface DirectoryProperty : FileSystemLocationProperty<T>

Represents some configurable directory location, whose value is mutable.

interface DirectoryTree

A directory with some associated include and exclude patterns.

DuplicateFileCopyingException

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

enum DuplicatesStrategy

Strategies for dealing with the potential creation of duplicate files or archive entries.

EmptyFileVisitor

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).

interface ExpandDetails

Additional configuration parameters for expand action.

interface FileCollection : Iterable<T> , AntBuilderAware, Buildable

A FileCollection represents a collection of file system locations which you can query in certain ways.

interface FileContents

Provides lazy access to the contents of a given file.

FileCopyDetails

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

interface FilePermissions

Describes file and directory access permissions for all classes of system users.

FileSystemLocation

interface FileSystemLocation

Represents some immutable location on the file system.

FileSystemLocationProperty

interface FileSystemLocationProperty<T : FileSystemLocation?> : Property<T>

Represents some element of the file system.

FileSystemOperations

@ServiceScope(value = [Build::class, Project::class])

interface FileSystemOperations

Operations on the file system.

interface FileTree : FileCollection

A FileTree represents a hierarchy of files.

FileTreeElement

interface FileTreeElement

Information about a file in a directory/file tree.

The type of a file.

FileVisitDetails

interface FileVisitDetails : FileTreeElement

Provides access to details about a file or directory being visited by a FileVisitor.

interface FileVisitor

A FileVisitor is used to visit each of the files in a FileTree.

@ServiceScope(value = Project::class)

interface ProjectLayout

Provides access to several important locations for a project.

interface RegularFile : FileSystemLocation

Represents a regular file at a fixed location on the file system.

RegularFileProperty

interface RegularFileProperty : FileSystemLocationProperty<T>

Represents some configurable regular file location, whose value is mutable.

open class RelativePath : Serializable, Comparable<T> , CharSequence

Represents a relative path from some base directory to a file.

ReproducibleFileVisitor

interface ReproducibleFileVisitor : FileVisitor

Visitor which can request a reproducible file order.

SourceDirectorySet

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.

interface SyncSpec : CopySpec

Synchronizes the contents of a destination directory with some source directories and files.

UserClassFilePermissions

interface UserClassFilePermissions

Describes file and directory access permissions for a certain class of users (see FilePermissions).