A DomainObjectCollection is a specialised Collection that adds the ability to receive modification notifications and use live filtered sub collections.

DomainObjectSet

interface DomainObjectSet<T> : DomainObjectCollection<T> , Set<E>

A DomainObjectSet is a specialization of DomainObjectCollection that guarantees Set semantics.

ExtensiblePolymorphicDomainObjectContainer

interface ExtensiblePolymorphicDomainObjectContainer<T> : PolymorphicDomainObjectContainer<T> , NamedDomainObjectFactoryRegistry<T>

A org.gradle.api.PolymorphicDomainObjectContainer that can be extended at runtime to create elements of new types.

Generated

@Retention(value = RetentionPolicy.CLASS)

@Target(value = ElementType.TYPE)

@Documented

annotation class Generated

Indicates that the annotated member code was generated.

GradleException

open class GradleException : RuntimeException

GradleException is the base class of all exceptions thrown by Gradle.

GradleScriptException

open class GradleScriptException : GradleException

A GradleScriptException is thrown when an exception occurs in the compilation or execution of a script.

HasImplicitReceiver

@Documented

@Retention(value = RetentionPolicy.RUNTIME)

@Target(value = ElementType.TYPE)

annotation class 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.

IllegalDependencyNotation

open class IllegalDependencyNotation : GradleException

This exceptions is thrown, if a dependency is declared with a illegal notation.

Incubating

@Documented

@Retention(value = RetentionPolicy.RUNTIME)

@Target(value = [ElementType.PACKAGE, ElementType.TYPE, ElementType.ANNOTATION_TYPE, ElementType.CONSTRUCTOR, ElementType.FIELD, ElementType.METHOD])

annotation class Incubating

Indicates that a feature is incubating.

InvalidActionClosureException

open class InvalidActionClosureException : GradleException

Thrown when a Closure is given as an Action implementation, but has the wrong signature.

InvalidUserCodeException

open class InvalidUserCodeException : GradleException

A InvalidUserCodeException is thrown when user-provided code cannot be executed.

InvalidUserDataException

open class InvalidUserDataException : GradleException

A InvalidUserDataException is thrown, if a user is providing illegal data for the build.

JavaVersion

enum JavaVersion

An enumeration of Java versions.

Named

interface Named

Types can implement this interface and use the embedded Namer implementation, to satisfy API that calls for a namer.

NamedDomainObjectCollection

interface NamedDomainObjectCollection<T> : DomainObjectCollection<T>

A NamedDomainObjectCollection represents a collection of objects that have an inherent, constant, name.

NamedDomainObjectCollectionSchema

interface NamedDomainObjectCollectionSchema

Schema of named domain object collections.

NamedDomainObjectContainer

interface NamedDomainObjectContainer<T> : NamedDomainObjectSet<T> , Configurable<T>

A named domain object container is a specialization of NamedDomainObjectSet that adds the ability to create instances of the element type.

NamedDomainObjectFactory

interface NamedDomainObjectFactory<T>

A factory for named objects of type T.

NamedDomainObjectList

interface NamedDomainObjectList<T> : NamedDomainObjectCollection<T> , List<E>

A specialization of org.gradle.api.NamedDomainObjectCollection that also implements java.util.List.

NamedDomainObjectProvider

interface NamedDomainObjectProvider<T> : Provider<T>

Provides a domain object of the given type.

NamedDomainObjectSet

interface NamedDomainObjectSet<T> : NamedDomainObjectCollection<T> , DomainObjectSet<T>

A specialization of NamedDomainObjectCollection that also implements Set and orders objects by their inherent name.

Namer

interface Namer<T>

A namer is capable of providing a name based on some inherent characteristic of an object.

NonExtensible

@Documented

@Retention(value = RetentionPolicy.RUNTIME)

@Inherited

@Target(value = [ElementType.TYPE])

annotation class NonExtensible

Indicates that the type, when DSL enhanced, does not support extensibility.

NonNullApi

@Target(value = [ElementType.TYPE, ElementType.PACKAGE])

@NotNull

@Nonnull

@TypeQualifierDefault(value = [ElementType.METHOD, ElementType.PARAMETER])

@Documented

@Retention(value = RetentionPolicy.RUNTIME)

annotation class NonNullApi

Marks a type or a whole package as providing a non-null API by default.

PathValidation

enum PathValidation

An enumeration for describing validation policies for file paths.

Plugin

interface Plugin<T>

A Plugin represents an extension to Gradle.

PolymorphicDomainObjectContainer

interface PolymorphicDomainObjectContainer<T> : NamedDomainObjectContainer<T>

A NamedDomainObjectContainer that allows you to create objects with different types.

Project

interface Project : Comparable<T> , ExtensionAware, PluginAware

This interface is the main API you use to interact with Gradle from your build file.

ProjectConfigurationException

open class ProjectConfigurationException : DefaultMultiCauseException

Indicates a problem that occurs during project configuration.

ProjectEvaluationListener

interface ProjectEvaluationListener

An ProjectEvaluationListener is notified when a project is evaluated.

ProjectState

interface ProjectState

ProjectState provides information about the execution state of a project.

Rule

interface Rule

A Rule represents some action to perform when an unknown domain object is referenced.

Script

interface Script

This interface is implemented by all Gradle Groovy DSL scripts to add in some Gradle-specific methods.

SupportsKotlinAssignmentOverloading

@Documented

@Retention(value = RetentionPolicy.RUNTIME)

@Target(value = ElementType.TYPE)

annotation class SupportsKotlinAssignmentOverloading

Marks interface that works with overloaded Kotlin assignment.

Task

interface Task : Comparable<T> , ExtensionAware

A Task represents a single atomic piece of work for a build, such as compiling classes or generating javadoc.

Transformer

interface Transformer<OUT, IN>

A Transformer transforms objects of type.

UncheckedIOException

open class UncheckedIOException : RuntimeException

UncheckedIOException is used to wrap an java.io.IOException into an unchecked exception.

UnknownDomainObjectException

open class UnknownDomainObjectException : GradleException

A UnknownDomainObjectException is the super class of all exceptions thrown when a given domain object cannot be located.

UnknownProjectException

open class UnknownProjectException : UnknownDomainObjectException

An UnknownProjectException is thrown when a project referenced by path cannot be found.

UnknownTaskException

open class UnknownTaskException : UnknownDomainObjectException

An UnknownTaskException is thrown when a task referenced by path cannot be found.

XmlProvider

interface XmlProvider

Provides various ways to access the content of an XML document.