# All Classes and Interfaces

Class
Description
AbstractArchiveTask
`AbstractArchiveTask` is the base class for all archive tasks.
AbstractBuildCache
Base implementation for build cache service configuration.
AbstractClasspathEntry
Common superclass for all `ClasspathEntry` instances.
AbstractCodeQualityTask
Base class for code quality tasks.
AbstractCompile
The base class for all JVM-based language compilation tasks.
AbstractConfigurationReportTask
Base class for reporting tasks which display information about attributes and related data associated to a variant/configuration.
AbstractCopyTask
`AbstractCopyTask` is the base class for all copy tasks.
AbstractDependencyReportTask
Displays the dependency tree for a configuration.
AbstractDependencyReportTask.DependencyReportModel
Report model.
AbstractExecTask<T>
`AbstractExecTask` is the base class for all exec tasks.
AbstractLibrary
Common superclass for the library elements.
AbstractLinkTask
Base task for linking a native binary from object files and libraries.
AbstractNativeCompileTask
Compiles native source files into object files.
AbstractNativePCHCompileTask
Compiles native header source files into object files.
AbstractNativeSourceCompileTask
Compiles native source files into object files.
AbstractProjectBasedReportTask<T>
The base class for all Project based project report tasks.
AbstractPublishToMaven
Base class for tasks that publish a `MavenPublication`.
AbstractReportTask
Deprecated.
Use `AbstractProjectBasedReportTask` instead.
AbstractScalaCompile
An abstract Scala compile task sharing common functionality for compiling scala.
AbstractSignatureType
Convenience base class for `SignatureType` implementations.
AbstractSignatureTypeProvider
Convenience base class for `SignatureTypeProvider` implementations.
AbstractTestTask
Abstract class for all test tasks.
AccessRule
Access rule associated to a classpath entry.
AccessRule
Access rule associated with an Eclipse classpath entry.
Action<T>
Performs some action against objects of type T.
ActionConfiguration
Allows specification of configuration for some action.
AdditionalData
Marker interface for additional data that can be attached to a `Problem`.
AdditionalData
Additional data attached to the problem.
AdhocComponentWithVariants
A component which can declare additional variants corresponding to features.
AggregateTestReport
A container for the inputs of an aggregated test report.
AndSpec<T>
A `CompositeSpec` which requires all its specs to be true in order to evaluate to true.
AntBuilder
An `AntBuilder` allows you to use Ant from your build script.
AntBuilder.AntMessagePriority
Represents the normal Ant message priorities.
AntBuilderAware
An `AntBuilderAware` represents an object which can add itself to Ant tasks, using an `AntBuilder`.
AntlrPlugin
A plugin for adding Antlr support to `java projects`.
AntlrSourceDirectorySet
Contract for a Gradle extension that acts as a handler for what I call a virtual directory mapping, injecting a virtual directory named 'antlr' into the project's various `source sets`.
AntlrTask
Generates parsers from Antlr grammars.
AntTarget
A task which executes an Ant target.
Application
A software application.
ApplicationBinarySpec
A binary produced from a ``ApplicationSpec``.
ApplicationPlugin
A `Plugin` which packages and runs a project as a Java Application.
ApplicationSpec
A specification of a `Application`.
AppliedPlugin
Represents a plugin that has been applied.
Architecture
A CPU architecture.
Architecture
Constants for various processor architectures Gradle runs on.
ArchiveOperations
Operations on archives such as ZIP or TAR files.
ArmoredSignatureType
Armored signature type.
Artifact
An artifact of a software component that may be requested in the result of an artifact query.
ArtifactCollection
A collection of artifacts resolved for a configuration.
ArtifactHandler
This class is for defining artifacts to be published and adding them to configurations.
ArtifactRepository
A repository for resolving and publishing artifacts.
ArtifactRepositoryContainer
A `ResolverContainer` is responsible for managing a set of `ArtifactRepository` instances.
ArtifactResolutionQuery
A builder to construct a query that can resolve selected software artifacts of the specified components.
ArtifactResolutionResult
The result of executing an artifact resolution query.
ArtifactResult
The result of resolving an artifact.
ArtifactSelectionDetails
Details about artifact dependency substitution: this class gives access to the original dependency requested artifacts, if any, and gives the opportunity to replace the original requested artifacts with other artifacts.
ArtifactTransformReports
The reporting configuration for the `ArtifactTransformsReportTask`.
ArtifactTransformsReportTask
A task which reports information about the Artifact Transforms (implemented by `TransformAction`) used by a project.
ArtifactTypeContainer
Defines a set of known artifact types and related meta-data.
ArtifactTypeDefinition
Meta-data about a particular type of artifacts.
ArtifactView
A view over the artifacts resolved for this set of dependencies.
ArtifactView.ViewConfiguration
Configuration for a defined artifact view.
Assemble
Translates Assembly language source files into object files.
AssemblerLangPlugin
Adds core Assembler language support.
AssemblerLangPlugin.Rules
AssemblerPlugin
A plugin for projects wishing to build native binary components from Assembly language sources.
AssemblerSourceSet
A set of assembly language sources.
Attribute<T>
An attribute is a named entity with a type.
AttributeCompatibilityRule<T>
A rule that determines whether a given attribute value is compatible some provided attribute value.
AttributeContainer
An attribute container is a container of `attributes`, which are strongly typed named entities.
AttributeDisambiguationRule<T>
A rule that selects the best value out of a set of candidates.
AttributeMatchingStrategy<T>
An attribute matching strategy is responsible for providing information about how an `Attribute` is matched during dependency resolution.
Attributes
Represent the attributes of a manifest section.
AttributesSchema
An attributes schema stores information about `attributes` and how they can be matched together.
Authentication
Base interface for transport authentication schemes.
AuthenticationContainer
Container for configuring repository authentication schemes of type `Authentication`.
AuthenticationSupported
An artifact repository which supports username/password authentication.
AwsCredentials
Represents credentials used to authenticate with Amazon Web Services.
AwsImAuthentication
Authentication scheme for digest access authentication over S3.
BaseBinarySpec
Base class that may be used for custom `BinarySpec` implementations.
BaseComponentSpec
Base class that may be used for custom `GeneralComponentSpec` implementations.
BaseExecSpec
Specifies options for launching a child process.
BaseForkOptions
Fork options for compilation.
BaseLanguageSourceSet
Base class that may be used for custom `LanguageSourceSet` implementations.
BasePlugin
A `Plugin` which defines a basic project lifecycle and some common convention properties.
BasePluginExtension
An extension used for `BasePlugin`.
BaseProblemDescriptor
A common base interface for Problem API related descriptors.
BaseScalaCompileOptions
Options for Scala platform compilation.
BasicAuthentication
Authentication scheme for basic access authentication over HTTP.
BasicGradleProject
Provides some basic details about a Gradle project.
BasicIdeaProject
IdeaProject that does not provide/resolve any external dependencies.
Binary
A physical binary artifact, which can run on a particular platform or runtime.
BinaryBasePlugin
Base plugin for binaries support.
BinaryBasePlugin.Rules
BinaryCollection<T>
A collection of binaries that are created and configured as they are required.
BinaryContainer
A container for project binaries, which represent physical artifacts that can run on a particular platform or runtime.
BinaryPluginIdentifier
Identifies a Gradle binary plugin.
BinaryProvider<T>
Represents a binary that is created and configured as required.
BinarySignatureType
Binary signature type.
BinarySpec
Represents a binary that is the result of building a component.
BinaryTasks
Declares the tasks to build a custom `BinarySpec` binary.
BinaryTasksCollection
A collection of tasks associated to a binary
Buildable
A `Buildable` represents an artifact or set of artifacts which are built by one or more `Task` instances.
BuildableComponent
Represents a component that can be built.
BuildableComponentSpec
A `ComponentSpec` that is directly `Buildable` via a specified task.
BuildableElement
Represents an element which has Gradle tasks associated with it.
BuildAction<T>
An action that executes against a Gradle build and produces a result of type `T`.
BuildActionExecuter<T>
Used to execute a `BuildAction` in the build process.
BuildActionExecuter.Builder
Builder for a build action that hooks into different phases of the build.
BuildActionFailureException
Thrown when a `BuildAction` fails.
BuildAdapter
A `BuildListener` adapter class for receiving build events.
BuildCache
Configuration object for a build cache.
BuildCacheConfiguration
Configuration for the build cache for an entire Gradle build.
BuildCacheEntryReader
A reader for build cache entries.
BuildCacheEntryWriter
Writer to serialize a build cache entry.
BuildCacheException
`BuildCacheException` is the base class of all exceptions thrown by a `BuildCacheService`.
BuildCacheKey
Cache key identifying an entry in the build cache.
BuildCacheService
Protocol interface to be implemented by a client to a build cache backend.
BuildCacheServiceFactory<T>
Factory interface to be provided by build cache service implementations.
BuildCacheServiceFactory.Describer
Builder-style object that allows build cache service factories to describe the cache service.
BuildCancelledException
A `BuildCancelledException` is thrown when a build is interrupted due to cancellation request.
BuildCancelledException
Thrown when a `LongRunningOperation` is cancelled before the operation completes.
BuildCommand
A build command.
BuildController
Provides a `BuildAction` various ways to control a Gradle build and access information about the build.
BuildDashboardPlugin
Adds a task, "buildDashboard", that aggregates the output of all tasks that produce reports.
BuildDashboardReports
The reporting configuration for the `GenerateBuildDashboard` task.
BuildEnvironment
Informs about the build environment, like Gradle version or the Java home in use.
BuildEnvironmentReportTask
Provides information about the build environment for the project that the task is associated with.
BuildEventsListenerRegistry
Allows a plugin to receive information about the operations that run within a build.
BuildException
Thrown when a Gradle build fails or when a model cannot be built.
BuildFeature
Status of a Gradle feature in the current invocation, such as Configuration Cache.
BuildFeatures
Provides information about various build features supported by Gradle, and their state in the current build.
BuildIdentifier
Identifies a Gradle build.
BuildIdentifier
Identifies a Gradle build.
BuildInitConfig
Represents a `BuildInitSpec` that has been configured by the user, and can provide arguments for all of its `BuildInitParameter`s.
BuildInitGenerator
Generates a new project from a configured `BuildInitConfig`.
BuildInitParameter<T>
Represents a parameter that can be provided to a `BuildInitSpec` to configure it with custom information about this particular project to be generated.
BuildInitPlugin
The build init plugin.
BuildInitSpec
Represents a specification for a new type of project that the `init` task can generate.
BuildInvocationDetails
Provides some useful information about the build invocation that triggered this build.
BuildInvocations
A model providing access to `Launchable` instances that can be used to initiate Gradle build.
BuildLauncher
A `BuildLauncher` allows you to configure and execute a Gradle build.
BuildLayout
Provides access to important locations for a Gradle build.
BuildListener
A `BuildListener` is notified of the major lifecycle events as a build is executed.
BuildModel
Represents a model that is associated with or represents some Gradle build.
BuildPhaseFinishEvent
An event that marks the finish of a build phase.
BuildPhaseOperationDescriptor
A descriptor of a build phase operation.
BuildPhaseProgressEvent
Event describing the build phase.
BuildPhaseStartEvent
An event that marks the start of a build phase.
BuildPlatform
Information about the machine host Gradle is running on.
BuildPlatformFactory
Factory for creating `BuildPlatform` instances.
BuildResult
A `BuildResult` packages up the result of a build.
BuildResult
The result of executing a build, via the `GradleRunner`.
BuildService<T>
Represents a user provided "service" that is used by a Gradle build.
BuildServiceParameters
A set of parameters to be injected into a `BuildService` implementation.
BuildServiceParameters.None
Used for services without parameters.
BuildServiceRegistration<T,P>
Details of a build service.
BuildServiceRegistry
A registry of build services.
BuildServiceSpec<P>
A set of parameters that defines a service registration.
BuildTask
A task that was executed when running a specific build.
BuildType
Specifies a build-type for a native binary.
BuildTypeContainer
A container of `BuildType`s.
BuildWorkResult
Summary result of the execution of the work scheduled for the current build.
Bundling
This attribute describes how dependencies of a component are found.
CacheableRule
Declares a `ComponentMetadataRule` eligible for caching.
CacheableTask
Attached to a task type to indicate that task output caching should be enabled by default for tasks of this type.
CacheableTransform
Attaching this annotation to a `TransformAction` type it indicates that the build cache should be used for artifact transforms of this type.
CacheConfigurations
Configures caches stored in the user home directory.
CacheResourceConfiguration
Represents the configuration of a given type of cache resource.
CancellationToken
Token that propagates notification that an operation should be cancelled.
CancellationTokenSource
A `CancellationTokenSource` allows you to issue cancellation requests to one or more `LongRunningOperation` instances.
CapabilitiesMetadata
Gives access to the list of capabilities of a component.
CapabilitiesResolution
Allows configuring the capabilities resolution strategy.
Capability
Represents a capability.
CapabilityResolutionDetails
Gives access to the resolution details of a single capability conflict.
CapabilitySelector
An opaque, immutable, selector for a capability of a variant.
CatalogPluginExtension
Allows configuring a version catalog.
Category
This attribute describes the categories of variants for a given module.
CCompile
Compiles C source files into object files.
ChangeType
The type of change for e.g.
CheckableComponentSpec
A `ComponentSpec` that is directly checkable via a specified task.
Checkstyle
Runs Checkstyle against some source files.
CheckstyleExtension
Configuration options for the Checkstyle plugin.
CheckstylePlugin
Checkstyle Plugin.
CheckstyleReports
The reporting configuration for the `Checkstyle` task.
CircularReferenceException
A `CircularReferenceException` is thrown if circular references exists between tasks, the project evaluation order or the project dependsOn order.
Clang
The Clang tool chain.
ClangCompilerPlugin
A `Plugin` which makes the Clang compiler available for compiling C/C++ code.
CLangPlugin
Adds core C language support.
CLangPlugin.Rules
ClassLoaderWorkerSpec
A worker spec providing the requirements of an isolated classpath.
Classpath
Marks a property as specifying a JVM classpath for a task.
Classpath
Represents the customizable elements of an eclipse classpath file.
ClasspathAttribute
Optional description associated with Eclipse classpath entries.
ClasspathEntry
Represents an entry in the Eclipse classpath.
ClasspathNormalizer
Normalizes file input that represents a Java runtime classpath.
ClasspathResourceSource
Classpath resource-based test source.
ClasspathResourceSource
Classpath resource-based test source.
ClassSource
Class-based test source.
ClassSource
Class-based test source.
Cleanup
Configures cache cleanup settings that apply to all caches.
CodeNarc
Runs CodeNarc against some source files.
CodeNarcExtension
Configuration options for the CodeNarc plugin.
CodeNarcPlugin
CodeNarc Plugin.
CodeNarcReports
The reporting configuration for the `CodeNarc` test.
CodeQualityExtension
Base Code Quality Extension.
CommandLineArgumentProvider
Provides arguments to a process.
CommandLineToolConfiguration
An executable tool that forms part of a tool chain.
CompatibilityCheckDetails<T>
Provides context about attribute compatibility checks, and allows the user to define when an attribute is compatible with another.
CompatibilityRuleChain<T>
A chain of compatibility checks, implemented as action rules.
CompilationDetails
Represents the compilation details for a binary.
CompileClasspath
Marks a property as specifying a Java compile classpath for a task.
CompileClasspathNormalizer
Normalizes file input that represents a Java compile classpath.
CompileOptions
Main options for Java compilation.
CompilerVersion
Version of a compiler.
Component
A software component that can be queried via the Artifact Query API.
ComponentArtifactIdentifier
An opaque immutable identifier for an artifact that belongs to some component instance.
ComponentArtifactsResult
The result of successfully resolving a component with a set of artifacts.
ComponentBasePlugin
Base plugin for `ComponentSpec` support.
ComponentBasePlugin.PluginRules
ComponentBinaries
Declares the binaries that should be built for a custom `ComponentSpec` type.
ComponentDependencies
Allows the implementation dependencies of a component to be specified.
ComponentIdentifier
An opaque immutable identifier for a component instance.
ComponentMetadata
Provides a read-only view of a resolved component's metadata, which typically originates from a component descriptor (Ivy file, Maven POM).
ComponentMetadataBuilder
A component metadata builder.
ComponentMetadataContext
Provides access to component metadata from a `ComponentMetadataRule`.
ComponentMetadataDetails
Describes a resolved component's metadata, which typically originates from a component descriptor (Ivy file, Maven POM).
ComponentMetadataHandler
Allows the build to provide rules that modify the metadata of software components resolved from external repositories.
ComponentMetadataListerDetails
Allows a custom version lister to specify the list of versions known for a specific module.
ComponentMetadataRule
A rule that modify `component metadata`.
ComponentMetadataSupplier
A component metadata rule is responsible for providing the initial metadata of a component from a remote repository, in place of parsing the descriptor.
ComponentMetadataSupplierDetails
A component metadata rule details, giving access to the identifier of the component being resolved, the metadata builder, and the repository resource accessor for this.
ComponentMetadataVersionLister
Interface for custom version listers.
ComponentModelBasePlugin
Base plugin for component support.
ComponentModelBasePlugin.PluginRules
ComponentModelBasePlugin.PluginRules.AttachInputs
ComponentModuleMetadata
Contains immutable component module metadata information.
ComponentModuleMetadataDetails
Contains and allows configuring component module metadata information.
ComponentModuleMetadataHandler
Allows to modify the metadata of depended-on software components.
ComponentReport
Deprecated.
ComponentResult
The result of resolving a component.
ComponentSelection
Represents a tuple of the component selector of a module and a candidate version to be evaluated in a component selection rule.
ComponentSelectionCause
The possible component selection causes.
ComponentSelectionDescriptor
A component selection description, which wraps a cause with an optional custom description.
ComponentSelectionReason
Answers the question why a component was selected during the dependency resolution.
ComponentSelectionRules
Represents a container for component selection rules.
ComponentSelector
Represents some opaque criteria used to select a component instance during dependency resolution.
ComponentSelector
Represents a component selector.
ComponentSpec
A software component that is built by Gradle.
ComponentSpecContainer
A container of software components.
ComponentType
Declares a custom `ComponentSpec` type.
ComponentVariantIdentifier
Identifies a variant of a component by component identifier and variant name.
ComponentWithBinaries
Represents a component that is composed of one or more binaries.
ComponentWithCoordinates
Represents a component that determines its publication coordinates.
ComponentWithDependencies
Represents a component with implementation dependencies.
ComponentWithExecutable
Represents a native component that produces an executable.
ComponentWithInstallation
Represents a native component that produces an application installation.
ComponentWithLinkFile
Represents a native component that produces a file to be used at link time.
ComponentWithLinkUsage
Represents a native component whose link time file and dependencies are published for consumption by some other project.
ComponentWithNativeRuntime
Represents a component that produces outputs that run on a native platform.
ComponentWithObjectFiles
Represents a component that produces object files.
ComponentWithOutputs
Represents a component with output files.
ComponentWithRuntimeFile
Represents a native component that produces a file to be used at runtime.
ComponentWithRuntimeUsage
Represents a native component whose runtime file and dependencies are published for consumption by some other project.
ComponentWithSharedLibrary
Represents a native component that produces a shared library.
ComponentWithStaticLibrary
Represents a component that produces a static library.
ComponentWithTargetMachines
Represents a component that targets multiple target machines.
ComponentWithVariants
Represents a `SoftwareComponent` that provides one or more mutually exclusive children, or variants.
CompositeSpec<T>
A `Spec` which aggregates a sequence of other `Spec` instances.
Compression
Specifies the compression which should be applied to a TAR archive.
ConfigFile
A configuration file generated for Visual Studio.
Configurable<T>
An object that can be configured with a Groovy closure.
ConfigurableFileCollection
A `ConfigurableFileCollection` is a mutable `FileCollection`.
ConfigurableFilePermissions
Provides the means of specifying file and directory access permissions for all classes of system users.
ConfigurableFileTree
A `FileTree` with a single base directory, which can be configured and modified.
ConfigurableIncludedBuild
A build that is to be included in the composite.
ConfigurableIncludedPluginBuild
A plugin build that is to be included in the composite.
ConfigurableLauncher<T>
A `ConfigurableLauncher` allows you to configure a long running operation.
ConfigurablePublishArtifact
A `PublishArtifact` whose properties can be modified.
ConfigurableReport
A file based report to be created with a configurable destination.
ConfigurableUserClassFilePermissions
Provides the means of specifying file and directory access permissions for a certain class of users (see `ConfigurableFilePermissions`).
Configuration
A `Configuration` represents a group of artifacts and their dependencies.
Configuration.State
The states a configuration can be into.
ConfigurationContainer
A `ConfigurationContainer` is responsible for declaring and managing configurations.
ConfigurationCycleException
Thrown when a cycle is encountered while configuring a model element.
ConfigurationPublications
Represents the outgoing artifacts associated with a configuration.
ConfigurationReports
The reporting configuration for any `AbstractConfigurationReportTask`.
ConfigurationVariant
Represents some variant of an outgoing configuration.
ConfigurationVariantDetails
The details object used to determine what to do with a configuration variant when publishing.
Console
Attached to a task property to indicate that the property is not to be taken into account for up-to-date checking, because its value only influences the console output of the task.
ConsoleOutput
Specifies how to treat color and dynamic console output.
ConsoleUnicodeSupport
Specifies how to use Unicode characters in console output.
ConsumableConfiguration
A `Configuration` which can be consumed via Publishing and Dependency Management.
Container
A container classpath entry.
ContentFilterable
Represents some binary resource whose content can be filtered.
ContextualLabel
Represents a contextual label.
ConventionReportTask
The base class for all project based report tasks with custom task actions.
Copy
Copies files into a destination directory.
CopyProcessingSpec
Specifies the destination of a copy.
CopySourceSpec
Specifies sources for a file copy.
CopySpec
A set of specifications for copying files.
CoreJavadocOptions
Provides the core Javadoc Options.
CPlugin
A plugin for projects wishing to build native binary components from C sources.
CppApplication
Configuration for a C++ application, defining the source files that make up the application plus other settings.
CppApplication
A C++ application.
CppApplicationPlugin
A plugin that produces a native application from C++ source.
CppBasePlugin
A common base plugin for the C++ executable and library plugins
CppBinary
A binary built from C++ source and linked from the resulting object files.
CppBinary
Represents a C++ binary.
CppCompile
Compiles C++ source files into object files.
CppComponent
Configuration for a C++ component, such as a library or executable, defining the source files and private header directories that make up the component.
CppComponent
Represents a C++ component.
CppExecutable
An executable built from C++ source.
CppExecutable
A C++ executable binary.
CppLangPlugin
Adds core C++ language support.
CppLangPlugin.Rules
CppLibrary
Configuration for a C++ library, defining the source files and header directories that make up the library plus other settings.
CppLibrary
A C++ library.
CppLibraryPlugin
A plugin that produces a native library from C++ source.
CppPlatform
A target platform for building C++ binaries.
CppPlugin
A plugin for projects wishing to build native binary components from C++ sources.
CppPreCompiledHeaderCompile
Compiles C++ header source files into object files.
CppProject
Details about the C++ components of a Gradle project.
CppSharedLibrary
A shared library built from C++ source.
CppSharedLibrary
A C++ shared library binary.
CppSourceSet
A set of C++ source files.
CppStaticLibrary
A static library built from C++ source.
CppStaticLibrary
A C++ static library binary.
CppTestExecutable
A test executable with tests implemented in C++.
CppTestSuite
A C++ test suite.
CppTestSuite
A C++ test suite.
CppUnitTestPlugin
A plugin that sets up the infrastructure for testing C++ binaries using a simple test executable.
CPreCompiledHeaderCompile
Compiles C header source files into object files.
CreateStartScripts
Legacy class for binary compatibility.
CreateStartScripts
Creates start scripts for launching JVM applications.
CreateStaticLibrary
Assembles a static library from object files.
Credentials
Base interface for credentials used for different authentication purposes.
CSourceSet
A set of C source files.
CUnitConventionPlugin
A plugin that applies the `CUnitPlugin` and adds conventions on top of it.
CUnitConventionPlugin.Rules
CUnitPlugin
A plugin that sets up the infrastructure for testing native binaries with CUnit.
CUnitPlugin.Rules
CUnitTestSuiteBinarySpec
An executable which run a CUnit test suite.
CUnitTestSuiteSpec
Test suite of CUnit tests.
CustomAdditionalData
Custom Additional data for a problem.
CustomizableHtmlReport
A HTML Report whose generation can be customized with a XSLT stylesheet.
DebugOptions
Debug options for Java compilation.
Defaults
Denotes that the `RuleSource` method rule carrying this annotation initializes the rule subject with default values.
DefaultSignatureTypeProvider
The default `SignatureTypeProvider` implementation including support for `BinarySignatureType` and `ArmoredSignatureType` signatures.
DefaultTask
`DefaultTask` is the standard `Task` implementation.
Delete
Deletes files or directories.
DeleteSpec
A specification for deleting files from the filesystem.
Dependencies
Universal APIs that are available for all `dependencies` blocks.
DependenciesMetadata<T>
Describes metadata about a dependency - direct dependencies or dependency constraints - declared in a resolved component's metadata.
Dependency
A `Dependency` represents a dependency on the artifacts from a particular source.
Dependency
Represents a dependency of an IDEA module.
Dependency
Represents an artifact dependency.
DependencyArtifact
Data class that represents an artifact included in a `Dependency`.
DependencyArtifactSelector
Details about an artifact selection in the context of a dependency substitution.
DependencyCollector
A `DependencyCollector` is used as part of a dependencies block in the DSL.
DependencyConstraint
Represents a constraints over all, including transitive, dependencies.
DependencyConstraintFactory
Factory class for creating `DependencyConstraint` instances, with strong typing.
DependencyConstraintHandler
A `DependencyConstraintHandler` is used to declare dependency constraints.
DependencyConstraintMetadata
Describes a dependency constraint declared in a resolved component's metadata, which typically originates from a component descriptor (Gradle metadata file).
DependencyConstraintSet
A set of dependency constraint definitions that are associated with a configuration.
DependencyConstraintsMetadata
Describes the dependency constraints of a variant declared in a resolved component's metadata, which typically originate from a component descriptor (Gradle metadata file).
DependencyFactory
Factory class for creating `Dependency` instances, with strong typing.
DependencyHandler
A `DependencyHandler` is used to declare dependencies.
DependencyInsightReportTask
Generates a report that attempts to answer questions like: Why is this dependency in the dependency graph? Exactly which dependencies are pulling this dependency into the graph? What is the actual version (i.e.
DependencyLockingHandler
A `DependencyLockingHandler` manages the behaviour and configuration of dependency locking.
DependencyMetadata<SELF>
Describes a metadata about a dependency - direct dependency or dependency constraint - declared in a resolved component's metadata.
DependencyModifier
A `DependencyModifier` defines how to modify a dependency inside a custom `dependencies` block to select a different variant.
DependencyReportContainer
The set of reports that can be generated by the `HtmlDependencyReportTask` task type.
DependencyReportTask
Displays the dependency tree for a project.
DependencyResolutionListener
A `DependencyResolutionListener` is notified as dependencies are resolved.
DependencyResolutionManagement
Allows configuring dependency resolution for all projects of the build.
DependencyResolveDetails
Provides details about a dependency when it is resolved.
DependencyResult
An edge in the dependency graph.
DependencyScopeConfiguration
A `Configuration` which collects dependencies, dependency constraints, and exclude rules.
DependencySet
A set of artifact dependencies.
DependencySpec
A dependency onto a Gradle component.
DependencySpecBuilder
A builder of a `DependencySpec`.
DependencySpecContainer
A container for dependency specifications.
DependencySubstitution
Provides means to substitute a different dependency during resolution.
DependencySubstitutions
Allows replacing dependencies with other dependencies.
DependencySubstitutions.Substitution
Provides a DSL-friendly mechanism for specifying the target of a substitution.
DependencyVerificationMode
The different dependency verification modes.
DependentComponentsReport
Deprecated.
DependentSourceSet
A source set that can have dependencies on other Libraries.
DependentSourceSet
A source set that depends on one or more `NativeDependencySet`s to be built.
DeploymentDescriptor
A deployment descriptor such as application.xml.
Describable
Types can implement this interface when they provide a human-readable display name.
Destination
Enumerates possible output streams for `TestOutputEvent`.
Destroys
Marks a property as specifying a file or directory that a task destroys.
Details
Represents a problem details.
DigestAuthentication
Authentication scheme for digest access authentication over HTTP.
DirectDependenciesMetadata
Describes the dependencies of a variant declared in a resolved component's metadata, which typically originate from a component descriptor (Gradle metadata file, Ivy file, Maven POM).
DirectDependencyMetadata
Describes a dependency declared in a resolved component's metadata, which typically originates from a component descriptor (Gradle metadata file, Ivy file, Maven POM).
Directory
Represents a directory at some fixed location on the file system.
DirectoryBuildCache
Configuration object for the local directory build cache.
DirectoryProperty
Represents some configurable directory location, whose value is mutable.
DirectoryReport
A directory based report to be created.
DirectorySource
Directory-based test source.
DirectorySource
Directory-based test source.
DirectoryTree
A directory with some associated include and exclude patterns.
DisableCachingByDefault
Attached to a task or artifact transform type to indicate that task output caching should be disabled by default for work of this type.
DisambiguationRuleChain<T>
A chain of disambiguation rules.
Distribution
A distribution allows to bundle an application or a library including dependencies, sources...
DistributionBasePlugin
A plugin that configures rules allowing projects to be packaged as a distribution.
DistributionContainer
A `DistributionContainer` manages a set of `Distribution` objects.
DistributionPlugin
Applies the `DistributionBasePlugin` and adds a conventional `main` distribution.
DocLink
A link to a documentation page.
DocsType
Attributes to qualify the type of documentation.
DocumentationLink
Represents documentation link.
DomainObjectCollection<T>
A `DomainObjectCollection` is a specialised `Collection` that adds the ability to receive modification notifications and use live filtered sub collections.
DomainObjectSet<T>
A `DomainObjectSet` is a specialization of `DomainObjectCollection` that guarantees `Set` semantics.
DomainObjectSet<T>
A set of domain objects of type T.
DuplicateFileCopyingException
Thrown when more than one file with the same relative path name is to be copied and the `DuplicatesStrategy` is set to DuplicatesStrategy.FAIL
DuplicatesStrategy
Strategies for dealing with the potential creation of duplicate files or archive entries.
Each
Signals that a `RuleSource` rule should be applied to all matching descendant elements of the scope instead of the scope itself.
Ear
Assembles an EAR archive.
EarModule
A module element in a deployment descriptor like application.xml.
EarPlugin
A `Plugin` with tasks which assemble a web application into a EAR file.
EarSecurityRole
A security-role element in a deployment descriptor like application.xml.
EarWebModule
A module element in a deployment descriptor like application.xml that has a web child element.
EclipseBuildCommand
An Eclipse build command is a reference to a project builder object which automatically executes whenever a resource in the associate project changes.
EclipseClasspath
The build path settings for the generated Eclipse project.
EclipseClasspathContainer
Eclipse classpath entry used by third-party plugins to contribute to the project's classpath.
EclipseClasspathEntry
An element that can have classpath attributes.
EclipseExternalDependency
Represents an Eclipse-specific external artifact dependency.
EclipseJavaSourceSettings
Describes Eclipse Java source settings for compiling and running some Java source code.
EclipseJdt
Enables fine-tuning jdt details of the Eclipse plugin
EclipseLinkedResource
Linked resources are files and folders that are stored in locations in the file system outside of the project's location.
EclipseModel
DSL-friendly model of the Eclipse project information.
EclipseOutputLocation
The output location of an Eclipse project.
EclipsePlugin
A plugin which generates Eclipse files.
EclipseProject
Enables fine-tuning project details (.project file) of the Eclipse plugin
EclipseProject
The complete model of an Eclipse project.
EclipseProjectDependency
Represents a dependency on another Eclipse project.
EclipseProjectNature
An Eclipse project nature definition.
EclipseRuntime
Information about the eclipse instance.
EclipseSourceDirectory
A source directory in an Eclipse project.
EclipseWorkspace
Information about the eclipse workspace.
EclipseWorkspaceProject
Information about a project in the eclipse workspace.
EclipseWtp
Enables fine-tuning wtp/wst details of the Eclipse plugin
EclipseWtpComponent
Enables fine-tuning wtp component details of the Eclipse plugin
EclipseWtpFacet
Enables fine-tuning wtp facet details of the Eclipse plugin
EclipseWtpPlugin
A plugin which configures the Eclipse Web Tools Platform.
EditorPosition
Position in the editor.
EditorReport
Report to the editor.
EditorReportSeverity
Severity of an editor report.
Element
Described model element.
EmptyFileVisitor
The EmptyFileVisitor can be extends by implementations that only require to implement one of the 2 visit methods (dir or file).
ExcludeRule
An `ExcludeRule` is used to describe transitive dependencies that should be excluded when resolving dependencies.
ExcludeRuleContainer
A container for adding exclude rules for dependencies.
ExclusiveContentRepository
Describes one or more repositories which together constitute the only possible source for an artifact, independently of the others.
Exec
Executes a command line process.
ExecOperations
Process execution operations.
ExecOutput
Provides lazy access to the output of the external process.
ExecOutput.StandardStreamContent
A handle to access content of the process' standard stream (the standard output of the standard error output).
ExecResult
Represents the result of running an external process.
ExecSpec
Specified the options for executing some command.
ExpandDetails
Additional configuration parameters for `ContentFilterable.expand(Map, Action)` action.
ExtensiblePolymorphicDomainObjectContainer<T>
A `PolymorphicDomainObjectContainer` that can be extended at runtime to create elements of new types.
ExtensionAware
Objects that can be extended at runtime with other objects.
ExtensionContainer
Allows adding 'namespaced' DSL extensions to a target object.
ExtensionsSchema
Schema of extensions.
ExtensionsSchema.ExtensionSchema
Schema of an extension.
ExternalDependency
An `ExternalDependency` is a `Dependency` on a source outside the current project hierarchy.
ExternalDependency
Represents an external artifact dependency.
ExternalModuleDependency
A `ExternalModuleDependency` is a `Dependency` on a module outside the current project hierarchy.
ExternalModuleDependencyBundle
A bundle is a list of dependencies which are always added together.
ExternalModuleDependencyVariantSpec
The specification of a dependency variant.
ExtractSymbols
Extracts the debug symbols from a binary and stores them in a separate file.
ExtraPropertiesExtension
Additional, ad-hoc, properties for Gradle domain objects.
ExtraPropertiesExtension.UnknownPropertyException
The exception that will be thrown when an attempt is made to read a property that is not set.
Facet
A project facet.
Facet.FacetType
An `installed` facet is really present on an Eclipse project whereas facet type `fixed` means that this facet is locked and cannot be simply removed.
Failure
Represents a failure.
FailureResult
Describes how an operation finished with failures.
FeatureSpec
Handler for configuring features, which may contribute additional configurations, publications, dependencies, ...
FetchModelResult<M>
Carries the result of a single model fetch operation.
FileChange
A change to a file.
FileCollection
A `FileCollection` represents a collection of file system locations which you can query in certain ways.
FileCollection.AntType
Ant types which a `FileCollection` can be mapped to.
FileCollectionDependency
A `FileCollectionDependency` is a `Dependency` on a collection of local files which are not stored in a repository.
FileComparisonTestAssertionFailure
Represent a test assertion failure where the test fails due to a broken assertion.
FileContentMerger
Models the generation/parsing/merging capabilities.
FileContents
Provides lazy access to the contents of a given file.
FileCopyDetails
Provides details about a file or directory about to be copied, and allows some aspects of the destination file to be modified.
FileDownloadFinishEvent
An event that indicates the completion of a file download.
FileDownloadNotFoundResult
The result of a file download operation with file not found.
FileDownloadOperationDescriptor
Describes the details of a file that is downloaded.
FileDownloadProgressEvent
An event related to the progress of file download.
FileDownloadResult
The result of a file download operation.
FileDownloadStartEvent
An event that indicates the start of a file download.
FileLocation
A file location.
FileLocation
A file location.
FileNormalizer
A normalizer used to remove unwanted noise when considering file inputs.
FilePath
A Path that keeps the reference to the File
FilePermissions
Describes file and directory access permissions for all classes of system users.
FilePosition
Position inside a file represented by line and column numbers.
FilePosition
Position inside a file represented by line and column numbers.
FileReference
A reference to a file in eclipse.
FileSource
A test source defined by a single file.
FileSource
A test source defined by a single file.
FileSystemLocation
Represents some immutable location on the file system.
FileSystemLocationProperty<T>
Represents some element of the file system.
FileSystemOperations
Operations on the file system.
FilesystemSource
Filesystem-based test source.
FilesystemSource
Filesystem-based test source.
FileTree
A `FileTree` represents a hierarchy of files.
FileTreeElement
Information about a file in a directory/file tree.
FileType
The type of a file.
FileVisitDetails
Provides access to details about a file or directory being visited by a `FileVisitor`.
FileVisitor
A `FileVisitor` is used to visit each of the files in a `FileTree`.
Finalize
Denotes that the `RuleSource` method rule carrying this annotation finalizes the rule subject.
FinishEvent
An event that informs about an operation having finished its execution.
FlatDirectoryArtifactRepository
A repository that looks into a number of directories for artifacts.
Flavor
Defines a custom variant that differentiate a `NativeBinary`.
FlavorContainer
A container of `Flavor`s.
FlowAction<P>
A dataflow action.
FlowActionSpec<P>
Allows configuring the parameters for a `dataflow action`.
FlowParameters
Marker interface for `dataflow action` parameters.
FlowParameters.None
Used for `dataflow actions` without parameters.
FlowProviders
Exposes build lifecycle events as `providers` so they can be used as inputs to `dataflow actions`.
FlowScope
Augments the cached work graph with `dataflow actions`, anonymous, parameterized and isolated pieces of work that are triggered solely based on the availability of their input parameters.
FlowScope.Registration<P>
Represents a registered `dataflow action`.
ForkingWorkerSpec
A worker spec providing the requirements of a forked process.
ForkOptions
Fork options for Java compilation.
FunctionalSourceSet
A container holding `LanguageSourceSet`s with a similar function (production code, test code, etc.).
Gcc
The GNU GCC tool chain.
GccCommandLineToolConfiguration
An executable tool used for GCC that allows customizing the executable.
GccCompatibleToolChain
A ToolChain that can handle additional platforms simply by configuring the NativeBinary.
GccCompilerPlugin
A `Plugin` which makes the GNU GCC/G++ compiler available for compiling C/C++ code.
GccPlatformToolChain
GCC specific settings for the tools used to build for a particular platform.
GeneralComponentSpec
A general purpose component specification, that can be used to represent some software component built from source and producing multiple output variants.
GenerateBuildDashboard
Generates build dashboard report.
GenerateCUnitLauncher
Generated the Gradle CUnit launcher: main method and header.
Generated
Indicates that the annotated member code was generated.
GenerateEclipseClasspath
Generates an Eclipse `.classpath` file.
GenerateEclipseJdt
Generates the Eclipse JDT configuration file.
GenerateEclipseProject
Generates an Eclipse `.project` file.
GenerateEclipseWtpComponent
Generates the org.eclipse.wst.common.component settings file for Eclipse WTP.
GenerateEclipseWtpFacet
Generates the org.eclipse.wst.common.project.facet.core settings file for Eclipse WTP.
GenerateFiltersFileTask
Task for generating a Visual Studio filters file (e.g.
GenerateFiltersFileTask.FiltersSpec
The data to use to generate the filters file.
GenerateIdeaModule
Generates an IDEA module file.
GenerateIdeaProject
Generates an IDEA project file for root project *only*.
GenerateIdeaWorkspace
Generates an IDEA workspace file *only* for root project.
GenerateIvyDescriptor
Generates an Ivy XML Module Descriptor file.
GenerateMavenPom
Generates a Maven module descriptor (POM) file.
GenerateModuleMetadata
Generates a Gradle metadata file to represent a published `SoftwareComponent` instance.
GenerateModuleMetadata.InputState
GenerateModuleMetadata.InputState.ComponentMissing
GenerateModuleMetadata.InputState.Ready
GeneratePluginDescriptors
Generates plugin descriptors from plugin declarations.
GenerateProjectFileTask
Task for generating a Visual Studio project file (e.g.
GenerateProjectFileTask.ProjectSpec
The data to use to generate the project file.
GenerateSchemeFileTask
Task for generating a Xcode scheme file (e.g.
GenerateSolutionFileTask
Task for generating a Visual Studio solution file (e.g.
GenerateSolutionFileTask.SolutionSpec
The data to use to generate the solution file.
GenerateSwiftPackageManagerManifest
A task that produces a Swift Package Manager manifest.
GenerateWorkspaceSettingsFileTask
Task for generating a Xcode workspace settings file (e.g.
GenerateXcodeProjectFileTask
Task for generating a Xcode project file (e.g.
GenerateXcodeWorkspaceFileTask
Task for generating a Xcode workspace file (e.g.
GeneratorTask<T>
A `GeneratorTask` generates a configuration file based on a domain object of type T.
GitVersionControlSpec
A specification of a Git repository.
GoogleTestConventionPlugin
A plugin that applies the `GoogleTestPlugin` and adds conventions on top of it.
GoogleTestConventionPlugin.Rules
GoogleTestPlugin
A plugin that sets up the infrastructure for testing native binaries with GoogleTest.
GoogleTestPlugin.Rules
GoogleTestTestSuiteBinarySpec
An executable which run a Google Test test suite.
GoogleTestTestSuiteSpec
Test suite of Google Test tests.
Gradle
Represents an invocation of Gradle.
GradleBuild
Executes a Gradle build.
GradleBuild
Provides information about the structure of a Gradle build.
GradleConnectionException
Thrown when there is some problem using a Gradle connection.
GradleConnector
A `GradleConnector` is the main entry point to the Gradle tooling API.
GradleDependencies
Dependency APIs available for `dependencies` blocks that can build software that relies on Gradle APIs.
GradleDslBaseScriptModel
This interface represents the base Kotlin DSL script models.
GradleEnvironment
Informs about the Gradle environment, for example the Gradle version.
GradleException
`GradleException` is the base class of all exceptions thrown by Gradle.
GradleLifecycle
Gradle lifecycle callbacks compatible with `Configuration Cache` and `Isolated Projects`.
GradleModuleVersion
Informs about a module version, i.e.
GradlePluginApiVersion
Represents a version of the minimal version of the Gradle API required by (variant of) a Gradle plugin.
GradlePluginDevelopmentExtension
Configuration options for the `JavaGradlePluginPlugin`.
GradleProject
Represents a Gradle project.
GradlePublication
Represents some publication produced by a Gradle project, typically to a Maven or Ivy repository.
GradleRunner
Executes a Gradle build, allowing inspection of the outcome.
GradleScript
Represents a Gradle script.
GradleScriptException
A `GradleScriptException` is thrown when an exception occurs in the compilation or execution of a script.
GradleTask
Represents a task which is executable by Gradle.
GradleVersion
Represents a Gradle version.
GroovyBasePlugin
Extends `JavaBasePlugin` to provide support for compiling and documenting Groovy source files.
GroovyCompile
Compiles Groovy source files, and optionally, Java source files.
GroovyCompileOptions
Compilation options to be passed to the Groovy compiler.
Groovydoc
Generates HTML API documentation for Groovy source, and optionally, Java source.
Groovydoc.Link
A Link class represent a link between groovydoc/javadoc output and url.
GroovydocAccess
Represents the setting for the access levels that are included in the Groovydoc.
GroovyDslBaseScriptModel
This interface describes the Groovy DSL specific part of `GradleDslBaseScriptModel`.
GroovyForkOptions
Fork options for Groovy compilation.
GroovyPlugin
A `Plugin` which extends the `JavaPlugin` to provide support for compiling and documenting Groovy source files.
GroovyRuntime
Provides information related to the Groovy runtime(s) used in a project.
GroovySourceDirectorySet
Represents a Groovy source set.
GroupTestEventReporter
Reports test events, and child test event reporters.
HasAttributes
Represents something that carries attributes by utilizing an `AttributeContainer`
HasConfigurableAttributes<SELF>
Represents something that carries attributes by utilizing an `AttributeContainer` that is configurable.
HasConfigurableValue
Represents an object that holds a value that is configurable, meaning that the value or some source for the value, such as a `Provider`, can be specified directly on the object.
HasGradleProject
An element that is associated with a Gradle project.
HasImplicitReceiver
Marks a SAM interface as a target for lambda expressions / closures where the single parameter is passed as the implicit receiver of the invocation (`this` in Kotlin, `delegate` in Groovy) as if the lambda expression was an extension method of the parameter type.
HasMultipleValues<T>
Represents a property whose value can be set using multiple elements of type `HasMultipleValues`, such as a collection property.
HasPublicType
Allows a scriptable object, such as a project extension, to declare its preferred public type.
HeaderExportingSourceSet
A source set that exposes headers
Help
Provides user help content similar to what `gradle --help` provides on the CLI.
HelpTasksPlugin
Adds various reporting tasks that provide information about the project.
HierarchicalEclipseProject
Represents the basic information about an Eclipse project.
HierarchicalElement
Represents an element which belongs to some hierarchy.
HtmlDependencyReportTask
Generates an HTML dependency report.
HttpBuildCache
Configuration object for the HTTP build cache.
HttpBuildCacheCredentials
Credentials for authenticating with an HTTP build cache.
HttpHeaderAuthentication
Authentication scheme for HTTP header authentication over HTTP.
HttpHeaderCredentials
Credentials that can be used to login to a protected server, e.g.
IdeaCompilerOutput
IDEA compiler output settings.
IdeaContentRoot
Contains content root information.
IdeaDependency
IDEA dependency.
IdeaDependencyScope
The scope of the IDEA dependency.
IdeaJavaLanguageSettings
Describes Java language settings for an IDEA module.
IdeaLanguageLevel
Java language level used by IDEA projects.
IdeaLanguageLevel
Language level setting for IDEA.
IdeaModel
DSL-friendly model of the IDEA project information.
IdeaModule
Enables fine-tuning module details (*.iml file) of the IDEA plugin.
IdeaModule
Represents information about the IDEA module.
IdeaModuleDependency
Dependency on a module in a project.
IdeaModuleIdentifier
Identifies an Idea module.
IdeaModuleIml
Models the generation/parsing/merging capabilities of an IDEA module.
IdeaPlugin
Adds a GenerateIdeaModule task.
IdeaProject
Enables fine-tuning project details (*.ipr file) of the IDEA plugin.
IdeaProject
Represents the information about the IDEA project.
IdeaSingleEntryLibraryDependency
"Single-Entry Module Library" as IDEA calls it.
IdeaSourceDirectory
IDEA source directory.
IdeaWorkspace
Enables fine-tuning workspace details (*.iws file) of the IDEA plugin.
IdeWorkspace
Represents an IDE "workspace" that is generated by Gradle and can be opened in the IDE.
IgnoreEmptyDirectories
Attached to an input property to specify that directories should be ignored when snapshotting inputs.
IllegalDependencyNotation
This exceptions is thrown, if a dependency is declared with a illegal notation.
IncludedBuild
A build that is included in the composite.
InclusiveRepositoryContentDescriptor
Descriptor of a repository content, used to avoid reaching to an external repository when not needed.
Incremental
Track input changes for the annotated parameter.
IncrementalCompileOptions
Options for incremental compilation of Scala code.
Incubating
Indicates that a feature is incubating.
InitBuild
Generates a Gradle project structure.
InjectedPluginDependencies
The DSL for declaring plugins to inject into an included build.
InjectedPluginDependency
Specification of a dependency on a plugin injected into an included build.
InjectionPointQualifier
The annotated annotation can be used to inject elements of the supported types.
Input
Attached to a task property to indicate that the property specifies some input value for the task.
InputArtifact
Attach this annotation to an abstract getter that should receive the input artifact for an artifact transform.
InputArtifactDependencies
Attach this annotation to an abstract getter that should receive the artifact dependencies of the `InputArtifact` of an artifact transform.
InputChanges
Provides access to any input files that need to be processed by an incremental work action.
InputDirectory
Marks a property as specifying an input directory for a task.
InputFile
Marks a property as specifying an input file for a task.
InputFileDetails
A change to an input file.
InputFiles
Marks a property as specifying the input files for a task.
InputNormalization
Input normalization configuration.
InputNormalizationHandler
Used to configure input normalization.
InsecureProtocolOption
Options for handling insecure protocols when generating a project with repositories.
InstalledJdk
Represents a Java Development Kit machine installation.
InstallExecutable
Installs an executable with it's dependent libraries so it can be easily executed.
InstallXCTestBundle
Creates a XCTest bundle with a run script so it can be easily executed.
IntermediateResultHandler<T>
A handler for an intermediate result obtained by a `BuildActionExecuter`.
Internal
Attached to a task property to indicate that the property is not to be taken into account for up-to-date checking.
InvalidActionClosureException
Thrown when a `Closure` is given as an `Action` implementation, but has the wrong signature.
InvalidIvyPublicationException
Thrown when attempting to publish with an invalid `IvyPublication`.
InvalidMavenPublicationException
Thrown when attempting to publish with an invalid `MavenPublication`.
InvalidModelException
Thrown when a component model is declared in an invalid way.
InvalidModelRuleDeclarationException
Thrown when a model rule, or source of model rules, is declared in an invalid way.
InvalidModelRuleException
Thrown when there is a problem with the usage of a model rule.
InvalidPluginException
Thrown when a plugin is found to be invalid when it is loaded.
InvalidPluginMetadataException
Thrown when the plugin under test metadata cannot be read.
InvalidRunnerConfigurationException
Thrown when a build cannot be executed due to the runner being in an invalid state.
InvalidUserCodeException
A `InvalidUserCodeException` is thrown when user-provided code cannot be executed.
InvalidUserDataException
A `InvalidUserDataException` is thrown, if a user is providing illegal data for the build.
IsolatedAction<T>
Defines an action that is applied to objects of type `IsolatedAction`, with each target getting its own isolated action instance.
IsolatedProject
An isolated view of `Project` that exposes only those properties that are safe to access from outside of `this` project, from the perspective of isolated projects.
IvyArtifact
An artifact published as part of a `IvyPublication`.
IvyArtifactRepository
An artifact repository which uses an Ivy format to store artifacts and meta-data.
IvyArtifactRepository.MetadataSources
Allows configuring the sources of metadata for a specific repository.
IvyArtifactRepositoryMetaDataProvider
The meta-data provider for an Ivy repository.
IvyArtifactSet
A Collection of `IvyArtifact`s to be included in an `IvyPublication`.
IvyConfiguration
A configuration included in an `IvyPublication`, which will be published in the ivy descriptor file generated.
IvyConfigurationContainer
The set of `IvyConfiguration`s that will be included in the `IvyPublication`.
IvyDescriptorArtifact
An Ivy descriptor artifact.
IvyExtraInfo
Represents the set of "extra" info elements in the Ivy descriptor.
IvyExtraInfoSpec
Represents a modifiable form of IvyExtraInfo so that "extra" info elements can be configured on an Ivy publication.
IvyModule
An Ivy Module component.
IvyModuleDescriptor
The metadata about an Ivy module that acts as an input to a component metadata rule.
IvyModuleDescriptorAuthor
An author of an Ivy publication.
IvyModuleDescriptorDescription
The description of an Ivy publication.
IvyModuleDescriptorLicense
A license of an Ivy publication.
IvyModuleDescriptorSpec
The descriptor of any Ivy publication.
IvyPatternRepositoryLayout
A repository layout that uses user-supplied patterns.
IvyPluginPublishingPlugin
IvyPublication
An `IvyPublication` is the representation/configuration of how Gradle should publish something in Ivy format, to an Ivy repository.
IvyPublishPlugin
Adds the ability to publish in the Ivy format to Ivy repositories.
JacocoBase
Base class for Jacoco tasks.
JacocoCoverageReport
A container for the inputs of an aggregated JaCoCo code coverage report.
JacocoCoverageVerification
Task for verifying code coverage metrics.
JacocoLimit
Defines a Jacoco rule limit.
JacocoPlugin
Plugin that provides support for generating Jacoco coverage data.
JacocoPluginExtension
Extension including common properties and methods for Jacoco.
JacocoReport
Task to generate HTML, Xml and CSV reports of Jacoco coverage data.
JacocoReportAggregationPlugin
Adds configurations to for resolving variants containing JaCoCo code coverage results, which may span multiple subprojects.
JacocoReportBase
Base class for Jacoco report tasks.
JacocoReportsContainer
The reporting configuration for the `JacocoReport` task.
JacocoTaskExtension
Extension for tasks that should run with a Jacoco agent to generate coverage execution data.
JacocoTaskExtension.Output
The types of output that the agent can use for execution data.
JacocoViolationRule
Defines a Jacoco violation rule.
JacocoViolationRulesContainer
The violation rules configuration for the `JacocoReport` task.
Jar
Assembles a JAR archive.
Jar
Assembles a JAR archive.
JarDirectory
Represents a jar directory element of an idea module library.
JavaApplication
Configuration for a Java application, defining how to assemble the application.
JavaAppStartScriptGenerationDetails
Details for generating Java-based application start scripts.
JavaBasePlugin
A `Plugin` which compiles and tests Java source, and assembles it into a JAR file.
JavaCompile
Compiles Java source files.
JavaCompiler
A java compiler used by compile tasks.
JavaCompileTaskOperationResult
Describes the result of a `JavaCompile` task.
JavaCompileTaskOperationResult.AnnotationProcessorResult
The results of an annotation processor used during compilation.
JavaCompileTaskOperationResult.AnnotationProcessorResult.Type
Type of annotation processor.
JavaDebugOptions
Contains a subset of the Java Debug Wire Protocol properties.
Javadoc
Generates HTML API documentation for Java classes.
JavadocArtifact
An artifact containing Javadoc documentation.
JavadocMemberLevel
This enum maps to the -public, -protected, -package and -private options of the javadoc executable.
JavadocOfflineLink
This class is used to hold the information that can be provided to the javadoc executable via the -linkoffline option.
JavadocOptionFileOption<T>
Represents a Javadoc command-line option.
JavadocOutputLevel
This enum maps to the -verbose and -quiet options of the javadoc executable.
JavadocTool
Generates HTML API documentation for Java classes.
JavaEnvironment
Informs about the Java environment, for example the Java home or the JVM args used.
JavaExec
Executes a Java application in a child process.
JavaExecSpec
Specifies the options for executing a Java application.
JavaForkOptions
Specifies the options to use to fork a Java process.
JavaGradlePluginPlugin
A plugin for building java gradle plugins.
JavaGradlePluginPlugin.ClassManifestCollectorAction
A file copy action that collects class file paths as they are added to the jar.
JavaGradlePluginPlugin.PluginDescriptorCollectorAction
A file copy action that collects plugin descriptors as they are added to the jar.
JavaGradlePluginPlugin.PluginValidationAction
Implements plugin validation tasks to validate that a proper plugin jar is produced.
JavaGradlePluginPlugin.PluginValidationActionsState
A state shared by the validation process.
JavaGradlePluginPlugin.TestKitAndPluginClasspathDependenciesAction
An action that automatically declares the TestKit dependency for the test compile configuration and a dependency on the plugin classpath manifest generation task for the test runtime configuration.
JavaInstallationMetadata
Metadata about a Java tool obtained from a toolchain.
JavaLanguageVersion
Represents a Java Language version
JavaLauncher
A java executable used to execute applications or run tests.
JavaLibraryDistributionPlugin
A `Plugin` which package a Java project as a distribution including the JAR and runtime dependencies.
JavaLibraryPlugin
A `Plugin` which extends the capabilities of the `Java plugin` by cleanly separating the API and implementation dependencies of a library.
JavaPlatformExtension
The extension to configure a Java platform project.
JavaPlatformPlugin
The Java platform plugin allows building platform components for Java, which are usually published as BOM files (for Maven) or Gradle platforms (Gradle metadata).
JavaPlugin
A `Plugin` which compiles and tests Java source, and assembles it into a JAR file.
JavaPluginExtension
Common configuration for JVM (Java) based projects.
JavaResolutionConsistency
Dependency resolution consistency configuration for the Java derived plugins.
JavaRuntime
Represents a Java virtual machine installation.
JavaTestFixturesPlugin
Adds support for producing test fixtures.
JavaToolchainDownload
The response provided by a `JavaToolchainResolver` to a specific `JavaToolchainRequest`.
JavaToolchainRepository
Named configuration of `JavaToolchainResolver` implementations, identified by their implementation class.
JavaToolchainRepositoryHandler
`NamedDomainObjectList` based handler for configuring an ordered collection of `JavaToolchainRepository` implementations.
JavaToolchainRequest
Describes Java toolchains that need to be auto-provisioned, including their properties (see `JavaToolchainSpec`} and the build environment they are needed in.
JavaToolchainResolver
Interface that needs to be implemented by Java toolchain provisioning plugins.
JavaToolchainResolverRegistry
The build level object/service provided by Gradle which Java toolchain provisioning plugins can access to register their `JavaToolchainResolver` implementations/build services into.
JavaToolchainService
Allows to query for toolchain managed tools, like `JavaCompiler`, `JavaLauncher` and `JavadocTool`.
JavaToolchainSpec
Requirements for selecting a Java toolchain.
JavaVersion
An enumeration of Java versions.
Jdk
Represents information for the project Java SDK.
Jdt
Represents the Eclipse JDT settings.
JUnitOptions
The JUnit specific test options.
JUnitPlatformOptions
The JUnit platform specific test options.
JUnitXmlReport
The JUnit XML files, commonly used to communicate results to CI servers.
JvmComponentDependencies
This DSL element is used to add dependencies to a component, for instance a `TestSuite` `implementation` dependencies are used at compilation and runtime. `compileOnly` dependencies are used only at compilation and are not available at runtime. `runtimeOnly` dependencies are not available at compilation and are used only at runtime. `annotationProcessor` dependencies are used only at compilation for the annotation processor classpath
JvmEcosystemPlugin
A base plugin for projects working in a JVM world.
JvmImplementation
Represents a filter for a implementation of a Java Virtual Machine.
JvmLibrary
A Library component that runs on the Java Virtual Machine.
JvmTestKind
Enumerates the different kinds of JVM tests.
JvmTestOperationDescriptor
Describes a test that runs on the JVM and for which an event has occurred.
JvmTestSuite
A test suite is a collection of JVM-based tests.
JvmTestSuitePlugin
A `Plugin` that adds extensions for declaring, compiling and running `JvmTestSuite`s.
JvmTestSuiteTarget
Defines the target environment against which a `JvmTestSuite` will be run.
JvmToolchainManagement
Dynamic extension added to `ToolchainManagement` at runtime, by the `jvm-toolchain-management` plugin.
JvmToolchainManagementPlugin
A plugin that provides JVM specific `ToolchainManagement` configuration.
JvmToolchainsPlugin
A plugin that provides JVM toolchains for projects that need to execute Java from local JVM installations or run the tools included in a JDK.
JvmVendorSpec
Represents a filter for a vendor of a Java Virtual Machine implementation.
KeepAliveMode
Describes whether a Scala compiler daemon should be reused.
KotlinDslBaseScriptModel
This interface describes the Kotlin DSL specific part of `GradleDslBaseScriptModel`.
KotlinDslModelsParameters
Parameters for Kotlin DSL models.
KotlinDslScriptModel
Model for a Kotlin DSL script.
KotlinDslScriptsModel
Editor model for a set of Kotlin DSL scripts.
LanguageBasePlugin
Base plugin for language support.
LanguageBasePlugin.Rules
LanguageSourceSet
A set of sources for a programming language.
Launchable
Represents an object that can be used to launch a Gradle build, such as a task.
LegacyConfiguration
A `Configuration` with a mutable role, that can potentially perform behavior of a `ConsumableConfiguration`, a `ResolvableConfiguration`, or a `DependencyScopeConfiguration`.
LenientConfiguration
Resolved configuration that does not fail eagerly when some dependencies are not resolved, or some artifacts do not exist.
Library
A library that can be linked into or depended on by another software element.
Library
A classpath entry representing a library.
LibraryBinaryDependencySpec
A dependency onto a specific binary of a library published by a project.
LibraryBinaryIdentifier
An identifier for a library instance that is built as part of the current build.
LibraryBinarySpec
A binary produced from a ``LibrarySpec``.
LibraryComponentSelector
Criteria for selecting a library instance that is built as part of the current build.
LibraryDependencies
Allows the API and implementation dependencies of a library to be specified.
LibraryElements
Attribute representing the technical elements of a library variant.
LibrarySpec
A specification of a `Library`.
LifecycleBasePlugin
A `Plugin` which defines a basic project lifecycle.
LineInFileLocation
A basic location pointing to a specific part of a file using line number, column, and length for coordinates.
LineInFileLocation
A basic location pointing to a specific part of a file using line number, column, and length for coordinates.
Link
Link.
Linkage
Specify how a native library should be linked into another binary.
LinkageDetails
Represents the linkage details for a binary.
LinkExecutable
Links a binary executable from object files and libraries.
LinkMachOBundle
Links a binary bundle from object files and imported libraries.
LinkSharedLibrary
Links a binary shared library from object files and imported libraries.
ListenerFailedException
Thrown whenever a listener fails with an exception, which in general implies that the build completed like it should, but that one of the listeners failed with an exception.
ListProperty<T>
Represents a property whose type is a `List` of elements of type `ListProperty`.
LocalState
Marks a property as specifying local state for a task.
Location
Marker interface for problem location.
LockMode
The supported lock modes: `DEFAULT` will load the lock state and verify resolution matches it `STRICT` in addition to the `DEFAULT` behaviour, will fail resolution if a locked configuration does not have lock state defined `LENIENT` will load the lock state, to anchor dynamic versions, but otherwise be lenient about modifications of the dependency resolution, allowing versions to change and module to be added or removed
Logger
An extension to the SLF4J `Logger` interface, which adds the `quiet` and `lifecycle` log levels.
Logging
The main entry point for Gradle's logging system.
LoggingConfiguration
A `LoggingConfiguration` defines the logging settings for a Gradle build.
LoggingManager
A `LoggingManager` provides access to and control over the Gradle logging system.
LoggingOutput
Provides access to the output of the Gradle logging system.
LogLevel
The log levels supported by Gradle.
LongRunningOperation
Offers ways to communicate both ways with a Gradle operation, be it building a model or running tasks.
MachineArchitecture
Represents a target architecture of a component.
MacroDirective
Represent a macro directive.
Managed
A managed type is transparent to the model space, and enforces immutability at the appropriate times in the object's lifecycle.
ManagedType
Marks Gradle-provided types that can be instantiated via the managed object infrastructure.
Manifest
Represents the manifest file of a JAR file.
ManifestException
Is thrown in the case an operation is applied against a `Manifest` that violates the Manifest specification.
ManifestMergeDetails
Details of a value being merged from two different manifests.
ManifestMergeSpec
Specifies how the entries of multiple manifests should be merged together.
MapBasedBuildCacheService
Simple build cache implementation that delegates to a `ConcurrentMap`.
MapProperty<K,V>
Represents a property whose type is a `Map` of keys of type `MapProperty` and values of type `MapProperty`.
MarkingStrategy
Represents a method of marking a cache directory.
MavenArtifact
An artifact published as part of a `MavenPublication`.
MavenArtifactRepository
An artifact repository which uses a Maven format to store artifacts and meta-data.
MavenArtifactRepository.MetadataSources
Allows configuring the sources of metadata for a specific repository.
MavenArtifactSet
A Collection of `MavenArtifact`s to be included in a `MavenPublication`.
MavenModule
A Maven Module component.
MavenPluginPublishPlugin
MavenPom
The POM for a Maven publication.
MavenPomArtifact
A Maven POM artifact.
MavenPomCiManagement
The CI management system of a Maven publication.
MavenPomContributor
A contributor of a Maven publication.
MavenPomContributorSpec
Allows to add contributors of a Maven publication.
MavenPomDeploymentRepository
The repository information of the Maven `distributionManagement` node.
MavenPomDeveloper
A developer of a Maven publication.
MavenPomDeveloperSpec
Allows to add developers to a Maven publication.
MavenPomDistributionManagement
The distribution management configuration of a Maven publication.
MavenPomIssueManagement
The issue management system of a Maven publication.
MavenPomLicense
A license of a Maven publication.
MavenPomLicenseSpec
Allows to add licenses to a Maven publication.
MavenPomMailingList
A mailing list of a Maven publication.
MavenPomMailingListSpec
Allows to add mailing lists to a Maven publication.
MavenPomOrganization
The organization of a Maven publication.
MavenPomRelocation
The relocation information of a Maven publication that has been moved to a new group and/or artifact ID.
MavenPomScm
The SCM (source control management) of a Maven publication.
MavenPublication
A `MavenPublication` is the representation/configuration of how Gradle should publish something in Maven format.
MavenPublishPlugin
Adds the ability to publish in the Maven format to Maven repositories.
MavenRepositoryContentDescriptor
Extends the repository content descriptor with Maven repositories specific options.
MetadataSupplierAware
Interface for repositories which support custom metadata suppliers and/or version listers.
MetaInfNormalization
Configuration of manifest normalization.
MethodSource
Method-based test source.
MethodSource
Method-based test source.
MicrosoftVisualCppCompilerPlugin
A `Plugin` which makes the Microsoft Visual C++ compiler available to compile C/C++ code.
MinimalExternalModuleDependency
The minimal information Gradle needs to address an external module.
MinimalJavadocOptions
Provides the core Javadoc options.
MissingResourceException
Exception thrown when the resource does not exist
Model
Denotes that the `RuleSource` method rule carrying this annotation creates a new top level element in the model space.
Model
A model that is buildable by the Tooling API.
ModelBuilder<T>
A `ModelBuilder` allows you to fetch a snapshot of some model for a project or a build.
ModelElement
Represents an element in a model.
ModelInstantiationException
Thrown when a model element cannot be instantiated for some reason.
ModelMap<T>
Model backed map like structure allowing adding of items where instantiation is managed.
ModelReport
Deprecated.
ModelReport.Format
The report format.
ModelRuleBindingException
Thrown when there is a problem binding the model element references of a model rule.
ModelSet<T>
A set of managed model objects.
ModelViewClosedException
Thrown when at attempt is made to mutate a subject of a rule after the rule has completed.
ModularitySpec
Description of the modularity of a classpath.
Module
Represents the customizable elements of an iml (via XML hooks everything of the iml is customizable).
ModuleComponentIdentifier
An identifier for a component instance which is available as a module version.
ModuleComponentSelector
Criteria for selecting a component instance that is available as a module version.
ModuleDependency
A `ModuleDependency` is a `Dependency` on a component that exists outside of the current project.
ModuleDependency
Represents an orderEntry of type module in the iml XML.
ModuleDependencyCapabilitiesHandler
The capabilities requested for a dependency.
ModuleDependencySpec
A dependency onto a module.
ModuleDependencySpecBuilder
A builder of a `ModuleDependencySpec`.
ModuleIdentifier
The identifier of a module.
ModuleLibrary
Represents an orderEntry of type module-library in the iml XML.
ModuleVersionIdentifier
The identifier of a module version.
ModuleVersionSelector
Selects a module version.
MultipleCandidatesDetails<T>
Provides context about candidates for an attribute.
MutableCapabilitiesMetadata
Describes the capabilities of a component in a mutable way.
MutableVariantFilesMetadata
Mutable information about the files that belong to a variant.
MutableVersionCatalogContainer
The container for declaring version catalogs
MutableVersionConstraint
A configurable version constraint.
Mutate
Denotes that the `RuleSource` method rule carrying this annotation mutates the rule subject.
Named
Types can implement this interface and use the embedded `Named.Namer` implementation, to satisfy API that calls for a namer.
Named.Namer
An implementation of the namer interface for objects implementing the named interface.
NamedDomainObjectCollection<T>
A `NamedDomainObjectCollection` represents a collection of objects that have an inherent, constant, name.
NamedDomainObjectCollectionSchema
Schema of named domain object collections.
NamedDomainObjectCollectionSchema.NamedDomainObjectSchema
Schema of a named domain object.
NamedDomainObjectContainer<T>
A named domain object container is a specialization of `NamedDomainObjectSet` that adds the ability to create instances of the element type.
NamedDomainObjectFactory<T>
A factory for named objects of type `T`.
NamedDomainObjectList<T>
A specialization of `NamedDomainObjectCollection` that also implements `List`.
NamedDomainObjectProvider<T>
Provides a domain object of the given type.
NamedDomainObjectSet<T>
A specialization of `NamedDomainObjectCollection` that also implements `Set` and orders objects by their inherent name.
Namer<T>
A namer is capable of providing a name based on some inherent characteristic of an object.
Namer.Comparator<T>
A comparator implementation based on the names returned by the given namer.
NativeBasePlugin
A common base plugin for the native plugins.
NativeBasePlugin.LinkageSelectionRule
NativeBinariesTestPlugin
A plugin that sets up the infrastructure for testing native binaries.
NativeBinariesTestPlugin.Rules
NativeBinary
Represents a particular binary artifact.
NativeBinarySpec
Represents a binary artifact that is the result of building a native component.
NativeComponentExtension
The configuration for native components generated by this build.
NativeComponentModelPlugin
A plugin that sets up the infrastructure for defining native binaries.
NativeComponentModelPlugin.Rules
NativeComponentPlugin
A plugin that creates tasks used for constructing native binaries.
NativeComponentSpec
Definition of a software component that is to be built by Gradle to run a on JVM platform.
NativeDependencySet
Models a collection of native type dependencies.
NativeExecutable
An executable native component that is built by Gradle.
NativeExecutableBinary
A binary artifact for a `NativeExecutable`, targeted at a particular platform with specific configuration.
NativeExecutableBinarySpec
An binary built by Gradle for a native application.
NativeExecutableBinarySpec.TasksCollection
Provides access to key tasks used for building the binary.
NativeExecutableFileSpec
Specifies how to build and where to place a native executable file.
NativeExecutableSpec
Definition of a native executable component that is to be built by Gradle.
NativeInstallationSpec
Specifies the installation location for a native executable.
NativeLibrary
A library component that is built by a gradle project.
NativeLibraryBinary
A physical representation of a `NativeLibrary` component.
NativeLibraryBinarySpec
Represents a binary artifact that is the result of building a native library component.
NativeLibraryRequirement
A dependency on a native library within the build.
NativeLibrarySpec
Definition of a native library component that is to be built by Gradle.
NativePlatform
A target platform for building native binaries.
NativePlatformToolChain
A platform specific configurable tool chain.
NativeResourceSet
A source set that provides resources.
NativeTestingBasePlugin
Common base plugin for all native testing plugins.
NativeTestSuiteBinarySpec
An executable which runs a suite of tests.
NativeTestSuiteBinarySpec.TasksCollection
Provides access to key tasks used for building the binary.
NativeTestSuiteSpec
A component representing a suite of tests that will be executed together.
NativeToolChain
A set of compilers and linkers that are used together to construct a native binary.
NativeToolChainRegistry
A container for `NativeToolChain`s.
Nested
Marks a property as specifying a nested bean, whose properties should be checked for annotations.
NonExtensible
Indicates that the type, when DSL enhanced, does not support extensibility.
NonNullApi
Deprecated.
Deprecated in Gradle 9 for removal in Gradle 10.
NonRenamableProject
NormalizeLineEndings
Attached to an input property to specify that line endings should be normalized when snapshotting inputs.
NoSource
The test engine did not declare any sources for the test at all.
NoSource
The test engine did not declare any sources for the test at all.
NotSpec<T>
A `Spec` implementation which negates another `Spec`.
ObjectConfigurationAction
An `ObjectConfigurationAction` allows you to apply `Plugin`s and scripts to an object or objects.
ObjectFactory
A factory for creating various kinds of model objects.
ObjectFile
LanguageOutputType marking object file output type.
ObjectFilesToBinary
A task that combines a set of object files into a single binary.
ObjectInstantiationException
Thrown when an object cannot be instantiated.
ObjectiveCCompile
Compiles Objective-C source files into object files.
ObjectiveCLangPlugin
Adds core Objective-C language support.
ObjectiveCLangPlugin.Rules
ObjectiveCPlugin
A plugin for projects wishing to build native binary components from Objective-C sources.
ObjectiveCppCompile
Compiles Objective-C++ source files into object files.
ObjectiveCppLangPlugin
Adds core Objective-Cpp language support.
ObjectiveCppLangPlugin.Rules
ObjectiveCppPlugin
A plugin for projects wishing to build native binary components from Objective-C++ sources.
ObjectiveCppPreCompiledHeaderCompile
Compiles Objective C++ header source files into object files.
ObjectiveCppSourceSet
A set of Objective-C++ source files.
ObjectiveCPreCompiledHeaderCompile
Compiles Objective C header source files into object files.
ObjectiveCSourceSet
A set of Objective-C source files.
OffsetInFileLocation
A basic location pointing to a specific part of a file using a global offset and length for coordinates.
OffsetInFileLocation
A basic location pointing to a specific part of a file using a global offset and length for coordinates.
OperatingSystem
A machine operating system.
OperatingSystem
Constants for various operating systems Gradle runs on.
OperatingSystemFamily
Represents the operating system of a configuration.
OperationCompletionListener
A listener which is notified when operations run as part of the build complete.
OperationDescriptor
Describes an operation for which an event has occurred.
OperationResult
Describes the result of running an operation.
OperationType
Enumerates the different types of operations for which progress events can be received.
Option
Marks a property of a `Task` as being configurable from the command-line.
Optional
Marks a task property as optional.
OptionLessJavadocOptionFileOption<T>
Represents a Javadoc option.
OptionValues
Marks a method on a `Task` as providing the possible values for a `String` or `List<String>` `Option`.
OrSpec<T>
A `CompositeSpec` which requires any one of its specs to be true in order to evaluate to true.
OtherSource
The test engine declared a test source not recognized by Gradle.
OtherSource
The test engine declared a test source not recognized by Gradle.
OutgoingVariantsReportTask
A task which reports the outgoing variants of a project on the command line.
Output
A classpath entry representing an output folder.
OutputDirectories
Marks a property as specifying one or more output directories for a task.
OutputDirectory
Marks a property as specifying an output directory for a task.
OutputFile
Marks a property as specifying an output file for a task.
OutputFiles
Marks a property as specifying one or more output files for a task.
Package
Represents a Swift Package Manager package.
ParallelismConfiguration
A `ParallelismConfiguration` defines the parallel settings for a Gradle build.
ParameterizedToolingModelBuilder<T>
A `ToolingModelBuilder` which can be parameterized by the client.
PasswordCredentials
A username/password credentials that can be used to login to password-protected remote repository.
PasswordCredentials
A username/password credentials that can be used to login to something protected by a username and password.
Path
Specifies a model path on a parameter
Path
Represents a path in a format as used often in ipr and iml files.
Path
Represents a path in Gradle.
PathFactory
Path Factory.
PathSensitive
Annotates a task file property, specifying which part of the file paths should be considered during up-to-date checks.
PathSensitivity
Enumeration of different path handling strategies for task properties.
PathValidation
An enumeration for describing validation policies for file paths.
PatternFilterable
A `PatternFilterable` represents some file container which Ant-style include and exclude patterns or specs can be applied to.
PatternSet
Standalone implementation of `PatternFilterable`.
PgpKeyId
A normalised form for keys, which are friendliest for users as hex strings but used internally as longs.
PgpSignatory
PGP signatory from PGP key and password.
PgpSignatoryFactory
Creates `PgpSignatory` instances.
PgpSignatoryInternal
This is an implementation of PgpSignatory that uses `PgpSignatoryService` to cache computed keys.
PgpSignatoryProvider
A `SignatoryProvider` of `PgpSignatory` instances.
Platform
The platform or runtime that a binary is designed to run on.
PlatformAwareComponentSpec
Defines Platform specific operations for ComponentSpecs
PlatformContainer
A container of `Platform`s.
PlatformDependencyModifiers
Dependency modifier APIs that can find platform and enforced platforms in other modules for `dependencies` blocks.
PlatformDependencyModifiers.EnforcedPlatformDependencyModifier
Implementation for the enforced platform dependency modifier.
PlatformDependencyModifiers.PlatformDependencyModifier
Implementation for the platform dependency modifier.
Plugin<T>
A `Plugin` represents an extension to Gradle.
PluginAware
Something that can have plugins applied to it.
PluginCollection<T>
A `PluginCollection` represents a collection of `Plugin` instances.
PluginContainer
A `PluginContainer` is used to manage a set of `Plugin` instances applied to a particular project.
PluginDeclaration
Describes a Gradle plugin under development.
PluginDependenciesSpec
The DSL for declaring plugins to use in a script.
PluginDependency
A plugin dependency.
PluginDependencySpec
A mutable specification of a dependency on a plugin.
PluginId
A description of a plugin.
PluginIdentifier
Identifies a Gradle plugin.
PluginIdLocation
Represents a plugin ID.
PluginInstantiationException
A `PluginInstantiationException` is thrown when a plugin cannot be instantiated.
PluginManagementSpec
Configures how plugins are resolved.
PluginManager
Facilitates applying plugins and determining which plugins have been applied to a `PluginAware` object.
PluginRequest
Contains information about a plugin that has been requested for resolution.
PluginResolutionStrategy
Allows modification of `PluginRequest`s before they are resolved.
PluginResolveDetails
Allows plugin resolution rules to inspect a requested plugin and modify which target plugin will be used.
PluginUnderTestMetadata
Custom task for generating the metadata for a plugin user test.
Pmd
Runs a set of static code analysis rules on Java source code files and generates a report of problems found.
PmdExtension
Configuration options for the PMD plugin.
PmdPlugin
A plugin for the PMD source code analyzer.
PmdReports
The reporting configuration for the `Pmd` task.
PolymorphicDomainObjectContainer<T>
A `NamedDomainObjectContainer` that allows you to create objects with different types.
PomModuleDescriptor
The metadata about a Maven POM that acts as an input to a component metadata rule.
PrebuiltLibraries
A container of `PrebuiltLibrary` instances.
PrebuiltLibrary
A library component that is not built by gradle.
PrebuiltSharedLibraryBinary
A shared library that exists at a known location on the filesystem.
PrebuiltStaticLibraryBinary
A static library that exists at a known location on the filesystem.
PrefixHeaderFileGenerateTask
Generates a prefix header file from a list of headers to be precompiled.
PrefixHeaderFileGenerateTask.GeneratePrefixHeaderFile
PrefixHeaderFileGenerateTask.PrefixHeaderFileParameters
PreprocessingTool
A tool that permits configuration of the C preprocessor.
Problem
Interface for describing structured information about a problem.
Problem
A problem report
ProblemAggregation
Represents a list of aggregated problems.
ProblemAggregationEvent
Represents a list of aggregated problems.
ProblemContext
Describes a problem event.
ProblemDefinition
Describes a specific problem without context.
ProblemDefinition
Represents a problem definition.
ProblemEvent
An event representing a problem.
ProblemGroup
Represents a group of problems.
ProblemGroup
Represents a problem group.
ProblemId
Represents a unique identifier for a problem definition.
ProblemId
Represents a unique identifier for a problem definition.
ProblemLocation
Represents a location information of a problem.
ProblemReporter
Defines different ways to report problems.
Problems
Problems API service.
ProblemSpec
Provides options to configure problems.
ProblemSummariesEvent
The event capturing all problems summaries.
ProblemSummary
A problem summary.
ProcessExecutionException
An exception thrown when an error occurs while executing a process.
ProcessForkOptions
Specifies the options to use to fork a process.
ProcessResources
Copies resources from their source to their target directory, potentially processing them.
ProcessWorkerSpec
A worker spec providing the requirements of a forked process with a custom classpath.
Product
A product in a Swift Package Manager package.
ProductionComponent
Represents a component that is the main product of a project.
ProductionCppComponent
Represents a C++ component that is the main product of a project.
ProductionSwiftComponent
Represents a Swift component that is the main product of a project.
ProgressEvent
Root interface for all events that signal progress while executing an operation.
ProgressEvent
Some information about a piece of work of a long running operation.
ProgressListener
A listener which is notified when operations that are executed as part of running a build make progress.
ProgressListener
A listener which is notified as some long running operation makes progress.
Project
This interface is the main API you use to interact with Gradle from your build file.
Project
Represents the customizable elements of an eclipse project file.
Project
Represents the customizable elements of an ipr (via XML hooks everything of the ipr is customizable).
ProjectBasedReportTask
Deprecated.
Use `AbstractProjectBasedReportTask` instead.
ProjectBuilder
Creates dummy instances of `Project` which you can use in testing custom task and plugin implementations.
ProjectComponentIdentifier
An identifier for a component instance that is built as part of the current build.
ProjectComponentSelector
Criteria for selecting a component instance that is built as part of the current build.
ProjectConfigurationException
Indicates a problem that occurs during project configuration.
ProjectConfigurationFailureResult
Describes how a project configuration operation finished with failures.
ProjectConfigurationFinishEvent
An event that informs about a project configuration operation having finished its execution.
ProjectConfigurationOperationDescriptor
Describes a project configuration operation for which an event has occurred.
ProjectConfigurationOperationResult
Describes the result of running a project configuration operation.
ProjectConfigurationOperationResult.PluginApplicationResult
Describes the result of applying a plugin.
ProjectConfigurationProgressEvent
Root interface for all events that signal progress while configuring a project.
ProjectConfigurationStartEvent
An event that informs about a project configuration operation having started its execution.
ProjectConfigurationSuccessResult
Describes how a project configuration operation finished successfully.
ProjectConnection
Represents a long-lived connection to a Gradle project.
ProjectDependency
A `ProjectDependency` is a `Dependency` on another project in the current project hierarchy.
ProjectDependency
A classpath entry representing a project dependency.
ProjectDependency
Represents a dependency on another project.
ProjectDependencySpec
A dependency onto a library published by a project.
ProjectDependencySpecBuilder
A builder of a `ProjectDependencySpec`.
ProjectDescriptor
A `ProjectDescriptor` declares the configuration required to create and evaluate a `Project`.
ProjectEvaluationListener
An `ProjectEvaluationListener` is notified when a project is evaluated.
ProjectIdentifier
Identifies a Gradle project.
ProjectLayout
Provides access to several important locations for a project.
ProjectLibrary
A project-level IDEA library.
ProjectModel
Represents a model that is associated with some Gradle project.
ProjectPublications
A model providing information about the publications of a Gradle project.
ProjectReportsPlugin
A `Plugin` which adds some project visualization report tasks to a project.
ProjectReportTask
Displays a list of projects in the build.
ProjectReportTask.ProjectReportModel
Report model.
ProjectSourceSet
A container of `LanguageSourceSet`s.
ProjectState
`ProjectState` provides information about the execution state of a project.
PropertiesFileContentMerger
Models the generation/parsing/merging capabilities.
PropertiesFileNormalization
Specifies how properties files should be normalized.
PropertiesGeneratorTask<T>
A convenience superclass for those tasks which generate Properties configuration files from a domain object of type T.
Property<T>
A container object that represents a configurable value of a specific type.
PropertyListGeneratorTask<T>
A convenience superclass for those tasks which generate Property List configuration files from a domain object of type T.
PropertyReportTask
Displays the properties of a project.
PropertyReportTask.PropertyReportModel
Model for the report.
Provider<T>
A container object that provides a value of a specific type.
ProviderAwareCompilerDaemonForkOptions
Fork options for compilation that can accept user-defined `CommandLineArgumentProvider` objects.
ProviderConvertible<T>
An object that can be converted to a `Provider`.
ProviderFactory
A factory for creating instances of `Provider`.
Publication
A publication is a description of a consumable representation of one or more artifacts, and possibly associated metadata.
PublicationArtifact
An artifact published as part of a `Publication`.
PublicationContainer
A `PublicationContainer` is responsible for creating and managing `Publication` instances.
PublishableComponent
Represents a component that can be published.
PublishArtifact
A `PublishArtifact` is an artifact produced by a project.
PublishArtifactSet
A set of artifacts to be published.
PublishException
A `PublishException` is thrown when a dependency configuration cannot be published for some reason.
PublishingExtension
The configuration of how to "publish" the different components of a project.
PublishingPlugin
Installs a `PublishingExtension` with name "publishing".
PublishingPluginRules
These bindings are only here for backwards compatibility, as some users might depend on the extensions being available in the model.
PublishToIvyRepository
Publishes an IvyPublication to an IvyArtifactRepository.
PublishToIvyRepository.PublishSpec
PublishToIvyRepository.RepositorySpec
PublishToIvyRepository.RepositorySpec.Configured
PublishToIvyRepository.RepositorySpec.CredentialsSpec
PublishToIvyRepository.RepositorySpec.DefaultRepositorySpec
PublishToMavenLocal
Publishes a `MavenPublication` to the Maven Local repository.
PublishToMavenRepository
Publishes a `MavenPublication` to a `MavenArtifactRepository`.
PublishToMavenRepository.PublishSpec
PublishToMavenRepository.RepositorySpec
PublishToMavenRepository.RepositorySpec.Configured
PublishToMavenRepository.RepositorySpec.CredentialsSpec
PublishToMavenRepository.RepositorySpec.DefaultRepositorySpec
ReadableResource
A resource that can be read.
ReadOnlyModelViewException
Thrown when an attempt is made to change the value of a model element that is not writable at the time.
RegularFile
Represents a regular file at a fixed location on the file system.
RegularFileProperty
Represents some configurable regular file location, whose value is mutable.
RelativePath
Represents a relative path from some base directory to a file.
ReplacedBy
Attached to a task property to indicate that the property has been replaced by another.
Report
A file based report to be created.
Report.OutputType
The type of output the report produces
ReportContainer<T>
A container of `Report` objects, that represent potential reports.
ReportContainer.ImmutableViolationException
The exception thrown when any of this container's mutation methods are called.
Reporting<T>
An object that provides reporting options.
ReportingBasePlugin
A `Plugin` which provides the basic skeleton for reporting.
ReportingExtension
A project extension named "reporting" that provides basic reporting settings and utilities.
ReportSpec
Common parent for aggregation report types
Repositories
The repositories that Gradle will search for prebuilt libraries.
RepositoriesMode
The repository mode configures how repositories are setup in the build.
RepositoryContentDescriptor
Descriptor of a repository content, used to avoid reaching to an external repository when not needed.
RepositoryHandler
A `RepositoryHandler` manages a set of repositories, allowing repositories to be defined and queried.
RepositoryLayout
Represents the directory structure for a repository.
RepositoryResourceAccessor
Provides access to resources on an artifact repository.
ReproducibleFileVisitor
Visitor which can request a reproducible file order.
ResolutionResult
Contains the information about the result of dependency resolution.
ResolutionStrategy
Defines the strategies around dependency resolution.
ResolutionStrategy.SortOrder
Defines the sort order for components and artifacts produced by the configuration.
ResolvableConfiguration
A `Configuration` which performs dependency resolution to build dependency graphs and resolve artifacts.
ResolvableConfigurationsReportTask
A task which reports the configurations of a project which can be resolved on the command line.
ResolvableDependencies
The primary view of the results of resolving a `Configuration`.
ResolvedArtifact
Information about a resolved artifact.
ResolvedArtifactResult
The result of successfully resolving an artifact.
ResolvedComponentResult
Represents a component instance in the resolved dependency graph.
ResolvedConfiguration
A `ResolvedConfiguration` represents the result of resolving a `Configuration`, and provides access to both the graph and artifacts of the result.
ResolvedDependency
Information about a resolved dependency.
ResolvedDependencyResult
A dependency that was resolved successfully.
ResolvedModuleVersion
Represents meta-data about a resolved module version.
ResolvedVariantResult
The result of successfully resolving a component variant.
ResolveException
An opaque exception, thrown when dependency resolution fails for some reason.
Resource
A generic resource of some kind.
ResourceException
Generic resource exception that all other resource-related exceptions inherit from.
ResourceFilter
The gradle DSL model of an Eclipse resource filter.
ResourceFilterAppliesTo
Specifies the type of resource that the Eclipse `ResourceFilter` applies to.
ResourceFilterMatcher
The model of an Eclipse resource filter matcher.
ResourceFilterType
Specifies whether an Eclipse `ResourceFilter` is including or excluding resources.
ResourceHandler
Provides access to resource-specific utility methods, for example factory methods that create various resources.
ResultHandler<T>
A handler for an asynchronous operation which returns an object of type T.
RootComponentIdentifier
An opaque identifier for a component at the root of a dependency graph.
Rule
A `Rule` represents some action to perform when an unknown domain object is referenced.
RuleInput
Attached to the getter for a property on a `RuleSource` to denote that the property defines an implicit input for all rules defined by the rule source.
Rules
Denotes that the `RuleSource` method rule carrying this annotation defines additional rules based on its inputs.
RulesMode
The rules mode determines how component metadata rules should be applied.
RuleSource
A marker type for a class that is a collection of rules.
RuleTarget
Attached to the getter for a property on a `RuleSource` to denote that the property defines the target for the rule source.
RunClosedProjectBuildDependencies
A tooling model that instructs Gradle to run tasks to build artifacts for closed projects.
RunEclipseAutoBuildTasks
A tooling model that instructs Gradle to run tasks from the Eclipse plugin configuration.
RunEclipseSynchronizationTasks
A tooling model that instructs Gradle to run tasks from the Eclipse plugin configuration.
RunTestExecutable
Runs a compiled and installed test executable.
RuntimeClasspathNormalization
Configuration of runtime classpath normalization.
ScalaBasePlugin
A `Plugin` which compiles and tests Scala sources.
ScalaBasePlugin.UsageDisambiguationRules
ScalaCompile
Compiles Scala source files, and optionally, Java source files.
ScalaCompileOptions
Options for Scala Compilation.
ScalaDoc
Generates HTML API documentation for Scala source files.
ScalaDocOptions
Options for the ScalaDoc tool.
ScalaForkOptions
Fork options for Scala compilation.
ScalaPlugin
A `Plugin` which sets up a Scala project.
ScalaPluginExtension
Common configuration for Scala based projects.
ScalaRuntime
Provides information related to the Scala runtime(s) used in a project.
ScalaSourceDirectorySet
A `ScalaSourceDirectorySet` defines the properties and methods added to a `SourceSet` by the `ScalaPlugin`.
Script
This interface is implemented by all Gradle Groovy DSL scripts to add in some Gradle-specific methods.
ScriptGenerator
Generates a script to start a JVM application.
ScriptHandler
A `ScriptHandler` allows you to manage the compilation and execution of a build script.
ScriptPluginIdentifier
Identifies a Gradle script plugin.
ServiceReference
Marks a task property as being a holder to a `BuildService`.
SetProperty<T>
Represents a property whose type is a `Set` of elements of type `SetProperty`.
Settings
Declares the configuration required to instantiate and configure the hierarchy of `Project` instances which are to participate in a build.
Severity
A problem severity.
Severity
Represents a problem severity.
SharedLibraryBinary
A `NativeLibrary` that has been compiled and linked as a shared library.
SharedLibraryBinarySpec
A shared library binary built by Gradle for a native library.
SharedLibraryBinarySpec.TasksCollection
Provides access to key tasks used for building the binary.
SharedModelDefaults
Shared model defaults for configuring project types.
ShowStacktrace
Specifies the detail to include in stacktraces.
Sign
A task for creating digital signature files for one or more; tasks, files, publishable artifacts or configurations.
Signatory
A signatory is an object capable of providing a signature for an arbitrary stream of bytes.
SignatoryProvider<T>
Provides implementations of signatory implementations for a project.
SignatorySupport
Convenience base class for `Signatory` implementations.
Signature
A digital signature file artifact.
Signature.Generator
Configuration-cache compatible signature generator.
SignatureSpec
Specifies how objects will be signed.
SignatureType
The type of signature.
SignatureTypeProvider
Provider of `SignatureType`.
SigningExtension
The global signing configuration for a project.
SigningPlugin
Adds the ability to digitally sign files and artifacts.
SignOperation
A sign operation creates digital signatures for one or more files or `publish artifacts`.
SingleEntryModuleLibrary
Single entry module library
SingleFileReport
A report that is a single file.
SingleProblemEvent
ProblemEvent with all the details relevant.
SkippedResult
Describes how an operation was skipped.
SkipWhenEmpty
Attached to a task property to indicate that the task should be skipped when the value of the property is an empty `FileCollection` or directory.
SoftwareComponent
A software component produced by a Gradle software project.
SoftwareComponentContainer
A Container that contains all of the Software Components produced by a Project.
SoftwareComponentFactory
A software component factory is responsible for providing to plugins a way to create software components.
SoftwareComponentVariant
A software component variant, which has a number of artifacts, dependencies, constraints and capabilities, and that can be published to various formats (Gradle metadata, POM, ivy.xml, ...)
SoftwareReportingTasksPlugin
Adds various reporting tasks that provide information about a software project, such as information about configurations and dependency reporting tasks that make use of dependency management.
Solution
Represents a solution.
SourceComponentSpec
Represents some component whose implementation can be represented as a collection of source files, and whose other outputs are built from this source.
SourceControl
Configuration that defines the source dependencies available in this build.
SourceDirectory
Represents a source directory.
SourceDirectorySet
A `SourceDirectorySet` represents a set of source files composed from a set of source directories, along with associated include and exclude patterns.
SourceFile
Provides details about a particular source file.
SourceFolder
SourceFolder.path contains only project relative path.
SourcesArtifact
An artifact containing sources for a software component.
SourceSet
A `SourceSet` represents a logical group of Java source and resource files.
SourceSetContainer
A `SourceSetContainer` manages a set of `SourceSet` objects.
SourceSetOutput
A collection of all output directories (compiled classes, processed resources, etc.) - notice that `SourceSetOutput` extends `FileCollection`.
SourceTask
A `SourceTask` performs some operation on source files.
Spec<T>
Represents some predicate against objects of type T.
Specs
Provides a number of `Spec` implementations.
StandardJavadocDocletOptions
Provides the options for the standard Javadoc doclet.
StandardOutputListener
A `StandardOutputListener` receives text written by Gradle's logging system to standard output or error.
StartEvent
An event that informs about an operation having started its execution.
StartParameter
`StartParameter` defines the configuration used by a Gradle instance to execute a build.
StaticLibraryBinary
A `NativeLibrary` that has been compiled and archived into a static library.
StaticLibraryBinarySpec
A static library binary built by Gradle for a native library.
StaticLibraryBinarySpec.TasksCollection
Provides access to key tasks used for building the binary.
StatusEvent
An event that informs about an interim results of the operation.
StopActionException
A `StopActionException` is be thrown by a task `Action` or task action closure to stop its own execution and to start execution of the task's next action.
StopExecutionException
A `StopExecutionException` is thrown by a `Action` or task action closure to stop execution of the current task and start execution of the next task.
StreamedValueListener
Receives a value sent via `BuildController.send(Object)`.
StripSymbols
Strips the debug symbols from a binary
SuccessResult
Describes how an operation finished successfully.
Supplier<T>
A value supplier.
SupportsConvention
Marks a Gradle API custom type as supporting conventions.
SupportsKotlinAssignmentOverloading
Marks interface that works with overloaded Kotlin assignment.
SwiftApplication
Configuration for a Swift application, defining the source files that make up the application plus other settings.
SwiftApplicationPlugin
A plugin that produces an executable from Swift source.
SwiftBasePlugin
A common base plugin for the Swift application and library plugins
SwiftBasePlugin.SwiftCppUsageCompatibilityRule
SwiftBinary
A binary built from Swift source and linked from the resulting object files.
Swiftc
The Swift Compiler tool chain.
SwiftCompile
Compiles Swift source files into object files.
SwiftCompilerPlugin
A `Plugin` which makes the Swiftc compiler available for compiling Swift code.
SwiftComponent
Configuration for a Swift component, such as a library or executable, defining the source files that make up the component plus other settings.
SwiftcPlatformToolChain
Swiftc specific settings for the tools used to build for a particular platform.
SwiftExecutable
An executable built from Swift source.
SwiftLibrary
Configuration for a Swift library, defining the source files that make up the library plus other settings.
SwiftLibraryPlugin
A plugin that produces a shared library from Swift source.
SwiftPackageManagerExportPlugin
A plugin that produces a Swift Package Manager manifests from the Gradle model.
SwiftPlatform
A target platform for building Swift binaries.
SwiftSharedLibrary
A shared library built from Swift source.
SwiftStaticLibrary
A static library built from Swift source.
SwiftVersion
Swift version.
SwiftXCTestBinary
An test binary built from Swift source.
SwiftXCTestBundle
An XCTest executable for tests implemented in Swift.
SwiftXCTestExecutable
An XCTest executable for tests implemented in Swift.
SwiftXCTestSuite
A XCTest suite, implemented in Swift.
Sync
Synchronizes the contents of a destination directory with some source directories and files.
SyncSpec
Synchronizes the contents of a destination directory with some source directories and files.
Tar
Assembles a TAR archive.
TargetedNativeComponent
A native component that can be configured to target certain variant dimensions.
TargetJdk
Represents the PMD targetjdk property available for PMD < 5.0
TargetJvmEnvironment
Represents the target JVM environment.
TargetJvmVersion
Represents the target version of a Java library or platform.
TargetMachine
Represents a combination of operating system and cpu architecture that a variant might be built for.
TargetMachineBuilder
A builder for configuring the architecture of a `TargetMachine` objects.
TargetMachineFactory
A factory for creating `TargetMachine` objects.
Task
A `Task` represents a single atomic piece of work for a build, such as compiling classes or generating javadoc.
Task
Represents a task which is executable by Gradle.
TaskAction
Marks a method as the action to run when the task is executed.
TaskActionListener
Deprecated.
This type is not supported when configuration caching is enabled.
TaskCollection<T>
A `TaskCollection` contains a set of `Task` instances, and provides a number of query methods.
TaskContainer
A `TaskContainer` is responsible for managing a set of `Task` instances.
TaskDependency
A `TaskDependency` represents an unordered set of tasks which a `Task` depends on.
TaskDestroyables
Represents the files or directories that a `Task` destroys (removes).
TaskExecutionAdapter
A `TaskExecutionListener` adapter class for receiving task execution events.
TaskExecutionException
A `TaskExecutionException` is thrown when a task fails to execute successfully.
TaskExecutionGraph
A `TaskExecutionGraph` is responsible for managing the execution of the `Task` instances which are part of the build.
TaskExecutionGraphListener
A `TaskExecutionGraphListener` is notified when the `TaskExecutionGraph` has been populated.
TaskExecutionListener
Deprecated.
This type is not supported when configuration caching is enabled.
TaskExecutionRequest
A request to execute some tasks, along with an optional project path context to provide information necessary to select the tasks
TaskExecutionResult
Describes the result of a non-skipped task.
TaskFailureResult
Describes how a task operation finished with failures.
TaskFilePropertyBuilder
Describes a property of a task that contains zero or more files.
TaskFinishEvent
An event that informs about a task having finished its execution.
TaskInputFilePropertyBuilder
Describes an input property of a task that contains zero or more files.
TaskInputPropertyBuilder
Describes an input property of a task.
TaskInputs
A `TaskInputs` represents the inputs for a task.
TaskInstantiationException
A `TaskInstantiationException` is thrown when a task cannot be instantiated for some reason.
TaskLocalState
Represents the files or directories that represent the local state of a `Task`.
TaskOperationDescriptor
Describes a task operation for which an event has occurred.
TaskOperationResult
Describes the result of running a task operation.
TaskOutcome
The outcome of executing a task during a build.
TaskOutputFilePropertyBuilder
Describes an output property of a task that contains zero or more files.
TaskOutputs
A `TaskOutputs` represents the outputs of a task.
TaskPathLocation
Represents a task path.
TaskProgressEvent
Root interface for all events that signal progress while executing a task.
TaskPropertyBuilder
Describes a property of a task.
TaskProvider<T>
Providers a task of the given type.
TaskReference
A lightweight reference to a task.
TaskReportTask
Displays a list of tasks in the project.
TaskSelector
Represents a `Launchable` that uses task name to select tasks executed from a given project and its sub-projects.
TaskSkippedResult
Describes how a task operation was skipped.
TaskStartEvent
An event that informs about a task having started its execution.
TaskState
`TaskState` provides information about the execution state of a `Task`.
TaskSuccessResult
Describes how a task operation finished successfully.
TemplateBasedScriptGenerator
Interface for generating scripts with the provided details based on a provided template.
Test
Executes JUnit (3.8.x, 4.x or 5.x) or TestNG tests.
TestAssertionFailure
Represent a test assertion failure where the test fails due to a broken assertion.
TestComponent
Represents a component that can run tests.
TestDescriptor
Describes a test.
TestEventReporter
Reports test events.
TestEventReporterFactory
A service that provides access to the test event reporting API.
TestExceptionFormat
Determines how exceptions are formatted in test logging.
TestExecutionException
A `TestExecutionException` is thrown when no tests can be found that match the specified test filters.
TestExecutionException
Thrown when the `TestLauncher` cannot run tests, or when one or more tests fail.
TestFailure
Describes a test failure.
TestFailure
Describes a test failure, that can either be a test assertion failure or a test framework failure.
TestFailureDetails
Contains serializable structural information about a test failure.
TestFailureResult
Describes how a test operation finished with failures.
TestFileAttachmentDataEvent
File attachment data published by a test.
TestFileAttachmentMetadataEvent
An event emitted by tests that contains file attachment data.
TestFilter
Allows filtering tests for execution.
TestFinishEvent
An event that informs about a test having finished its execution.
TestFixturesDependencyModifiers
Dependency modifier APIs that can find test fixtures in other modules for `dependencies` blocks.
TestFixturesDependencyModifiers.TestFixturesDependencyModifier
Implementation for the test fixtures dependency modifier.
TestFrameworkFailure
Describes an unexpected test failure, i.e.
TestFrameworkOptions
The base class for any test framework specific options.
TestingBasePlugin
Base plugin for testing.
TestingExtension
This DSL element exists to contain a collection of `TestSuite`s.
TestingModelBasePlugin
Base plugin for testing.
TestingModelBasePlugin.Rules
TestKeyValueDataEvent
Key-value data published by a test.
TestKeyValueMetadataEvent
An event emitted by tests that contains additional data in the form of key-values.
TestLauncher
A `TestLauncher` allows you to execute tests in a Gradle build.
TestListener
Interface for listening to test execution.
TestLogEvent
Test events that can be logged.
TestLogging
Options that determine which test events get logged, and at which detail.
TestLoggingContainer
Container for all test logging related options.
TestMetadataEvent
Metadata captured during the execution of a test.
TestMetadataEvent
An event emitted by tests that contain additional data about the test.
TestMetadataListener
Listens to the metadata events like reporting key-value pairs or file attachments during test execution.
TestNGOptions
The TestNG specific test options.
TestOperationDescriptor
Describes a test operation for which an event has occurred.
TestOperationResult
Describes the result of running a test operation.
TestOutputDescriptor
Describes a test output operation.
TestOutputEvent
Standard output or standard error message logged during the execution of the test
TestOutputEvent
An event that informs about a test printing text to the standard output or to the standard error.
TestOutputEvent.Destination
Destination of the message
TestOutputListener
Listens to the output events like printing to standard output or error
TestProgressEvent
Root interface for all events that signal progress while executing a test or test suite.
TestReport
Generates an HTML test report from the results of one or more `Test` tasks.
TestReportAggregationPlugin
Adds configurations to for resolving variants containing test execution results, which may span multiple subprojects.
TestResult
Describes a test result.
TestResult.ResultType
The final status of a test.
TestSkippedResult
Describes how a test operation was skipped.
TestSource
Representation of the source of a test or container used to navigate to its location by IDEs and build tools.
TestSource
Representation of the source of a test or container used to navigate to its location by IDEs and build tools.
TestSpec
Provides infrastructure to select which test classes, methods, and packages will be included in the test execution.
TestSpecs
Provides test selection from a specific test task.
TestStackTraceFilter
Stack trace filters for test logging.
TestStartEvent
An event that informs about a test having started its execution.
TestSuccessResult
Describes how a test operation finished successfully.
TestSuite
Base test suite component.
TestSuiteBasePlugin
Base test suite functionality.
TestSuiteBinarySpec
A binary which runs a suite of tests.
TestSuiteComponent
Represents a component that defines a test suite.
TestSuiteContainer
A container of `TestSuiteSpec` instances.
TestSuiteName
Attribute to define the test suite name.
TestSuiteSpec
A component representing a suite of tests that will be built and executed together.
TestSuiteTarget
Base test suite target.
TestSuiteTaskCollection
Provides access to key tasks used by a test suite.
TestTaskReports
The reports produced by the `Test` task.
TextConfigFile
A plain text config file generated for Visual Studio.
TextProvider
Provides access to the content of a generated text file.
TextResource
A read-only body of text backed by a string, file, archive entry, or other source.
TextResourceFactory
Creates `TextResource`s backed by sources such as strings, files, and archive entries.
Tool
Configuration of the arguments of a ToolChain executable.
ToolChain
A set of compilers that are used together to construct binaries.
ToolchainManagement
Configures how toolchains are resolved.
ToolChainRegistry<P,T>
A Provider of `ToolChain`s.
ToolingModelBuilder
Responsible for building tooling models to return to the tooling API client.
ToolingModelBuilderRegistry
A registry of tooling model builders.
ToolingModelContract
Annotation used to mark TAPI model interfaces.
TransformAction<T>
Interface for artifact transform actions.
TransformationFileType
The type of a file of a transformation
Transformer<OUT,IN>
A `Transformer` transforms objects of type.
TransformFailureResult
Describes how a transform operation finished with failures.
TransformFinishEvent
An event that informs about a transform operation having finished its execution.
TransformOperationDescriptor
Describes a transform operation for which an event has occurred.
TransformOperationDescriptor.SubjectDescriptor
Describes the subject (artifact or file) of a transform operation.
TransformOperationDescriptor.TransformerDescriptor
Describes the transformer of a transform operation.
TransformOperationResult
Describes the result of running a transform operation.
TransformOutputs
The outputs of the artifact transform.
TransformParameters
Marker interface for parameter objects to `TransformAction`s.
TransformParameters.None
Used for `TransformAction`s without parameters.
TransformProgressEvent
Root interface for all events that signal progress while executing a transform.
TransformSpec<T>
Base configuration for artifact transform registrations.
TransformStartEvent
An event that informs about a transform operation having started its execution.
TransformSuccessResult
Describes how a transform operation finished successfully.
TypeBuilder<T>
A TypeBuilder to configure the registration of a type.
TypeOf<T>
Provides a way to preserve high-fidelity `Type` information on generic types.
UncheckedIOException
Deprecated.
Use java.io.UncheckedIOException instead.
UnexpectedBuildFailure
Thrown when executing a build that was expected to succeed, but failed.
UnexpectedBuildResultException
Base class for `UnexpectedBuildFailure` and `UnexpectedBuildSuccess`.
UnexpectedBuildSuccess
Thrown when executing a build that was expected to fail, but succeeded.
UnexportMainSymbol
Unexports the `main` entry point symbol in an object file, so the object file can be linked with an executable.
UnknownConfigurationException
An `UnknownConfigurationException` is thrown when a configuration referenced by name cannot be found.
UnknownDomainObjectException
A `UnknownDomainObjectException` is the super class of all exceptions thrown when a given domain object cannot be located.
UnknownModelException
Thrown when an unknown tooling model is requested.
UnknownModelException
Thrown when the client is trying to acquire a model that is unknown to the Tooling API.
UnknownPluginException
A `UnknownPluginException` is thrown when an unknown plugin id is provided.
UnknownProjectException
An `UnknownProjectException` is thrown when a project referenced by path cannot be found.
UnknownRepositoryException
An `UnknownRepositoryException` is thrown when a repository referenced by name cannot be found.
UnknownTaskException
An `UnknownTaskException` is thrown when a task referenced by path cannot be found.
Unmanaged
Indicates that a property of a managed model element is explicitly of an unmanaged type.
UnresolvedArtifactResult
An artifact that could not be resolved.
UnresolvedComponentResult
A component that could not be resolved.
UnresolvedDependency
Unsuccessfully resolved dependency.
UnresolvedDependencyResult
A dependency that could not be resolved.
UnresolvedLibrary
A library that turned out to be unresolved.
UnsupportedBuildArgumentException
Thrown when the `LongRunningOperation` has been configured with unsupported build arguments.
UnsupportedFeatureException
Thrown when a build was executed with a target Gradle version that does not support a specific feature.
UnsupportedMethodException
Thrown when the tooling API client attempts to use a method that does not exist in the version of Gradle that the tooling API is connected to.
UnsupportedOperationConfigurationException
Thrown when a `LongRunningOperation` has been configured with unsupported settings.
UnsupportedVersionException
Thrown when the target Gradle version does not support a particular feature.
UntrackedTask
Attached to a task to declare that the task should be untracked.
UpdateDaemonJvm
Generates or updates the Gradle Daemon JVM criteria.
UrlArtifactRepository
A repository that supports resolving artifacts from a URL.
Usage
Represents the usage of a configuration.
UserClassFilePermissions
Describes file and directory access permissions for a certain class of users (see `FilePermissions`).
Validate
Denotes that the `RuleSource` method rule carrying this annotation validates the rule subject.
ValidatePlugins
Validates plugins by checking property annotations on work items like tasks and artifact transforms.
ValueSource<T,P>
Represents an external source of information used by a Gradle build.
ValueSourceParameters
Marker interface for parameter objects to `ValueSource`s.
ValueSourceParameters.None
Used for sources without parameters.
ValueSourceSpec<P>
Base configuration for value source definitions.
Variable
A variable library entry.
Variant
Declares that a property represents a variant dimension.
VariantComponent
A component that has one or more mutually exclusive variants.
VariantComponentSpec
Represents a component spec that is made up of one or more mutually exclusive variants.
VariantFileMetadata
Part of a component variant's metadata representing a file and its location.
VariantMetadata
Represents the metadata of one variant of a component, see `ComponentMetadataDetails.withVariant(String, Action)`.
VariantSelectionDetails
Allows configuring the variant-aware selection aspects of a specific dependency.
VariantVersionMappingStrategy
Defines the version mapping strategy when publishing, for a specific variant.
VcsMapping
A dependency mapping provided by a VCS repository.
VcsMappings
Allows VCS mapping rules to be specified for a build.
VerificationException
Signals that a task has failed in a manner which does not prevent consumers of that task's output from running.
VerificationTask
A `VerificationTask` is a task which performs some verification of the artifacts produced by a build.
VerificationType
Attribute to be used on variants containing the output verification checks (Test data, Jacoco results, etc) which specify the type of verification data.
VersionCatalog
Provides access to a version catalog.
VersionCatalogBuilder
A version catalog builder.
VersionCatalogBuilder.LibraryAliasBuilder
Allows configuring the version of a library
VersionCatalogBuilder.PluginAliasBuilder
Allows configuring the version of a plugin
VersionCatalogPlugin
A `Plugin` makes it possible to generate a version catalog, which is a set of versions and coordinates for dependencies and plugins to import in the settings of a Gradle build.
VersionCatalogsExtension
Gives access to all version catalogs available.
VersionConstraint
Represents a constraint that is used to match module versions to a dependency.
VersionControlRepository
Represents the details about a particular VCS repository that contains a build that produces zero or more components that can be used during dependency resolution.
VersionControlSpec
Captures user-provided information about a version control repository.
VersionMappingStrategy
The version mapping strategy for a publication.
VisualCpp
The Visual C++ tool chain.
VisualCppPlatformToolChain
Visual C++ specific settings for the tools used to build for a particular platform.
VisualStudioExtension
The configuration for mapping a set of native components to a Visual Studio project.
VisualStudioPlugin
A plugin for creating a Visual Studio solution for a gradle project.
VisualStudioPluginRules
VisualStudioPluginRules.VisualStudioExtensionRules
VisualStudioPluginRules.VisualStudioPluginProjectRules
VisualStudioPluginRules.VisualStudioPluginRootRules
VisualStudioProject
A visual studio project, created from one or more native binaries.
VisualStudioRootExtension
The configuration for mapping a set of native components to a Visual Studio project and solution.
VisualStudioSolution
A visual studio solution, representing one or more native binaries in a build.
War
Assembles a WAR archive.
WarningMode
Specifies the warning mode a user wants to see.
WarPlugin
A `Plugin` which extends the `JavaPlugin` to add tasks which assemble a web application into a WAR file.
WbDependentModule
A wtp descriptor dependent module entry.
WbModuleEntry
Represents an entry in `wb-module`.
WbProperty
A wtp descriptor property entry.
WbResource
A wtp descriptor resource entry.
WelcomeMessageConfiguration
Configures when to display the welcome message on the command line.
WelcomeMessageDisplayMode
The possible strategies for displaying a welcome message on the command line.
WindowsResourceCompile
Compiles Windows Resource scripts into .res files.
WindowsResourceScriptPlugin
Adds core language support for Windows resource script files.
WindowsResourceScriptPlugin.Rules
WindowsResourceSet
A set of Windows Resource definition files.
WindowsResourcesPlugin
A plugin for projects wishing to build native binary components from Windows Resource sources.
WorkAction<T>
Represents the implementation of a unit of work to be used when submitting work to the `WorkerExecutor`.
WorkerExecutionException
Indicates that a failure occurred during execution of work in a worker.
WorkerExecutor
Allows work to be submitted for asynchronous execution.
WorkerSpec
Represents the common configuration of a worker.
WorkItemFailureResult
Describes how a work item operation finished with failures.
WorkItemFinishEvent
An event that informs about a work item having finished its execution.
WorkItemOperationDescriptor
Describes a work item operation for which an event has occurred.
WorkItemOperationResult
Describes the result of running a work item operation.
WorkItemProgressEvent
Root interface for all events that signal progress while executing a work item.
WorkItemStartEvent
An event that informs about a work item having started its execution.
WorkItemSuccessResult
Describes how a work item operation finished successfully.
WorkParameters
Marker interface for parameter objects to `WorkAction`s.
WorkParameters.None
Used for work actions without parameters.
WorkQueue
Represents a queue of work items with a uniform set of worker requirements.
WorkResult
Provides information about some work which was performed.
WorkResults
Helps access trivial `WorkResult` objects.
Workspace
Represents the customizable elements of an ipr (via XML hooks everything of the ipr is customizable).
Wrapper
Generates scripts (for *nix and windows) which allow you to build your project with Gradle, without having to install Gradle.
Wrapper.DistributionType
Specifies the Gradle distribution type.
Wrapper.PathBase
Specifies how the wrapper path should be interpreted.
WrapperPlugin
The wrapper plugin.
WriteOnlyModelViewException
Thrown when an attempt is made to read the value of a model element that is not readable at the time.
WriteProperties
Writes a `Properties` in a way that the results can be expected to be reproducible.
WtpComponent
Creates the .settings/org.eclipse.wst.common.component file for WTP projects.
WtpFacet
Creates the .settings/org.eclipse.wst.common.project.facet.core.xml file for WTP projects.
XcodeExtension
The configuration for mapping a C++ or Swift project to an XCode project.
XcodePlugin
A plugin for creating a XCode project for a gradle project.
XcodeProject
A xcode project, created from C++ or Swift capable project.
XcodeRootExtension
The configuration for mapping a C++ or Swift project to XCode project and workspace.
XcodeWorkspace
Represents the generated Xcode workspace.
XCTest
Executes XCTest tests.
XCTestConventionPlugin
A plugin that sets up the infrastructure for testing native binaries with XCTest test framework.
XmlConfigFile
An XML config file generated for Visual Studio.
XmlFileContentMerger
Models the generation/parsing/merging capabilities.
XmlGeneratorTask<T>
A convenience superclass for those tasks which generate XML configuration files from a domain object of type T.
XmlProvider
Provides various ways to access the content of an XML document.
Zip
Assembles a ZIP archive.
ZipEntryCompression
Specifies the compression level of an archives contents.