Package org.gradle.api
-
Interface Summary Interface Description Action<T> Performs some action against objects of type T.ActionConfiguration Allows specification of configuration for some action.Buildable ABuildable
represents an artifact or set of artifacts which are built by one or moreTask
instances.BuildableComponentSpec AComponentSpec
that is directlyBuildable
via a specified task.CheckableComponentSpec AComponentSpec
that is directly checkable via a specified task.Describable Types can implement this interface when they provide a human-readable display name.DomainObjectCollection<T> ADomainObjectCollection
is a specialisedCollection
that adds the ability to modification notifications and live filtered sub collections.DomainObjectSet<T> ExtensiblePolymorphicDomainObjectContainer<T> APolymorphicDomainObjectContainer
that can be extended at runtime to create elements of new types.Named Types can implement this interface and use the embeddedNamed.Namer
implementation, to satisfy API that calls for a namer.NamedDomainObjectCollection<T> ANamedDomainObjectCollection
represents a collection of domain objects that have an inherent, constant, name.NamedDomainObjectContainer<T> A named domain object container is a specialisation ofNamedDomainObjectSet
that adds the ability to create instances of the element type.NamedDomainObjectFactory<T> A factory for named objects of typeT
.NamedDomainObjectList<T> A specialisation ofNamedDomainObjectCollection
that also implementsList
.NamedDomainObjectSet<T> A specialisation ofNamedDomainObjectCollection
that also implementsSet
and 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> APlugin
represents an extension to Gradle.PolymorphicDomainObjectContainer<T> ANamedDomainObjectContainer
that allows to create domain objects with different types.Project This interface is the main API you use to interact with Gradle from your build file.ProjectEvaluationListener AnProjectEvaluationListener
is notified when a project is evaluated.ProjectState ProjectState
provides information about the execution state of a project.Rule ARule
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 ATask
represents a single atomic piece of work for a build, such as compiling classes or generating javadoc.Transformer<OUT,IN> ATransformer
transforms objects of type.XmlProvider Provides various ways to access the content of an XML document. -
Class Summary Class Description AntBuilder AnAntBuilder
allows you to use Ant from your build script.DefaultTask DefaultTask
is the standardTask
implementation.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 ANamer
namer for tasks that returnsTask.getName()
. -
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 ABuildCancelledException
is thrown when a build is interrupted due to cancellation request.CircularReferenceException ACircularReferenceException
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 AGradleScriptException
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 illegal notation.InvalidActionClosureException InvalidUserCodeException AInvalidUserCodeException
is thrown when user-provided code cannot be executed.InvalidUserDataException AInvalidUserDataException
is thrown, if a user is providing illegal data for the build.ProjectConfigurationException Indicates a problem that occurs during project configuration (evaluation) phase.UncheckedIOException UncheckedIOException
is used to wrap anIOException
into an unchecked exception.UnknownDomainObjectException AUnknownDomainObjectException
is the super class of all exceptions thrown when a given domain object cannot be located.UnknownProjectException AnUnknownProjectException
is thrown when a project referenced by path cannot be found.UnknownTaskException AnUnknownTaskException
is thrown when a task referenced by path cannot be found. -
Annotation Types Summary Annotation Type Description 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.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.Nullable Deprecated. UseNullable
instead.