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.
-
Interface Summary Interface Description Action<T> Performs some action against objects of type T.ActionConfiguration Allows specification of configuration for some action.Buildable ABuildablerepresents an artifact or set of artifacts which are built by one or moreTaskinstances.BuildableComponentSpec AComponentSpecthat is directlyBuildablevia a specified task.CheckableComponentSpec AComponentSpecthat is directly checkable via a specified task.Describable Types can implement this interface when they provide a human-readable display name.DomainObjectCollection<T> ADomainObjectCollectionis a specialisedCollectionthat adds the ability to receive modification notifications and use live filtered sub collections.DomainObjectSet<T> ExtensiblePolymorphicDomainObjectContainer<T> APolymorphicDomainObjectContainerthat can be extended at runtime to create elements of new types.IsolatedAction<T> Defines an action that is applied to objects of typeIsolatedAction, with each target getting its own isolated action instance.Named Types can implement this interface and use the embeddedNamed.Namerimplementation, to satisfy API that calls for a namer.NamedDomainObjectCollection<T> ANamedDomainObjectCollectionrepresents 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 ofNamedDomainObjectSetthat adds the ability to create instances of the element type.NamedDomainObjectFactory<T> A factory for named objects of typeT.NamedDomainObjectList<T> A specialization ofNamedDomainObjectCollectionthat also implementsList.NamedDomainObjectProvider<T> Provides a domain object of the given type.NamedDomainObjectSet<T> 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.Plugin<T> APluginrepresents an extension to Gradle.PolymorphicDomainObjectContainer<T> ANamedDomainObjectContainerthat allows you to create objects with different types.Project This interface is the main API you use to interact with Gradle from your build file.ProjectEvaluationListener AnProjectEvaluationListeneris notified when a project is evaluated.ProjectState ProjectStateprovides information about the execution state of a project.Rule ARulerepresents some action to perform when an unknown domain object is referenced.Script This interface is implemented by all Gradle Groovy DSL scripts to add in some Gradle-specific methods.Task ATaskrepresents a single atomic piece of work for a build, such as compiling classes or generating javadoc.Transformer<OUT extends @Nullable java.lang.Object,IN> ATransformertransforms objects of type.XmlProvider Provides various ways to access the content of an XML document. -
Class Summary Class Description AntBuilder AnAntBuilderallows you to use Ant from your build script.DefaultTask DefaultTaskis the standardTaskimplementation.Named.Namer An implementation of the namer interface for objects implementing the named interface.Namer.Comparator<T> A comparator implementation based on the names returned by the given namer.Task.Namer Deprecated. -
Enum Summary Enum Description AntBuilder.AntMessagePriority Represents the normal Ant message priorities.JavaVersion An enumeration of Java versions.PathValidation An enumeration for describing validation policies for file paths. -
Exception Summary Exception Description BuildCancelledException ABuildCancelledExceptionis thrown when a build is interrupted due to cancellation request.CircularReferenceException ACircularReferenceExceptionis thrown if circular references exists between tasks, the project evaluation order or the project dependsOn order.GradleException GradleExceptionis the base class of all exceptions thrown by Gradle.GradleScriptException AGradleScriptExceptionis thrown when an exception occurs in the compilation or execution of a script.IllegalDependencyNotation This exceptions is thrown, if a dependency is declared with a illegal notation.InvalidActionClosureException InvalidUserCodeException AInvalidUserCodeExceptionis thrown when user-provided code cannot be executed.InvalidUserDataException AInvalidUserDataExceptionis thrown, if a user is providing illegal data for the build.ProjectConfigurationException Indicates a problem that occurs during project configuration.UncheckedIOException UncheckedIOExceptionis used to wrap anIOExceptioninto an unchecked exception.UnknownDomainObjectException AUnknownDomainObjectExceptionis the super class of all exceptions thrown when a given domain object cannot be located.UnknownProjectException AnUnknownProjectExceptionis thrown when a project referenced by path cannot be found.UnknownTaskException AnUnknownTaskExceptionis thrown when a task referenced by path cannot be found. -
Annotation Types Summary Annotation Type Description Generated Indicates that the annotated member code was generated.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 (thisin Kotlin,delegatein Groovy) as if the lambda expression was an extension method of the parameter type.Incubating Indicates that a feature is incubating.NonExtensible Indicates that the type, when DSL enhanced, does not support extensibility.NonNullApi Marks a type or a whole package as providing a non-null API by default.SupportsKotlinAssignmentOverloading Marks interface that works with overloaded Kotlin assignment.