All Classes and Interfaces
Class
Description
AbstractArchiveTask
is the base class for all archive tasks.Base implementation for build cache service configuration.
Common superclass for all
ClasspathEntry
instances.The base class for all JVM-based language compilation tasks.
AbstractCopyTask
is the base class for all copy tasks.Displays the dependency tree for a configuration.
AbstractExecTask
is the base class for all exec tasks.Common superclass for the library elements.
Base task for linking a native binary from object files and libraries.
Compiles native source files into object files.
Compiles native header source files into object files.
Compiles native source files into object files.
Base class for compilation-related options.
Base class for tasks that publish a
MavenPublication
.The base class for all project report tasks.
An abstract Scala compile task sharing common functionality for compiling scala.
Convenience base class for
SignatureType
implementations.Convenience base class for
SignatureTypeProvider
implementations.Abstract class for all test task.
Access rule associated to a classpath entry.
Access rule associated with an Eclipse classpath entry.
Performs some action against objects of type T.
Allows specification of configuration for some action.
A
CompositeSpec
which requires all its specs to be true in order to evaluate to true.This plugin allows to send announce messages to Twitter.
The extension used by the AnnouncePlugin.
An
Announcer
allows messages to be sent.An
AntBuilder
allows you to use Ant from your build script.Represents the normal Ant message priorities.
An
AntBuilderAware
represents an object which can add itself to Ant tasks, using an AntBuilder
.A plugin for adding Antlr support to
java projects
.Contract for a Gradle "convention object" that acts as a handler for what I call a virtual directory mapping,
injecting a virtual directory named 'antlr' into the project's various
source
sets
.Generates parsers from Antlr grammars.
A task which executes an Ant target.
Assembles an "API Jar" containing only the members of a library's public API.
A software application.
A binary produced from a `
ApplicationSpec
`.A
Plugin
which runs a project as a Java Application.The
Convention
used for configuring the ApplicationPlugin
.A specification of a
Application
.Represents a plugin that has been applied.
A cpu architecture.
Armored signature type.
An artifact of a software component that may be requested in the result of an artifact query.
A collection of artifacts resolved for a configuration.
This class is for defining artifacts to be published and adding them to configurations.
The identifier for a module artifact.
A repository for resolving and publishing artifacts.
A
ResolverContainer
is responsible for managing a set of ArtifactRepository
instances.Command methods for controlling artifact resolution via the DSL.
A builder to construct a query that can resolve selected software artifacts of the specified components.
The result of executing an artifact resolution query.
The result of resolving an artifact.
Base class for artifact transformations.
An exception to report a problem during transformation execution.
Defines a set of known artifact types and related meta-data.
Meta-data about a particular type of artifacts.
A view over the artifacts resolved for this set of dependencies.
Configuration for a defined artifact view.
Translates Assembly language source files into object files.
Adds core Assembler language support.
A plugin for projects wishing to build native binary components from Assembly language sources.
A set of assembly language sources.
An attribute is a named entity with a type.
A rule that determines whether a given attribute value is compatible some provided attribute value.
An attribute container is a container of
attributes
, which are
strongly typed named entities.A rule that selects the best value out of a set of two or more candidates.
An attribute matching strategy is responsible for providing information about how an
Attribute
is matched during dependency resolution.Represent the attributes of a manifest section.
An attributes schema stores information about
attributes
and how they
can be matched together.Base interface for transport authentication schemes.
Container for configuring repository authentication schemes of type
Authentication
.An artifact repository which supports username/password authentication.
Represents credentials used to authenticate with Amazon Web Services.
Base class that may be used for custom
BinarySpec
implementations.Base class that may be used for custom
GeneralComponentSpec
implementations.Specifies options for launching a child process.
Fork options for compilation.
Base class that may be used for custom
LanguageSourceSet
implementations.A
Plugin
which defines a basic project lifecycle and some common convention properties.A
Convention
used for the BasePlugin.Options for Scala platform compilation.
Authentication scheme for basic access authentication over HTTP.
Provides some basic details about a Gradle project.
IdeaProject that does not provide/resolve any external dependencies.
A physical binary artifact, which can run on a particular platform or runtime.
Base plugin for binaries support.
A container for project binaries, which represent physical artifacts that can run on a particular platform or runtime.
Binary signature type.
Represents a binary that is the result of building a component.
Declares the tasks to build a custom
BinarySpec
binary.A collection of tasks associated to a binary
A
Buildable
represents an artifact or set of artifacts which are built by one or more Task
instances.A
ComponentSpec
that is directly Buildable
via a specified task.Represents an element which has Gradle tasks associated with it.
An action that executes against a Gradle build and produces a result of type
T
.Used to execute a
BuildAction
in the build process.Thrown when a
BuildAction
fails.A
BuildListener
adapter class for receiving build events.A plugin which announces interesting build lifecycle events.
Configuration object for a build cache.
Configuration for the build cache for an entire Gradle build.
A reader for build cache entries.
Writer to serialize a build cache entry.
BuildCacheException
is the base class of all exceptions thrown by a BuildCacheService
.Cache key identifying an entry in the build cache.
Protocol interface to be implemented by a client to a build cache backend.
Factory interface to be provided by build cache service implementations.
Builder-style object that allows build cache service factories to describe the cache service.
A
BuildCancelledException
is thrown when a build is interrupted due to cancellation request.Thrown when a
LongRunningOperation
is cancelled before the operation completes.A build command.
Provides a
BuildAction
various ways to control a Gradle build and access information about the build.Adds a task, "buildDashboard", that aggregates the output of all tasks that produce reports.
The reporting configuration for the
GenerateBuildDashboard
task.Informs about the build environment, like Gradle version or the Java home in use.
Provides information about the build environment for the project that the task is associated with.
Thrown when a Gradle build fails or when a model cannot be built.
Identifies a Gradle build.
Identifies a Gradle build.
The build init plugin.
A model providing access to
Launchable
instances that can be used
to initiate Gradle build.A
BuildLauncher
allows you to configure and execute a Gradle build.A
BuildListener
is notified of the major lifecycle events as a build is executed.Represents a model that is associated with or represents some Gradle build.
A
BuildResult
packages up the results of a build executed by a GradleLauncher
instance.The result of executing a build, via the
GradleRunner
.A task that was executed when running a specific build.
Specifies a build-type for a native binary.
A container of
BuildType
s.Attached to a task type to indicate that task output caching should be enabled by default for tasks of this type.
Token that propagates notification that an operation should be cancelled.
A
CancellationTokenSource
allows you to issue cancellation requests to one or more LongRunningOperation
instances.Represents a capability.
Compiles C source files into object files.
A
ComponentSpec
that is directly checkable via a specified task.Runs Checkstyle against some source files.
Configuration options for the Checkstyle plugin.
Checkstyle Plugin.
The reporting configuration for the
Checkstyle
task.A
CircularReferenceException
is thrown if circular references exists between tasks, the project
evaluation order or the project dependsOn order.The Clang tool chain.
Adds core C language support.
An exploded binary containing resources and compiled class files.
Marks a property as specifying a JVM classpath for a task.
A collection of files to be used as a class path.
Represents the customizable elements of an eclipse classpath file.
Optional description associated with Eclipse classpath entries.
Represents an entry in the Eclipse classpath.
Normalizes file input that represents a Java runtime classpath.
To model a module in your dependency declarations.
Runs CodeNarc against some source files.
Configuration options for the CodeNarc plugin.
CodeNarc Plugin.
The reporting configuration for the
CodeNarc
test.Base Code Quality Extension.
Represents a source set for CoffeeScript sources
Provides arguments to a process.
An executable tool that forms part of a tool chain.
Executes two Gradle builds (that can be the same build) with specified versions and compares the outcomes.
Preconfigures the project to run a gradle build comparison.
Deprecated.
The interface is only here to allow plugins built against Gradle 2.x to run and it will be removed in Gradle 5.0.
Deprecated.
The interface is only here to allow plugins built against Gradle 2.x to run and it will be removed in Gradle 5.0.
Provides context about attribute compatibility checks, and allows the user to define
when an attribute is compatible with another.
A chain of compatibility checks, implemented as action rules.
Marks a property as specifying a Java compile classpath for a task.
Normalizes file input that represents a Java compile classpath.
Main options for Java compilation.
Version of a compiler.
A software component that can be queried via the Artifact Query API.
An opaque immutable identifier for an artifact that belongs to some component instance.
The result of successfully resolving a component with a set of artifacts.
Base plugin for
ComponentSpec
support.Declares the binaries that should be built for a custom
ComponentSpec
type.An opaque immutable identifier for a component instance.
Provides a read-only view of a resolved component's metadata, which typically originates from
a component descriptor (Ivy file, Maven POM).
A component metadata builder.
Describes a resolved component's metadata, which typically originates from
a component descriptor (Ivy file, Maven POM).
Allows the build to provide rules that modify the metadata of depended-on software components.
A component metadata rule is responsible for providing the initial metadata of a component
from a remote repository, in place of parsing the descriptor.
A component metadata rule details, giving access to the identifier of the component being
resolved, the metadata builder, and the repository resource accessor for this.
Base plugin for component support.
Contains immutable component module metadata information.
Contains and allows configuring component module metadata information.
Allows to modify the metadata of depended-on software components.
Displays some details about the software components produced by the project.
The result of resolving a component.
Represents a tuple of the component selector of a module and a candidate version
to be evaluated in a component selection rule.
Answers the question why a component was selected during the dependency resolution.
Represents a container for component selection rules.
Represents some opaque criteria used to select a component instance during dependency resolution.
A software component that is built by Gradle.
A container of software components.
Declares a custom
ComponentSpec
type.Represents a component that determines its publication coordinates.
Represents a
SoftwareComponent
that provides one or more mutually exclusive children, or variants.A
Spec
which aggregates a sequence of other Spec
instances.Specifies the compression which should be applied to a TAR archive.
An immutable mapping to map a dependency configuration to a Maven scope.
Defines a set of rules for how to map the Gradle dependencies to a POM.
A configuration file generated for Visual Studio.
A
ConfigurableFileCollection
is a mutable FileCollection
.A
FileTree
with a single base directory, which can be configured and modified.A build that is to be included in the composite.
A
ConfigurableLauncher
allows you to configure a long running operation.A
PublishArtifact
whose properties can be modified.A file based report to be created with a configurable destination.
A
Configuration
represents a group of artifacts and their dependencies.A
Namer
namer for configurations that returns Configuration.getName()
.The states a configuration can be into.
A
ConfigurationContainer
is responsible for declaring and managing configurations.Thrown when a cycle is encountered while configuring a model element.
Represents the outgoing artifacts associated with a configuration.
Represents some variant of an outgoing configuration.
Attached to a task property to indicate that the property is not to be taken into account for up-to-date checking,
because its value only influences the console output of the task.
Specifies how to treat color and dynamic console output.
A container classpath entry.
Represents some binary resource whose content can be filtered.
A
Convention
manages a set of convention objects.Deprecated.
This class will be removed in Gradle 5.0.
Copies files into a destination directory.
Specifies the destination of a copy.
Specifies sources for a file copy.
A set of specifications for copying files.
Provides the core Javadoc Options.
A plugin for projects wishing to build native binary components from C sources.
Configuration for a C++ application, defining the source files that make up the application plus other settings.
A common base plugin for the C++ executable and library plugins
A binary built from C++ source and linked from the resulting object files.
Compiles C++ source files into object files.
Configuration for a C++ component, such as a library or executable, defining the source files and private header directories that make up the component.
An executable built from C++ source.
A plugin that produces a native executable from C++ source.
Adds core C++ language support.
Configuration for a C++ library, defining the source files and header directories that make up the library plus other settings.
A plugin that produces a native library from C++ source.
A plugin for projects wishing to build native binary components from C++ sources.
Compiles C++ header source files into object files.
A shared library built from C++ source.
A set of C++ source files.
A C++ test suite.
A plugin that sets up the infrastructure for testing C++ binaries using a simple test executable.
Compiles C header source files into object files.
Creates start scripts for launching JVM applications.
Creates start scripts for launching JVM applications.
Assembles a static library from object files.
Base interface for credentials used for different authentication purposes.
A set of C source files.
A plugin that applies the
CUnitPlugin
and adds conventions on top of it.A plugin that sets up the infrastructure for testing native binaries with CUnit.
An executable which run a CUnit test suite.
Test suite of CUnit tests.
A HTML Report whose generation can be customized with a XSLT stylesheet.
Debug options for Java compilation.
Denotes that the
RuleSource
method rule carrying this annotation initializes the rule subject with default values.The default
SignatureTypeProvider
implementation including support for
BinarySignatureType
and ArmoredSignatureType
signatures.DefaultTask
is the standard Task
implementation.Indicates that the annotated object is designed to be configured only once, and that changes to configuration inputs made after configuration should not be allowed.
Deletes files or directories.
A specification for deleting files from the filesystem.
Responsible for detecting headers which are inputs to a native compilation task.
Describes the dependencies of a variant declared in a resolved component's metadata, which typically originate from
a component descriptor (Gradle metadata file, Ivy file, Maven POM).
A
Dependency
represents a dependency on the artifacts from a particular source.Represents a dependency of an IDEA module.
Represents an artifact dependency.
An
Artifact
represents an artifact included in a Dependency
.Represents a constraints over all, including transitive, dependencies.
A
DependencyHandler
is used to declare dependencies.Generates a report that attempts to answer questions like:
Why is this dependency in the dependency graph?
Exactly which dependencies are pulling this dependency into the graph?
What is the actual version (i.e.
Describes a dependency declared in a resolved component's metadata, which typically originates from
a component descriptor (Gradle metadata file, Ivy file, Maven POM).
The set of reports that can be generated by the
HtmlDependencyReportTask
task type.Displays the dependency tree for a project.
Command methods for controlling dependency resolution via the DSL.
A
DependencyResolutionListener
is notified as dependencies are resolved.Provides details about a dependency when it is resolved.
An edge in the dependency graph.
A set of artifact dependencies.
A dependency onto a Gradle component.
A builder of a
DependencySpec
.A container for dependency specifications.
Provides means to substitute a different dependency during resolution.
Allows replacing dependencies with other dependencies.
Provides a DSL-friendly mechanism for specifying the target of a substitution.
Displays dependent components.
A source set that can have dependencies on other Libraries.
A source set that depends on one or more
NativeDependencySet
s to be built.A deployment descriptor such as application.xml.
Types can implement this interface when they provide a human-readable display name.
Marks a property as specifying a file or directory that a task destroys.
Authentication scheme for digest access authentication over HTTP.
Represents a directory at some fixed location on the file system.
Configuration object for the local directory build cache.
Represents some configurable directory location, whose value is mutable and is not necessarily currently known until later.
A directory based report to be created.
A directory with some associated include and exclude patterns.
Deprecated.
Use
DirectoryProperty
instead.A chain of disambiguation rules.
A distribution allow to bundle an application or a library including dependencies,sources...
A
DistributionContainer
manages a set of Distribution
objects.A
Plugin
to package project as a distribution.A
DomainObjectCollection
is a specialised Collection
that adds the ability to modification notifications and live filtered sub collections.A set of domain objects of type T.
Thrown when more than one file with the same relative path name is to be copied
and the
DuplicatesStrategy
is set to DuplicatesStrategy.FAILStrategies for dealing with the potential creation of duplicate files for or archive entries.
Signals that a
RuleSource
rule should be applied to all matching descendant elements of the scope instead of the scope itself.Assembles an EAR archive.
A module element in a deployment descriptor like application.xml.
A
Plugin
with tasks which assemble a web application into a EAR file.Ear Plugin Convention.
A security-role element in a deployment descriptor like application.xml.
A module element in a deployment descriptor like application.xml that has a web child element.
An Eclipse build command is a reference to a project builder object which automatically executes whenever a resource
in the associate project changes.
The build path settings for the generated Eclipse project.
Eclipse classpath entry used by third-party plugins to contribute to the project's classpath.
An element that can have classpath attributes.
Represents an Eclipse-specific external artifact dependency.
Describes Eclipse Java source settings for compiling and running some Java source code.
Enables fine-tuning jdt details of the Eclipse plugin
Linked resources are files and folders that are stored in locations in the file system outside of the project's location.
DSL-friendly model of the Eclipse project information.
The output location of an Eclipse project.
A plugin which generates Eclipse files.
Enables fine-tuning project details (.project file) of the Eclipse plugin
The complete model of an Eclipse project.
Represents a dependency on another Eclipse project.
An Eclipse project nature definition.
A source directory in an Eclipse project.
Enables fine-tuning wtp/wst details of the Eclipse plugin
Enables fine-tuning wtp component details of the Eclipse plugin
Enables fine-tuning wtp facet details of the Eclipse plugin
A plugin which configures the Eclipse Web Tools Platform.
Described model element.
The EmptyFileVisitor can be extends by implementations that only require to implement one of the 2 visit methods
(dir or file).
An
ExcludeRule
is used to describe transitive dependencies that should be excluded when resolving
dependencies.A container for adding exclude rules for dependencies.
Executes a command line process.
Represents the result of running an external process.
Specified the options for executing some command.
A
PolymorphicDomainObjectContainer
that can be extended at runtime to
create elements of new types.Objects that can be extended at runtime with other objects.
Allows adding 'namespaced' DSL extensions to a target object.
An
ExternalDependency
is a Dependency
on a source outside the current project hierarchy.Represents an external artifact dependency.
A
ModuleDependency
is a Dependency
on a module outside the current project hierarchy.Additional, ad-hoc, properties for Gradle domain objects.
The exception that will be thrown when an attempt is made to read a property that is not set.
A project facet.
An
installed
facet is really present on an Eclipse project whereas facet type fixed
means that
this facet is locked and cannot be simply removed.Represents a failure.
Describes how an operation finished with failures.
A
FileCollection
represents a collection of files which you can query in certain ways.Ant types which a
FileCollection
can be mapped to.A
FileCollectionDependency
is a Dependency
on a collection of local files which are not stored in a
repository.Models the generation/parsing/merging capabilities.
Provides details about a file or directory about to be copied, and allows some aspects of the destination file to
be modified.
A normalizer used to remove unwanted noise when considering file inputs.
A Path that keeps the reference to the File
A reference to a file in eclipse.
Represents some immutable location on the file system.
A
FileTree
represents a hierarchy of files.Information about a file in a
FileTree
.Provides access to details about a file or directory being visited by a
FileVisitor
.A
FileVisitor
is used to visit each of the files in a FileTree
.Denotes that the
RuleSource
method rule carrying this annotation finalizes the rule subject.Analyzes code with FindBugs.
Configuration options for the FindBugs plugin.
A plugin for the FindBugs byte code analyzer.
The reporting configuration for the
FindBugs
task.The single file XML report for FindBugs.
An event that informs about an operation having finished its execution.
A repository that looks into a number of directories for artifacts.
Defines a custom variant that differentiate a
NativeBinary
.A container of
Flavor
s.Forking mode for workers.
Fork options for Java compilation.
A container holding
LanguageSourceSet
s with a similar function
(production code, test code, etc.).The GNU GCC tool chain.
An executable tool used for GCC that allows customizing the executable.
A ToolChain that can handle additional platforms simply by configuring the NativeBinary.
A
Plugin
which makes the GNU GCC/G++ compiler available for compiling C/C++ code.GCC specific settings for the tools used to build for a particular platform.
A general purpose component specification, that can be used to represent some software component built from source and producing
multiple output variants.
Generates build dashboard report.
Generated the Gradle CUnit launcher: main method and header.
Generates an Eclipse
.classpath
file.Generates the Eclipse JDT configuration file.
Generates an Eclipse
.project
file.Generates the org.eclipse.wst.common.component settings file for Eclipse WTP.
Generates the org.eclipse.wst.common.project.facet.core settings file for Eclipse WTP.
Task for generating a filters file.
Generates an IDEA module file.
Generates an IDEA project file for root project *only*.
Generates an IDEA workspace file *only* for root project.
Generates an Ivy XML Module Descriptor file.
Generates a Maven module descriptor (POM) file.
Generates a Gradle metadata file to represent a published
SoftwareComponent
instance.Generates plugin descriptors from plugin declarations.
Task for generating a project file.
Task for generating a scheme file.
Task for generating a solution file.
Task for generating a workspace settings file.
Task for generating a project file.
Task for generating a workspace file.
A
GeneratorTask
generates a configuration file based on a domain object of type T.A specification of a Git repository.
A plugin that applies the
GoogleTestPlugin
and adds conventions on top of it.A plugin that sets up the infrastructure for testing native binaries with GoogleTest.
An executable which run a Google Test test suite.
Test suite of Google Test tests.
Represents an invocation of Gradle.
Executes a Gradle build.
Provides information about the structure of a Gradle build.
A specification for launching a Gradle build with a specified Gradle version.
Thrown when there is some problem using a Gradle connection.
A
GradleConnector
is the main entry point to the Gradle tooling API.Informs about the Gradle environment, for example the Gradle version.
GradleException
is the base class of all exceptions thrown by Gradle.Informs about a module version, i.e.
Configuration options for the
JavaGradlePluginPlugin
.Represents a Gradle project.
Represents some publication produced by a Gradle project, typically to a Maven or Ivy repository.
Executes a Gradle build, allowing inspection of the outcome.
Represents a Gradle script.
A
GradleScriptException
is thrown when an exception occurs in the compilation or execution of a
script.Represents a task which is executable by Gradle.
Extends
JavaBasePlugin
to provide support for compiling and documenting Groovy
source files.Compiles Groovy source files, and optionally, Java source files.
Compilation options to be passed to the Groovy compiler.
Generates HTML API documentation for Groovy source, and optionally, Java source.
A Link class represent a link between groovydoc/javadoc output and url.
Fork options for Groovy compilation.
Adds Groovy configuration convenience methods on top of the
MavenDeployer
.A
Plugin
which extends the JavaPlugin
to provide support for compiling and documenting Groovy
source files.Provides information related to the Groovy runtime(s) used in a project.
A
GroovySourceSetConvention
defines the properties and methods added to a SourceSet
by the GroovyPlugin
.Represents something that carries attributes by utilizing an
AttributeContainer
Represents something that carries attributes by utilizing an
AttributeContainer
that is configurable.An element that is associated with a Gradle project.
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.Allows a scriptable object, such as a project extension, to declare its preferred public type.
A source set that exposes headers
Adds various reporting tasks that provide information about the project.
Represents the basic information about an Eclipse project.
Represents an element which belongs to some hierarchy.
Generates an HTML dependency report.
Configuration object for the HTTP build cache.
Password credentials for a HTTP build cache backend.
IDEA compiler output settings.
Contains content root information.
IDEA dependency.
The scope of the IDEA dependency.
Describes Java language settings for an IDEA module.
Java language level used by IDEA projects.
Language level setting for IDEA.
DSL-friendly model of the IDEA project information.
Enables fine-tuning module details (*.iml file) of the IDEA plugin.
Represents information about the IDEA module.
Dependency on a module in a project.
Identifies an Idea module.
Models the generation/parsing/merging capabilities of an IDEA module.
Adds a GenerateIdeaModule task.
Enables fine-tuning project details (*.ipr file) of the IDEA plugin.
Represents the information about the IDEA project.
"Single-Entry Module Library" as IDEA calls it.
IDEA source directory.
Enables fine-tuning workspace details (*.iws file) of the IDEA plugin.
This exceptions is thrown, if a dependency is declared with a illegal notation.
A build that is included in the composite.
Options for incremental compilation of Scala code.
Provides access to any input files that need to be processed by an incremental task.
Indicates that a feature is incubating.
Generates a Gradle project structure.
Attached to a task property to indicate that the property specifies some input value for the task.
Marks a property as specifying an input directory for a task.
Marks a property as specifying an input file for a task.
A change to an input file.
Marks a property as specifying the input files for a task.
Input normalization configuration.
Used to configure input normalization.
Represents a Java Development Kit machine installation.
Installs an executable with it's dependent libraries so it can be easily executed.
Creates a XCTest bundle with a run script so it can be easily executed.
Attached to a task property to indicate that the property is not to be taken into account for up-to-date checking.
Thrown when attempting to publish with an invalid
IvyPublication
.Thrown when attempting to publish with an invalid
MavenPublication
.Thrown when a component model is declared in an invalid way.
Thrown when a model rule, or source of model rules, is declared in an invalid way.
Thrown when there is a problem with the usage of a model rule.
Thrown when a plugin is found to be invalid when it is loaded.
Thrown when the plugin under test metadata cannot be read.
Thrown when a build cannot be executed due to the runner being in an invalid state.
A
InvalidUserCodeException
is thrown when user-provided code cannot be executed.A
InvalidUserDataException
is thrown, if a user is providing illegal data for the build.Isolation mode for workers.
An artifact published as part of a
IvyPublication
.An artifact repository which uses an Ivy format to store artifacts and meta-data.
The meta-data provider for an Ivy repository.
A Collection of
IvyArtifact
s to be included in an IvyPublication
.A configuration included in an
IvyPublication
, which will be published in the ivy descriptor file generated.The set of
IvyConfiguration
s that will be included in the IvyPublication
.A module dependency declared in an ivy dependency descriptor published as part of an
IvyPublication
.An Ivy descriptor artifact.
Represents the set of "extra" info elements in the Ivy descriptor.
Represents a modifiable form of IvyExtraInfo so that "extra" info elements
can be configured on an Ivy publication.
An Ivy Module component.
The metadata about an Ivy module that acts as an input to a component metadata rule.
The descriptor of any Ivy publication.
A repository layout that uses user-supplied patterns.
A
IvyPublication
is the representation/configuration of how Gradle should publish something in Ivy format, to an Ivy repository.Adds the ability to publish in the Ivy format to Ivy repositories.
Base class for Jacoco tasks.
Task for verifying code coverage metrics.
Defines a Jacoco rule limit.
Task to merge multiple execution data files into one.
Plugin that provides support for generating Jacoco coverage data.
Extension including common properties and methods for Jacoco.
Task to generate HTML, Xml and CSV reports of Jacoco coverage data.
Base class for Jacoco report tasks.
The reporting configuration for the
JacocoReport
task.Extension for tasks that should run with a Jacoco agent to generate coverage execution data.
The types of output that the agent can use for execution data.
Defines a Jacoco violation rule.
The violation rules configuration for the
JacocoReport
task.Assembles a JAR archive.
Assembles a JAR archive.
Definition of a Jar file binary that is to be built by Gradle.
Provides access to key tasks used for building the binary.
Represents a jar directory element of an idea module library.
Details for generating Java-based application start scripts.
A
Plugin
which compiles and tests Java source, and assembles it into a JAR file.Compiles Java source files.
Generates HTML API documentation for Java classes.
An artifact containing Javadoc documentation.
This enum maps to the -public, -protected, -package and -private options of the javadoc executable.
This class is used to hold the information that can be provided to the javadoc executable via the -linkoffline
option.
Represents a Javadoc command-line option.
This enum maps to the -verbose and -quiet options of the javadoc executable.
Informs about the Java environment, for example the Java home or the JVM args used.
Executes a Java application in a child process.
Specifies the options for executing a Java application.
Specifies the options to use to fork a Java process.
A plugin for building java gradle plugins.
Plugin for compiling Java code.
A
Plugin
which package a Java project as a distribution including the JAR and runtime dependencies.A
Plugin
which extends the capabilities of the Java plugin
by cleanly separating
the API and implementation dependencies of a library.Defines and configures a Java SE runtime environment, consisting of a JVM runtime and a set of class libraries.
A
Plugin
which compiles and tests Java source, and assembles it into a JAR file.Is mixed into the project when applying the
JavaBasePlugin
or the
JavaPlugin
.Represents a Java virtual machine installation.
Task to minify JavaScript assets.
Represents a source set containing javascript sources.
A set of sources passed to the Java compiler.
A set of tools for building from Java source.
A container for
JavaToolChain
s.An enumeration of Java versions.
Analyzes code with JDepend.
Configuration options for the JDepend plugin.
A
Plugin
that generates design quality metrics by scanning your source packages.The reporting configuration for the
JDepend
task.Represents information for the project Java SDK.
Represents the Eclipse JDT settings.
The JUnit specific test options.
Represents a JUnit test suite binary.
This plugin adds support for execution of JUnit test suites to the Java software model.
Represents a JUnit test suite.
The JUnit XML files, commonly used to communicate results to CI servers.
Specifies the packages that constitute the API of a library.
Represents a binary artifact that is the result of building a jvm component.
LanguageOutputType marking Jvm byte code.
A set of classes and resources that operate together.
Base plugin for JVM component support.
Definition of a software component that is to be built by Gradle to run a on JVM platform.
A Library component that runs on the Java Virtual Machine.
Definition of a JVM library component that is to be built by Gradle.
LanguageOutputType marking Jvm Resource Output
A set of resource files.
Plugin for packaging JVM resources.
Enumerates the different kinds of JVM tests.
Describes a test that runs on the JVM and for which an event has occurred.
The base plugin that needs to be applied by all plugins which provide testing support
for the Java software model.
Base type of JVM test suite binaries.
Provides direct access to important build tasks of JVM test suites.
Base type for all JVM test suites.
Base plugin for language support.
A set of sources for a programming language.
Represents an object that can be used to launch a Gradle build, such as a task.
Resolved configuration that does not fail eagerly when some dependencies are not resolved, or some artifacts do not exist.
A library that can be linked into or depended on by another software element.
A classpath entry representing a library.
A dependency onto a specific binary of a library published by a project.
An identifier for a library instance that is built as part of the current build.
A binary produced from a `
LibrarySpec
`.Criteria for selecting a library instance that is built as part of the current build.
A specification of a
Library
.A
Plugin
which defines a basic project lifecycle.Link.
Links a binary executable from object files and libraries.
Links a binary bundle from object files and imported libraries.
Links a binary shared library from object files and imported libraries.
Thrown whenever a listener fails with an exception, which in general implies that
the build completed like it should, but that one of the listeners failed with an
exception.
Represents a property whose type is a
List
of elements of type ListProperty
.A local JDK, JRE or Java 9+ installation.
Marks a property as specifying local state for a task.
An extension to the SLF4J
Logger
interface, which adds the quiet
and lifecycle
log
levels.The main entry point for Gradle's logging system.
A
LoggingConfiguration
defines the logging settings for a Gradle build.A
LoggingManager
provides access to and control over the Gradle logging system.Provides access to the output of the Gradle logging system.
The log levels supported by Gradle.
Offers ways to communicate both ways with a Gradle operation, be it building a model or running tasks.
A managed type is transparent to the model space, and enforces immutability at the appropriate times in the object's lifecycle.
Represents the manifest file of a JAR file.
Is thrown in the case an operation is applied against a
Manifest
that violates
the Manifest specification.Details of a value being merged from two different manifests.
Specifies how the entries of multiple manifests should be merged together.
Simple build cache implementation that delegates to a
ConcurrentMap
.An artifact published as part of a
MavenPublication
.An artifact repository which uses a Maven format to store artifacts and meta-data.
A Collection of
MavenArtifact
s to be included in a MavenPublication
.A dependency declared as part of an
MavenPublication
.A resolver that can only be used for uploading artifacts to a Maven repository.
Represents the artifacts which will be deployed to a Maven repository.
A Maven Module component.
A
Plugin
which allows project artifacts to be deployed to a Maven repository, or installed
to the local Maven cache.Properties and methods added by the
MavenPlugin
.Is used for generating a Maven POM file and customizing the generation.
The POM for a Maven publication.
A Maven POM artifact.
A
MavenPublication
is the representation/configuration of how Gradle should publish something in Maven format.Adds the ability to publish in the Maven format to Maven repositories.
Allows Maven repositories for publishing artifacts to be defined.
An
ArtifactRepository
which can be used to publish artifacts to Maven repositories.A
Plugin
which makes the Microsoft Visual C++ compiler available to compile C/C++ code.Provides the core Javadoc options.
Exception thrown when the resource does not exist
Denotes that the
RuleSource
method rule carrying this annotation creates a new top level element in the model space.A model that is buildable by the Tooling API.
A
ModelBuilder
allows you to fetch a snapshot of some model for a project or a build.Represents an element in a model.
Thrown when a model element cannot be instantiated for some reason.
Model backed map like structure allowing adding of items where instantiation is managed.
Displays some details about the configuration model of the project.
The report format.
Thrown when there is a problem binding the model element references of a model rule.
A set of managed model objects.
Thrown when at attempt is made to mutate a subject of a rule after the rule has completed.
Represents the customizable elements of an iml (via XML hooks everything of the iml is customizable).
An identifier for a component instance which is available as a module version.
Criteria for selecting a component instance that is available as a module version.
A
ModuleDependency
is a Dependency
on a module outside the current project.Represents an orderEntry of type module in the iml XML.
A dependency onto a module.
A builder of a
ModuleDependencySpec
.The identifier of a module.
Represents an orderEntry of type module-library in the iml XML.
Command methods for controlling module resolution via the DSL.
The identifier of a module version.
Selects a module version.
Provides context about candidates for an attribute.
A configurable version constraint.
Denotes that the
RuleSource
method rule carrying this annotation mutates the rule subject.Types can implement this interface and use the embedded
Named.Namer
implementation, to satisfy API that calls for a namer.An implementation of the namer interface for objects implementing the named interface.
A
NamedDomainObjectCollection
represents a collection of domain objects that have an inherent, constant, name.A named domain object container is a specialisation of
NamedDomainObjectSet
that adds the ability to create
instances of the element type.A factory for named objects of type
T
.A specialisation of
NamedDomainObjectCollection
that also implements List
.Provides a domain object of the given type.
A specialisation of
NamedDomainObjectCollection
that also implements Set
and orders objects by their inherent name.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.
A plugin that sets up the infrastructure for testing native binaries.
Represents a particular binary artifact.
Represents a binary artifact that is the result of building a native component.
The configuration for native components generated by this build.
A plugin that sets up the infrastructure for defining native binaries.
A plugin that creates tasks used for constructing native binaries.
Definition of a software component that is to be built by Gradle to run a on JVM platform.
Models a collection of native type dependencies.
An executable native component that is built by Gradle.
A binary artifact for a
NativeExecutable
, targeted at a particular platform with specific configuration.An binary built by Gradle for a native application.
Provides access to key tasks used for building the binary.
Specifies how to build and where to place a native executable file.
Definition of a native executable component that is to be built by Gradle.
Specifies the installation location for a native executable.
A library component that is built by a gradle project.
A physical representation of a
NativeLibrary
component.Represents a binary artifact that is the result of building a native library component.
A dependency on a native library within the build.
Definition of a native library component that is to be built by Gradle.
A target platform for building native binaries.
A platform specific configurable tool chain.
A source set that provides resources.
An executable which runs a suite of tests.
Provides access to key tasks used for building the binary.
A component representing a suite of tests that will be executed together.
A set of compilers and linkers that are used together to construct a native binary.
A container for
NativeToolChain
s.Marks a property as specifying a nested bean, whose properties should be checked for annotations.
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.
A
Spec
implementation which negates another Spec
.Deprecated.
Use
Nullable
instead.An
ObjectConfigurationAction
allows you to apply Plugin
s and scripts to an object
or objects.A factory for creating various kinds of model objects.
LanguageOutputType marking object file output type.
A task that combines a set of object files into a single binary.
Thrown when an object cannot be instantiated.
Compiles Objective-C source files into object files.
Adds core Objective-C language support.
A plugin for projects wishing to build native binary components from Objective-C sources.
Compiles Objective-C++ source files into object files.
Adds core Objective-Cpp language support.
A plugin for projects wishing to build native binary components from Objective-C++ sources.
Compiles Objective C++ header source files into object files.
A set of Objective-C++ source files.
Compiles Objective C header source files into object files.
A set of Objective-C source files.
A machine operating system.
Describes an operation for which an event has occurred.
Describes the result of running an operation.
Enumerates the different types of operations for which progress events can be received.
Marks a task property as optional.
Represents a Javadoc option.
A
CompositeSpec
which requires any one of its specs to be true in order to evaluate to
true.Represents a manifest file for a JAR containing an OSGi bundle.
A
Plugin
which extends the JavaPlugin
to add OSGi meta-information to the project Jars.Is mixed into the project when applying the
OsgiPlugin
.A classpath entry representing an output folder.
Marks a property as specifying one or more output directories for a task.
Marks a property as specifying an output directory for a task.
Marks a property as specifying an output file for a task.
Marks a property as specifying one or more output files for a task.
A
ParallelismConfiguration
defines the parallel settings for a Gradle build.A
ToolingModelBuilder
which can be parametrized by the client.A username/password credentials that can be used to login to password-protected remote repository.
A username/password credentials that can be used to login to something protected by a username and password.
Specifies a model path on a parameter
Represents a path in a format as used often in ipr and iml files.
Path Factory.
Annotates a task file property, specifying which part of the file paths should be considered during up-to-date checks.
Enumeration of different path handling strategies for task properties.
An enumeration for describing validation policies for file paths.
A
PatternFilterable
represents some file container which Ant-style include and exclude patterns or specs
can be applied to.Standalone implementation of
PatternFilterable
.A normalised form for keys, which are friendliest for users as hex strings but used internally as longs.
PGP signatory from PGP key and password.
Creates
PgpSignatory
instances.A
SignatoryProvider
of PgpSignatory
instances.The platform or runtime that a binary is designed to run on.
Defines Platform specific operations for ComponentSpecs
A container of
Platform
s.A platform-aware Java compile task.
A platform-aware Scala compile task.
Represents a binary artifact that is the result of building a Play application software component.
Plugin for Play Framework component support.
Definition of a Play Framework software component that is built by Gradle.
Task for compiling CoffeeScript sources into JavaScript.
Plugin for adding coffeescript compilation to a Play application.
Represents a Play distribution package
Manages a set of
Distribution
objects.A plugin that adds a distribution zip to a Play application build.
Plugin for configuring IDE plugins when the project uses the Play Framework component support.
Plugin for adding javascript processing to a Play application.
Defines and configures a Play Framework environment including versions of Play, Scala and Java.
Platform aware aspect of a Play Framework software component.
Plugin for Play Framework component support.
Conventional locations and names for play plugins.
Plugin for compiling Play routes sources in a Play application.
Task to run a Play application.
Plugin for executing tests from a Play Framework application.
A set of tools for building applications using the Play Framework.
Plugin for compiling Twirl sources in a Play application.
A
Plugin
represents an extension to Gradle.Something that can have plugins applied to it.
A
PluginCollection
represents a collection of Plugin
instances.A
PluginContainer
is used to manage a set of Plugin
instances applied to a
particular project.Describes a Gradle plugin under development.
The DSL for declaring plugins to use in a script.
A mutable specification of a dependency on a plugin.
A description of a plugin.
A
PluginInstantiationException
is thrown when a plugin cannot be instantiated.Configures how plugins are resolved.
Facilitates applying plugins and determining which plugins have been applied to a
PluginAware
object.Contains information about a plugin that has been requested for resolution.
Allows modification of
PluginRequest
s before they are resolved.Allows plugin resolution rules to inspect a requested plugin and modify which
target plugin will be used.
Custom task for generating the metadata for a plugin user test.
Runs a set of static code analysis rules on Java source code files and generates a report of problems found.
Configuration options for the PMD plugin.
A plugin for the PMD source code analyzer.
The reporting configuration for the
Pmd
task.A
NamedDomainObjectContainer
that allows to create domain objects with different types.Manages a set of
MavenPom
instances and their associated PublishFilter
instances.A container of
PrebuiltLibrary
instances.A library component that is not built by gradle.
A shared library that exists at a known location on the filesystem.
A static library that exists at a known location on the filesystem.
Generates a prefix header file from a list of headers to be precompiled.
A tool that permits configuration of the C preprocessor.
Specifies the options to use to fork a process.
Copies resources from their source to their target directory, potentially processing them.
Root interface for all events that signal progress while executing an operation.
Some information about a piece of work of a long running operation.
A listener which is notified when operations that are executed as part of running a build make progress.
A listener which is notified as some long running operation makes progress.
This interface is the main API you use to interact with Gradle from your build file.
Represents the customizable elements of an eclipse project file.
Represents the customizable elements of an ipr (via XML hooks everything of the ipr is customizable).
Creates dummy instances of
Project
which you can use in testing custom task and plugin
implementations.An identifier for a component instance that is built as part of the current build.
Criteria for selecting a component instance that is built as part of the current build.
Indicates a problem that occurs during project configuration (evaluation) phase.
Represents a long-lived connection to a Gradle project.
A
ProjectDependency
is a Dependency
on another project in the current project hierarchy.A classpath entry representing a project dependency.
Represents a dependency on another project.
A dependency onto a library published by a project.
A builder of a
ProjectDependencySpec
.A
ProjectDescriptor
declares the configuration required to create and evaluate a Project
.An
ProjectEvaluationListener
is notified when a project is evaluated.Identifies a Gradle project.
Provides access to several important locations for a project.
A project-level IDEA library.
Represents a model that is associated with some Gradle project.
A model providing information about the publications of a Gradle project.
A
Plugin
which adds some project visualization report tasks to a project.The conventional configuration for the `ProjectReportsPlugin`.
Displays a list of projects in the build.
A container of
LanguageSourceSet
s.ProjectState
provides information about the execution state of a project.Models the generation/parsing/merging capabilities.
PropertiesGeneratorTask<T extends org.gradle.plugins.ide.internal.generator.generator.PersistableConfigurationObject>
A convenience superclass for those tasks which generate Properties configuration files from a domain object of type T.
A
Provider
representation for capturing the state of a property.PropertyListGeneratorTask<T extends org.gradle.plugins.ide.internal.generator.generator.PersistableConfigurationObject>
A convenience superclass for those tasks which generate Property List configuration files from a domain object of type T.
Displays the properties of a project.
Deprecated.
Use
Property
instead.A container object that provides a value of a specific type.
A factory for creating instances of
Provider
and PropertyState
.A set of public assets added to a binary.
A publication is a description of a consumable representation of one or more artifacts, and possibly associated metadata.
A
PublicationContainer
is responsible for creating and managing Publication
instances.A
PublishArtifact
is an artifact produced by a project.A set of artifacts to be published.
A
PublishException
is thrown when a dependency configuration cannot be published for some reason.A filter for artifacts to be published.
The configuration of how to “publish” the different components of a project.
Installs a
PublishingExtension
with name "publishing".Publishes an IvyPublication to an IvyArtifactRepository.
Publishes a
MavenPublication
to the Maven Local repository.Publishes a
MavenPublication
to a MavenArtifactRepository
.A resource that can be read.
Thrown when an attempt is made to change the value of a model element that is not writable at the time.
Represents a regular file at a fixed location on the file system.
Represents some configurable regular file location, whose value is mutable and not necessarily currently known until later.
Deprecated.
Use
RegularFileProperty
instead.Represents a relative path from some base directory to a file.
A file based report to be created.
The type of output the report produces
A container of
Report
objects, that represent potential reports.The exception thrown when any of this container's mutation methods are called.
An object that provides reporting options.
A
Plugin
which provides the basic skeleton for reporting.A project extension named "reporting" that provides basic reporting settings and utilities.
The repositories that Gradle will search for prebuilt libraries.
A
RepositoryHandler
manages a set of repositories, allowing repositories to be defined and queried.Represents the directory structure for a repository.
Provides access to resources on an artifact repository.
Visitor which can request a reproducible file order.
Command methods for controlling dependency resolution via the DSL.
Contains the information about the result of dependency resolution.
Represents a set of rules/actions that can be applied during dependency resolution.
Defines the strategies around dependency resolution.
Defines the sort order for components and artifacts produced by the configuration.
A set of
Dependency
objects which can be resolved to a set of files.Information about a resolved artifact.
The result of successfully resolving an artifact.
Represents a component instance in the resolved dependency graph.
A
ResolvedConfiguration
represents the result of resolving a Configuration
, and provides access
to both the artifacts and the meta-data of the result.Information about a resolved dependency.
A dependency that was resolved successfully.
Represents meta-data about a resolved module version.
The result of successfully resolving a component variant.
A
ResolveException
is thrown when dependency resolution fails for some reason.A generic resource of some kind.
Generic resource exception that all other resource-related exceptions inherit from.
The gradle DSL model of an Eclipse resource filter.
Specifies the type of resource that the Eclipse
ResourceFilter
applies to.The model of an Eclipse resource filter matcher.
Specifies whether an Eclipse
ResourceFilter
is including or excluding resources.Provides access to resource-specific utility methods, for example factory methods that create various resources.
A handler for an asynchronous operation which returns an object of type T.
Task for compiling routes templates into Scala code.
Represents a source set containing routes files
A
Rule
represents some action to perform when an unknown domain object is referenced.Attached to the getter for a property on a
RuleSource
to denote that the property defines an implicit input for all rules defined by the rule source.Denotes that the
RuleSource
method rule carrying this annotation defines additional rules based on its inputs.A marker type for a class that is a collection of rules.
Attached to the getter for a property on a
RuleSource
to denote that the property defines the target for the rule source.Runs a compiled and installed test executable.
Configuration of runtime classpath normalization.
A
Plugin
which compiles and tests Scala sources.Compiles Scala source files, and optionally, Java source files.
Options for Scala Compilation.
Generates HTML API documentation for Scala source files.
Options for the ScalaDoc tool.
Fork options for Scala compilation.
Plugin for compiling Scala code.
A set of sources passed to the Scala compiler.
Defines and configures a Scala Platform.
A
Plugin
which sets up a Scala project.Provides information related to the Scala runtime(s) used in a project.
A
ScalaSourceSetConvention
defines the properties and methods added to a SourceSet
by the ScalaPlugin
.A set of tools for building Scala applications
This interface is implemented by all Gradle scripts to add in some Gradle-specific methods.
Generates a script to start a JVM application.
A
ScriptHandler
allows you to manage the compilation and execution of a build script.A
SelfResolvingDependency
is a Dependency
which is able to resolve itself, independent of a
repository.Declares the configuration required to instantiate and configure the hierarchy of
Project
instances which are to participate in a build.A
NativeLibrary
that has been compiled and linked as a shared library.A shared library binary built by Gradle for a native library.
Provides access to key tasks used for building the binary.
Specifies the detail to include in stacktraces.
A task for creating digital signature files for one or more; tasks, files, publishable artifacts or configurations.
A signatory is an object capable of providing a signature for an arbitrary stream of bytes.
Provides implementations of signatory implementations for a project.
Convenience base class for
Signatory
implementations.A digital signature file artifact.
Specifies how objects will be signed.
The type of signature.
Provider of
SignatureType
.The global signing configuration for a project.
Adds the ability to digitally sign files and artifacts.
A sign operation creates digital signatures for one or more files or
publish artifacts
.Single entry module library
A report that is a single file.
Describes how an operation was skipped.
Attached to a task property to indicate that the task should be skipped when the value of the property is an empty
FileCollection
or directory.A software component produced by a Gradle software project.
A Container that contains all of the Software Components produced by a Project.
Represents some component whose implementation can be represented as a collection of source files, and whose other
outputs are built from this source.
Configuration related to source dependencies.
Represents a source directory.
A
SourceDirectorySet
represents a set of source files composed from a set of source directories, along
with associated include and exclude patterns.SourceFolder.path contains only project relative path.
An artifact containing sources for a software component.
A
SourceSet
represents a logical group of Java source and resources.A
SourceSetContainer
manages a set of SourceSet
objects.A collection of all output directories (compiled classes, processed resources, etc.) - notice that
SourceSetOutput
extends FileCollection
.A
SourceTask
performs some operation on source files.Thrown when a source code transformation fails.
Represents some predicate against objects of type T.
Provides a number of
Spec
implementations.Provides the options for the standard Javadoc doclet.
A
StandardOutputListener
receives text written by Gradle's logging system to standard output or
error.An event that informs about an operation having started its execution.
StartParameter
defines the configuration used by a Gradle instance to execute a build.A
NativeLibrary
that has been compiled and archived into a static library.A static library binary built by Gradle for a native library.
Provides access to key tasks used for building the binary.
An event that informs about an interim results of the operation.
A
StopActionException
is be thrown by a task Action
or task action closure to
stop its own execution and to start execution of the task's next action.A
StopExecutionException
is thrown by a Action
or task action closure to
stop execution of the current task and start execution of the next task.Describes how an operation finished successfully.
Configuration for a Swift application, defining the source files that make up the application plus other settings.
A common base plugin for the Swift executable and library plugins
A binary built from Swift source.
The Swift Compiler tool chain.
Compiles Swift source files into object files.
Configuration for a Swift component, such as a library or executable, defining the source files that make up the component plus other settings.
Swiftc specific settings for the tools used to build for a particular platform.
An executable built from Swift source.
A plugin that produces an executable from Swift source.
Configuration for a Swift library, defining the source files that make up the library plus other settings.
A plugin that produces a shared library from Swift source.
A shared library built from Swift source.
An test binary built from Swift source.
A XCTest suite, implemented in Swift.
Synchronizes the contents of a destination directory with some source directories and files.
Assembles a TAR archive.
A native component that can be configured to target certain variant dimensions.
Represents the PMD targetjdk property available for PMD < 5.0
A
Task
represents a single atomic piece of work for a build, such as compiling classes or generating
javadoc.Represents a task which is executable by Gradle.
A
Namer
namer for tasks that returns Task.getName()
.Marks a method as the action to run when the task is executed.
A
TaskActionListener
is notified of the actions that a task performs.A
TaskCollection
contains a set of Task
instances, and provides a number of query methods.A
TaskContainer
is responsible for managing a set of Task
instances.A
TaskDependency
represents an unordered set of tasks which a Task
depends on.Represents the files or directories that a
Task
destroys (removes).A
TaskExecutionListener
adapter class for receiving task execution events.A
TaskExecutionException
is thrown when a task fails to execute successfully.A
TaskExecutionGraph
is responsible for managing the execution of the Task
instances which
are part of the build.A
TaskExecutionGraphListener
is notified when the TaskExecutionGraph
has been populated.A
TaskExecutionListener
is notified of the execution of the tasks in a build.A request to execute some tasks, along with an optional project path context to provide information necessary to select the tasks
Describes how a task operation finished with failures.
Describes a property of a task that contains zero or more files.
An event that informs about a task having finished its execution.
Describes an input property of a task that contains zero or more files.
Describes an input property of a task.
A
TaskInputs
represents the inputs for a task.A
TaskInstantiationException
is thrown when a task cannot be instantiated for some reason.Represents the files or directories that represent the local state of a
Task
.Describes a task operation for which an event has occurred.
Describes the result of running a task operation.
The outcome of executing a task during a build.
Describes an output property of a task that contains zero or more files.
A
TaskOutputs
represents the outputs of a task.Root interface for all events that signal progress while executing a task.
Describes a property of a task.
Providers a task of the given type.
A lightweight reference to a task.
Displays a list of tasks in the project.
Represents a
Launchable
that uses task name to select tasks executed from a given project and its sub-projects.Describes how a task operation was skipped.
An event that informs about a task having started its execution.
TaskState
provides information about the execution state of a Task
.Describes how a task operation finished successfully.
A
TaskValidationException
is thrown when there is some validation problem with a task.Interface for generating scripts with the provided details based on a provided template.
Executes JUnit (3.8.x or 4.x) or TestNG tests.
Describes a test.
Determines how exceptions are formatted in test logging.
A
TestExecutionException
is thrown when no tests can be found that match the specified test filters.Thrown when the
TestLauncher
cannot run tests, or when one or more tests fail.Describes how a test operation finished with failures.
Allows filtering tests for execution.
An event that informs about a test having finished its execution.
The base class for any test framework specific options.
Base plugin for testing.
Base plugin for testing.
A
TestLauncher
allows you to execute tests in a Gradle build.Interface for listening to test execution.
Test events that can be logged.
Options that determine which test events get logged, and at which detail.
Container for all test logging related options.
The TestNG specific test options.
Describes a test operation for which an event has occurred.
Describes the result of running a test operation.
Standard output or standard error message logged during the execution of the test
Destination of the message
Listens to the output events like printing to standard output or error
Root interface for all events that signal progress while executing a test or test suite.
Generates an HTML test report from the results of one or more
Test
tasks.Describes a test result.
The final status of a test.
Describes how a test operation was skipped.
Stack trace filters for test logging.
An event that informs about a test having started its execution.
Describes how a test operation finished successfully.
A binary which runs a suite of tests.
A container of
TestSuiteSpec
instances.A component representing a suite of tests that will be built and executed together.
Provides access to key tasks used by a test suite.
The reports produced by the
Test
task.A plain text config file generated for Visual Studio.
Provides access to the content of a generated text file.
A read-only body of text backed by a string, file, archive entry, or other source.
Creates
TextResource
s backed by sources such as strings, files, and archive entries.Configuration of the arguments of a ToolChain executable.
A set of compilers that are used together to construct binaries.
A Provider of
ToolChain
s.Responsible for building tooling models to return to the tooling API client.
A registry of tooling model builders.
The type of a file of a transformation
A
Transformer
transforms objects of type.Task for compiling Twirl templates into Scala code.
Represents the available sets of default imports that can be used when compiling Twirl templates.
Represents a source set containing twirl templates
Twirl Template format mapping
A TypeBuilder to configure the registration of a type.
Provides a way to preserve high-fidelity
Type
information on generic types.Thrown by Gradle when it is unable to delete a file.
UncheckedIOException
is used to wrap an IOException
into an unchecked exception.Thrown when executing a build that was expected to succeed, but failed.
Base class for
UnexpectedBuildFailure
and UnexpectedBuildSuccess
.Thrown when executing a build that was expected to fail, but succeeded.
Unexports the
main
entry point symbol in an object file, so the object file can be linked with an executable.An
UnknownConfigurationException
is thrown when a configuration referenced by name cannot be found.A
UnknownDomainObjectException
is the super class of all exceptions thrown when a given domain object
cannot be located.Thrown when an unknown tooling model is requested.
Thrown when the client is trying to acquire a model that is unknown to the Tooling API.
A
UnknownPluginException
is thrown when an unknown plugin id is provided.An
UnknownProjectException
is thrown when a project referenced by path cannot be found.An
UnknownRepositoryException
is thrown when a repository referenced by name cannot be found.An
UnknownTaskException
is thrown when a task referenced by path cannot be found.Indicates that a property of a managed model element is explicitly of an unmanaged type.
An artifact that could not be resolved.
A component that could not be resolved.
Unsuccessfully resolved dependency.
A dependency that could not be resolved.
Thrown when the
LongRunningOperation
has been configured
with unsupported build arguments.Thrown when a build was executed with a target Gradle version that does not support a specific feature.
Thrown when the tooling API client attempts to use a method that does not exist
in the version of Gradle that the tooling API is connected to.
Thrown when a
LongRunningOperation
has been configured
with unsupported settings.Thrown when the target Gradle version does not support a particular feature.
Uploads the artifacts of a
Configuration
to a set of repositories.Represents the usage of a configuration.
Denotes that the
RuleSource
method rule carrying this annotation validates the rule subject.Validates task property annotations.
A variable library entry.
Declares that a property represents a variant dimension.
A component that has one or more mutually exclusive variants.
Represents a component spec that is made up of one or more mutually exclusive variants.
Represents the metadata of one variant of a component, see
ComponentMetadataDetails.withVariant(String, Action)
.Registration of an variant transform.
An exception to report a problem during transformation execution.
A dependency mapping provided by a VCS repository.
In settings.gradle:
A
VerificationTask
is a task which performs some verification of the artifacts produced by a build.Represents a constrained version.
Captures user-provided information about a version control system.
Allows the user to perform generic version control operations in ways
specified by the underlying implementations.
Represents how a version of a software component is referred to in a version
control system.
The Visual C++ tool chain.
Visual C++ specific settings for the tools used to build for a particular platform.
The configuration for mapping a set of
NativeComponentSpec
s to a Visual Studio project.A plugin for creating a Visual Studio solution for a gradle project.
A visual studio project, created from one or more
NativeBinary
instances.A visual studio solution, representing one or more
NativeBinarySpec
instances
from the same NativeComponentSpec
.Assembles a WAR archive.
A
Plugin
which extends the JavaPlugin
to add tasks which assemble a web application into a WAR
file.A
Convention
used for the WarPlugin.A wtp descriptor dependent module entry.
Represents an entry in
wb-module
.A wtp descriptor property entry.
A wtp descriptor resource entry.
Compiles Windows Resource scripts into .res files.
Adds core language support for Windows resource script files.
A set of Windows Resource definition files.
A plugin for projects wishing to build native binary components from Windows Resource sources.
Represents the configuration of a worker.
Indicates that a failure occurred during execution of work in a worker.
Allows work to be submitted for asynchronous execution.
Provides information about some work which was performed.
Helps access trivial
WorkResult
objects.Represents the customizable elements of an ipr (via XML hooks everything of the ipr is customizable).
Generates scripts (for *nix and windows) which allow you to build your project with Gradle, without having to
install Gradle.
Specifies the Gradle distribution type.
Specifies how the wrapper path should be interpreted.
The wrapper plugin.
Thrown when an attempt is made to read the value of a model element that is not readable at the time.
Writes a
Properties
in a way that the results can be expected to be reproducible.Creates the .settings/org.eclipse.wst.common.component file for WTP projects.
Creates the .settings/org.eclipse.wst.common.project.facet.core.xml file for WTP projects.
The configuration for mapping a C++ or Swift project to XCode IDE.
A plugin for creating a XCode project for a gradle project.
A xcode project, created from C++ or Swift capable project.
Executes XCTest tests.
A plugin that sets up the infrastructure for testing native binaries with XCTest test framework.
An XML config file generated for Visual Studio.
Models the generation/parsing/merging capabilities.
XmlGeneratorTask<T extends org.gradle.plugins.ide.internal.generator.generator.PersistableConfigurationObject>
A convenience superclass for those tasks which generate XML configuration files from a domain object of type T.
Provides various ways to access the content of an XML document.
Assembles a ZIP archive.
Specifies the compression level of an archives contents.