Package org.gradle.api
@NonNullApi
package org.gradle.api
Gradle's build language API, which is available from your build files. Location of the main interfaces involved in build scripts.
-
ClassDescriptionAction<T>Performs some action against objects of type T.Allows specification of configuration for some action.An
AntBuilderallows you to use Ant from your build script.Represents the normal Ant message priorities.ABuildablerepresents an artifact or set of artifacts which are built by one or moreTaskinstances.AComponentSpecthat is directlyBuildablevia a specified task.ABuildCancelledExceptionis thrown when a build is interrupted due to cancellation request.AComponentSpecthat is directly checkable via a specified task.ACircularReferenceExceptionis thrown if circular references exists between tasks, the project evaluation order or the project dependsOn order.DefaultTaskis the standardTaskimplementation.Types can implement this interface when they provide a human-readable display name.ADomainObjectCollectionis a specialisedCollectionthat adds the ability to receive modification notifications and use live filtered sub collections.APolymorphicDomainObjectContainerthat can be extended at runtime to create elements of new types.Indicates that the annotated member code was generated.GradleExceptionis the base class of all exceptions thrown by Gradle.AGradleScriptExceptionis thrown when an exception occurs in the compilation or execution of a script.Marks a SAM interface as a target for lambda expressions / closures where the single parameter is passed as the implicit receiver of the invocation (thisin Kotlin,delegatein Groovy) as if the lambda expression was an extension method of the parameter type.This exceptions is thrown, if a dependency is declared with a illegal notation.Indicates that a feature is incubating.AInvalidUserCodeExceptionis thrown when user-provided code cannot be executed.AInvalidUserDataExceptionis thrown, if a user is providing illegal data for the build.Defines an action that is applied to objects of typeIsolatedAction, with each target getting its own isolated action instance.An enumeration of Java versions.Types can implement this interface and use the embeddedNamed.Namerimplementation, to satisfy API that calls for a namer.An implementation of the namer interface for objects implementing the named interface.ANamedDomainObjectCollectionrepresents a collection of objects that have an inherent, constant, name.Schema of named domain object collections.Schema of a named domain object.A named domain object container is a specialization ofNamedDomainObjectSetthat adds the ability to create instances of the element type.A factory for named objects of typeT.A specialization ofNamedDomainObjectCollectionthat also implementsList.Provides a domain object of the given type.A specialization ofNamedDomainObjectCollectionthat also implementsSetand orders objects by their inherent name.Namer<T>A namer is capable of providing a name based on some inherent characteristic of an object.A comparator implementation based on the names returned by the given namer.Indicates that the type, when DSL enhanced, does not support extensibility.Marks a type or a whole package as providing a non-null API by default.An enumeration for describing validation policies for file paths.Plugin<T>APluginrepresents an extension to Gradle.ANamedDomainObjectContainerthat allows you to create objects with different types.This interface is the main API you use to interact with Gradle from your build file.Indicates a problem that occurs during project configuration.AnProjectEvaluationListeneris notified when a project is evaluated.ProjectStateprovides information about the execution state of a project.ARulerepresents some action to perform when an unknown domain object is referenced.This interface is implemented by all Gradle Groovy DSL scripts to add in some Gradle-specific methods.Marks interface that works with overloaded Kotlin assignment.ATaskrepresents a single atomic piece of work for a build, such as compiling classes or generating javadoc.Deprecated.ATransformertransforms objects of type.UncheckedIOExceptionis used to wrap anIOExceptioninto an unchecked exception.AUnknownDomainObjectExceptionis the super class of all exceptions thrown when a given domain object cannot be located.AnUnknownProjectExceptionis thrown when a project referenced by path cannot be found.AnUnknownTaskExceptionis thrown when a task referenced by path cannot be found.Provides various ways to access the content of an XML document.
Named.Namer.INSTANCEinstead (sinceTasknow extendsNamed).