Package org.gradle.api

Start Here: Gradle's Project API, which is available from your build files.

See:
Description

Interface Summary

Action<T>	Performs some action against objects of type T.
Buildable	A Buildable represents an artifact or set of artifacts which are built by one or more Task instances.
DomainObjectCollection<T>	A DomainObjectCollection represents a read-only set of domain objects of type T.
NamedDomainObjectCollection<T>	A NamedDomainObjectCollection represents a read-only set of domain objects of type T.
NamedDomainObjectContainer<T>	A DomainObjectContainer represents a mutable collection of domain objects of type T.
NamedDomainObjectFactory<T>	A factory for named objects of type T.
Plugin<T>	A Plugin represents an extension to Gradle.
Project	This interface is the main API you use to interact with Gradle from your build file.
ProjectEvaluationListener	An ProjectEvaluationListener is notified when a project is evaluated.
ProjectState	ProjectState provides information about the execution state of a project.
Rule	A Rule represents some action to perform when an unknown domain object is referenced.
Script	This interface is implemented by all Gradle scripts to add in some Gradle-specific methods.
Task	A Task represents a single atomic piece of work for a build, such as compiling classes or generating javadoc.
Transformer<T>	A Transformer transforms objects of type T.

Class Summary

AntBuilder	An AntBuilder allows you to use Ant from your build script.
DefaultTask	DefaultTask is the standard Task implementation.

Enum Summary

JavaVersion	An enumeration of Java versions.
PathValidation	An enumeration for describing validation policies for file paths.

Exception Summary

CircularReferenceException	A CircularReferenceException is thrown if circular references exists between tasks, the project evaluation order or the project dependsOn order.
GradleException	GradleException is the base class of all exceptions thrown by Gradle.
GradleScriptException	A GradleScriptException is 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 ilegal notation.
IllegalOperationAtExecutionTimeException	A IllegalOperationAtExecutionTimeException is thrown if you try to trigger an operation at runtime, which is only allowed at configuration time.
InvalidUserDataException	A InvalidUserDataException is thrown, if a user is providing illegal data for the build.
LocationAwareException	A LocationAwareException is an exception which can be annotated with a location in a script.
ScriptCompilationException	A ScriptCompilationException is thrown when a script cannot be compiled.
UncheckedIOException	UncheckedIOException is used to wrap an java.io.IOException into an unchecked exception.
UnknownDomainObjectException	A UnknownDomainObjectException is the super class of all exceptions thrown when a given domain object cannot be located.
UnknownProjectException	An UnknownProjectException is thrown when a project referenced by path cannot be found.
UnknownTaskException	An UnknownTaskException is thrown when a task referenced by path cannot be found.

Package org.gradle.api Description

Start Here: Gradle's Project API, which is available from your build files. The API used from your build files is made up of 2 main interfaces:

• Project
• Task