Package-level declarations

Gradle's build language API, which is available from your build files. Location of the main interfaces involved in build scripts.

Types

Link copied to clipboard
Performs some action against objects of type T.
Link copied to clipboard
Allows specification of configuration for some action.
Link copied to clipboard
abstract class AntBuilder : AntBuilder
An AntBuilder allows you to use Ant from your build script.
Link copied to clipboard
interface Buildable
A Buildable represents an artifact or set of artifacts which are built by one or more Task instances.
Link copied to clipboard
A ComponentSpec that is directly Buildable via a specified task.
Link copied to clipboard
A BuildCancelledException is thrown when a build is interrupted due to cancellation request.
Link copied to clipboard
A ComponentSpec that is directly checkable via a specified task.
Link copied to clipboard
A CircularReferenceException is thrown if circular references exists between tasks, the project evaluation order or the project dependsOn order.
Link copied to clipboard
@DisableCachingByDefault(because = "Gradle would require more information to cache this task")
abstract class DefaultTask : AbstractTask, Task
DefaultTask is the standard Task implementation.
Link copied to clipboard
interface Describable
Types can implement this interface when they provide a human-readable display name.
Link copied to clipboard
A DomainObjectCollection is a specialised Collection that adds the ability to receive modification notifications and use live filtered sub collections.
Link copied to clipboard
A DomainObjectSet is a specialization of DomainObjectCollection that guarantees Set semantics.
interface ExtensiblePolymorphicDomainObjectContainer<T> : PolymorphicDomainObjectContainer<T> , NamedDomainObjectFactoryRegistry<T>
A org.gradle.api.PolymorphicDomainObjectContainer that can be extended at runtime to create elements of new types.
Link copied to clipboard
Indicates that the annotated member code was generated.
Link copied to clipboard
GradleException is the base class of all exceptions thrown by Gradle.
Link copied to clipboard
A GradleScriptException is thrown when an exception occurs in the compilation or execution of a script.
Link copied to clipboard
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.
Link copied to clipboard
This exceptions is thrown, if a dependency is declared with a illegal notation.
Link copied to clipboard
Thrown when a Closure is given as an Action implementation, but has the wrong signature.
Link copied to clipboard
A InvalidUserCodeException is thrown when user-provided code cannot be executed.
Link copied to clipboard
A InvalidUserDataException is thrown, if a user is providing illegal data for the build.
Link copied to clipboard
Defines an action that is applied to objects of type T, with each target getting its own isolated action instance.
Link copied to clipboard
An enumeration of Java versions.
Link copied to clipboard
interface Named
Types can implement this interface and use the embedded Namer implementation, to satisfy API that calls for a namer.
Link copied to clipboard
A NamedDomainObjectCollection represents a collection of objects that have an inherent, constant, name.
Link copied to clipboard
Schema of named domain object collections.
Link copied to clipboard
A named domain object container is a specialization of NamedDomainObjectSet that adds the ability to create instances of the element type.
Link copied to clipboard
A factory for named objects of type T.
Link copied to clipboard
Link copied to clipboard
Provides a domain object of the given type.
Link copied to clipboard
A specialization of NamedDomainObjectCollection that also implements Set and orders objects by their inherent name.
Link copied to clipboard
interface Namer<T>
A namer is capable of providing a name based on some inherent characteristic of an object.
Link copied to clipboard
Indicates that the type, when DSL enhanced, does not support extensibility.
Link copied to clipboard
annotation class NonNullApi
Marks a type or a whole package as providing a non-null API by default.
Link copied to clipboard
An enumeration for describing validation policies for file paths.
Link copied to clipboard
interface Plugin<T>
A Plugin represents an extension to Gradle.
Link copied to clipboard
A NamedDomainObjectContainer that allows you to create objects with different types.
Link copied to clipboard
This interface is the main API you use to interact with Gradle from your build file.
Link copied to clipboard
open class ProjectConfigurationException : DefaultMultiCauseException
Indicates a problem that occurs during project configuration.
Link copied to clipboard
An ProjectEvaluationListener is notified when a project is evaluated.
Link copied to clipboard
interface ProjectState
ProjectState provides information about the execution state of a project.
Link copied to clipboard
interface Rule
A Rule represents some action to perform when an unknown domain object is referenced.
Link copied to clipboard
interface Script
This interface is implemented by all Gradle Groovy DSL scripts to add in some Gradle-specific methods.
Link copied to clipboard
Marks interface that works with overloaded Kotlin assignment.
Link copied to clipboard
A Task represents a single atomic piece of work for a build, such as compiling classes or generating javadoc.
Link copied to clipboard
interface Transformer<OUT, IN>
A Transformer transforms objects of type.
Link copied to clipboard
UncheckedIOException is used to wrap an java.io.IOException into an unchecked exception.
Link copied to clipboard
A UnknownDomainObjectException is the super class of all exceptions thrown when a given domain object cannot be located.
Link copied to clipboard
An UnknownProjectException is thrown when a project referenced by path cannot be found.
Link copied to clipboard
An UnknownTaskException is thrown when a task referenced by path cannot be found.
Link copied to clipboard
interface XmlProvider
Provides various ways to access the content of an XML document.