Overview | Package | Class | Deprecated | Index | Help
| Groovy Documentation
PREV NEXT | FRAMES NO FRAMES

## Package org.gradle.api

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

- org.gradle.api.Project
- org.gradle.api.Task

Interface Summary
Action | 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 | A `DomainObjectCollection` is a specialised java.util.Collection that adds the ability to modification notifications and live filtered sub collections.
DomainObjectSet | A `DomainObjectSet` is a specialisation of DomainObjectCollection that guarantees java.util.Set semantics.
Instantiator | An object that can create new instances of a given type, which may be decorated in some fashion.
Named | Types can implement this interface and use the embedded Namer implementation, to satisfy API that calls for a namer.
NamedDomainObjectCollection | A `NamedDomainObjectCollection` represents a collection of domain objects that have an inherent, constant, name.
NamedDomainObjectContainer | A named domain object container is a specialisation of NamedDomainObjectSet that adds the ability to create instances of the element type.
NamedDomainObjectFactory | A factory for named objects of type `T`.
NamedDomainObjectSet | A specialisation of NamedDomainObjectCollection that also implements java.util.Set and orders objects by their inherent name.
Namer | A namer is capable of providing a name based on some inherent characteristic of an object.
Plugin | 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 | 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.
Named.Namer | An implementation of the namer interface for objects implementing the named interface.
Namer.Comparator | A comparator implementation based on the names returned by the given namer.
Task.Namer | A Namer namer for tasks that returns getName().

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.

Groovy Documentation