Table of Contents
API Documentation: | Project |
---|
This interface is the main API you use to interact with Gradle from your build file. From aProject
,you have programmatic access to all of Gradle's features.
There is a one-to-one relationship between aProject
and a
file. During build initialisation, Gradle assembles abuild.gradle
Project
object for each project which is toparticipate in the build, as follows:
- Create a
Settings
instance for the build. - Evaluate the
script, ifpresent, against thesettings.gradle
Settings
object to configure it. - Use the configured
Settings
object to create the hierarchy ofProject
instances. - Finally, evaluate each
Project
by executing its
file, ifpresent, against the project. The projects are evaluated in breadth-wise order, such that a project is evaluatedbefore its child projects. This order can be overridden by callingbuild.gradle
or by adding anexplicit evaluation dependency usingProject.evaluationDependsOnChildren()
.Project.evaluationDependsOn(java.lang.String)
A project is essentially a collection ofTask
objects. Each task performs some basic piece of work, suchas compiling classes, or running unit tests, or zipping up a WAR file. You add tasks to a project using one of thecreate()
methods onTaskContainer
, such asTaskContainer.create(java.lang.String)
. You can locate existingtasks using one of the lookup methods onTaskContainer
, such asTaskCollection.getByName(java.lang.String)
.
A project generally has a number of dependencies it needs in order to do its work. Also, a project generallyproduces a number of artifacts, which other projects can use. Those dependencies are grouped in configurations, andcan be retrieved and uploaded from repositories. You use theConfigurationContainer
returned byProject.getConfigurations()
method to manage the configurations. TheDependencyHandler
returned byProject.getDependencies()
method to manage thedependencies. TheArtifactHandler
returned byProject.getArtifacts()
method tomanage the artifacts. TheRepositoryHandler
returned byProject.getRepositories()
method to manage the repositories.
Projects are arranged into a hierarchy of projects. A project has a name, and a fully qualified path whichuniquely identifies it in the hierarchy.
Plugins can be used to modularise and reuse project configuration.Plugins can be applied using thePluginAware.apply(java.util.Map)
method, or by using thePluginDependenciesSpec
plugins script block.
Gradle executes the project's build file against theProject
instance to configure the project. Anyproperty or method which your script uses is delegated through to the associatedProject
object. Thismeans, that you can use any of the methods and properties on theProject
interface directly in your script.
For example:
defaultTasks('some-task')// Delegates to Project.defaultTasks()reportsDir = file('reports')// Delegates to Project.file() and the Java Plugin
You can also access theProject
instance using theproject
property. This can make thescript clearer in some cases. For example, you could useproject.name
rather thanname
toaccess the project's name.
A project has 5 property 'scopes', which it searches for properties. You can access these properties by name inyour build file, or by calling the project'sProject.property(java.lang.String)
method. The scopes are:
- The
Project
object itself. This scope includes any property getters and setters declared by theProject
implementation class. For example,Project.getRootProject()
is accessible as therootProject
property. The properties of this scope are readable or writable depending on the presenceof the corresponding getter or setter method. - Theextra properties of the project. Each project maintains a map of extra properties, whichcan contain any arbitrary name -> value pair. Once defined, the properties of this scope are readable and writable.Seeextra properties for more details.
- Theextensions added to the project by the plugins. Each extension is available as a read-only property with the same name as the extension.
- Theconvention properties added to the project by the plugins. A plugin can add properties and methodsto a project through the project's
Convention
object. The properties of this scope may be readable or writable, depending on the convention objects. - The tasks of the project. A task is accessible by using its name as a property name. The properties of thisscope are read-only. For example, a task called
compile
is accessible as thecompile
property. - The extra properties and convention properties are inherited from the project's parent, recursively up to the rootproject. The properties of this scope are read-only.
When reading a property, the project searches the above scopes in order, and returns the value from the firstscope it finds the property in. If not found, an exception is thrown. SeeProject.property(java.lang.String)
for more details.
When writing a property, the project searches the above scopes in order, and sets the property in the first scopeit finds the property in. If not found, an exception is thrown. SeeProject.setProperty(java.lang.String, java.lang.Object)
for more details.
All extra properties must be defined through the "ext" namespace. Once an extra property has been defined,it is available directly on the owning object (in the below case the Project, Task, and sub-projects respectively) and canbe read and updated. Only the initial declaration that needs to be done via the namespace.
project.ext.prop1 ="foo"task doStuff { ext.prop2 ="bar"}subprojects { ext.${prop3} = false }
Reading extra properties is done through the "ext" or through the owning object.
ext.isSnapshot = version.endsWith("-SNAPSHOT")if (isSnapshot) {// do snapshot stuff}
A project has 5 method 'scopes', which it searches for methods:
- The
Project
object itself. - The build file. The project searches for a matching method declared in the build file.
- Theextensions added to the project by the plugins. Each extension is available as a method which takesa closure or
Action
as a parameter. - Theconvention methods added to the project by the plugins. A plugin can add properties and method toa project through the project's
Convention
object. - The tasks of the project. A method is added for each task, using the name of the task as the method name andtaking a single closure or
Action
parameter. The method calls theTask.configure(groovy.lang.Closure)
method for theassociated task with the provided closure. For example, if the project has a task calledcompile
, then amethod is added with the following signature:void compile(Closure configureClosure)
. - The methods of the parent project, recursively up to the root project.
- A property of the project whose value is a closure. The closure is treated as a method and called with the provided parameters.The property is located as described above.
Property | Description |
allprojects | The set containing this project and its subprojects. |
ant | The |
artifacts | Returns a handler for assigning artifacts produced by the project to configurations. |
buildDir | The build directory of this project. The build directory is the directory which all artifacts aregenerated into. The default value for the build directory is |
buildFile | The build script for this project. |
buildscript | The build script handler for this project. You can use this handler to query details about the buildscript for this project, and manage the classpath used to compile and execute the project's build script. |
childProjects | The direct children of this project. |
configurations | The configurations of this project. |
convention | The |
defaultTasks | The names of the default tasks of this project. These are used when no tasks names are provided whenstarting the build. |
dependencies | The dependency handler of this project. The returned dependency handler instance can be used for addingnew dependencies. For accessing already declared dependencies, the configurations can be used. |
dependencyLocking | Provides access to configuring dependency locking |
description | The description of this project, if any. |
extensions | Allows adding DSL extensions to the project. Useful for plugin authors. |
gradle | The |
group | The group of this project. Gradle always uses the |
logger | The logger for this project. You can use this in your build file to write log messages. |
logging | The |
name | The name of this project. The project's name is not necessarily unique within a project hierarchy. Youshould use the |
normalization | Provides access to configuring input normalization. |
parent | The parent project of this project, if any. |
path | The path of this project. The path is the fully qualified name of the project. |
pluginManager | The plugin manager for this plugin aware object. |
plugins | The container of plugins that have been applied to this object. |
project | Returns this project. This method is useful in build files to explicitly access project properties andmethods. For example, using |
projectDir | The directory containing the project build file. |
properties | The properties of this project. Seehere for details of the properties whichare available for a project. |
repositories | Returns a handler to create repositories which are used for retrieving dependencies and uploading artifactsproduced by the project. |
resources | Provides access to resource-specific utility methods, for example factory methods that create various resources. |
rootDir | The root directory of this project. The root directory is the project directory of the rootproject. |
rootProject | The root project for the hierarchy that this project belongs to. In the case of a single-projectbuild, this method returns this project. |
state | The evaluation state of this project. You can use this to access information about the evaluation of thisproject, such as whether it has failed. |
status | The status of this project. Gradle always uses the |
subprojects | The set containing the subprojects of this project. |
tasks | The tasks of this project. |
version | The version of this project. Gradle always uses the |
Property | Description |
application | The |
applicationDefaultJvmArgs | Array of string arguments to pass to the JVM when running the application |
applicationDistribution | The specification of the contents of the distribution. |
applicationName | The name of the application. |
executableDir | Directory to place executables in |
mainClassName | The fully qualified name of the application's main class. |
Property | Description |
checkstyle | The |
Property | Description |
codenarc | The |
Property | Description |
distributions | The |
Property | Description |
appDirName | The name of the application directory, relative to the project directory.Default is "src/main/application". |
deploymentDescriptor | A custom deployment descriptor configuration.Default is an "application.xml" with sensible defaults. |
generateDeploymentDescriptor | Incubating Specifies if the deploymentDescriptor should be generated if it does not exist.Default is true. |
libDirName | The name of the library directory in the EAR file.Default is "lib". |
Property | Description |
eclipse | The |
Property | Description |
jacoco | The |
Property | Description |
archivesBaseName | The base name to use for archive files. |
distsDir | Deprecated The directory to generate TAR and ZIP archives into. |
distsDirName | The name for the distributions directory. This in interpreted relative to the project' build directory. |
distsDirectory | The directory to generate TAR and ZIP archives into. |
docsDir | Returns a file pointing to the root directory supposed to be used for all docs. |
docsDirName | The name of the docs directory. Can be a name or a path relative to the build dir. |
libsDir | Deprecated The directory to generate JAR and WAR archives into. |
libsDirName | The name for the libs directory. This in interpreted relative to the project' build directory. |
libsDirectory | The directory to generate JAR and WAR archives into. |
reporting | The |
sourceCompatibility | The source compatibility used for compiling Java sources. |
sourceCompatibility | The source compatibility used for compiling Java sources. |
sourceSets | The source sets container. |
targetCompatibility | The target compatibility used for compiling Java sources. |
targetCompatibility | The target compatibility used for compiling Java sources. |
testReportDir | Returns a file pointing to the root directory to be used for reports. |
testReportDirName | The name of the test reports directory. Can be a name or a path relative to |
testResultsDir | Returns a file pointing to the root directory of the test results. |
testResultsDirName | The name of the test results directory. Can be a name or a path relative to the build dir. |
toolchain | Incubating Gets the project wide toolchain requirements that will be used for tasks requiring a tool from the toolchain (e.g. |
Property | Description |
conf2ScopeMappings | The set of rules for how to map Gradle dependencies to Maven scopes. |
mavenPomDir | The directory to generate Maven POMs into. |
Property | Description |
pmd | The |
Property | Description |
projectReportDir | The directory to generate the project reports into. |
projectReportDirName | The name of the directory to generate the project reports into, relative to the project's reports dir. |
Property | Description |
publishing | The |
Property | Description |
signing | The |
Property | Description |
visualStudio | The |
Property | Description |
webAppDir | The web application directory. |
webAppDirName | The name of the web application directory, relative to the project directory. |
Property | Description |
xcode | The |
Method | Description |
absoluteProjectPath(path) | Converts a name to an absolute project path, resolving names relative to this project. |
afterEvaluate(closure) | Adds a closure to be called immediately after this project has been evaluated. The project is passed to theclosure as a parameter. Such a listener gets notified when the build file belonging to this project has beenexecuted. A parent project may for example add such a listener to its child project. Such a listener can furtherconfigure those child projects based on the state of the child projects after their build files have beenrun. |
afterEvaluate(action) | Adds an action to execute immediately after this project is evaluated. |
allprojects(action) | Configures this project and each of its sub-projects. |
ant(configureAction) | Executes the given action against the |
apply(closure) | Applies zero or more plugins or scripts. |
apply(options) | Applies a plugin or script, using the given options provided as a map. Does nothing if the plugin has already been applied. |
apply(action) | Applies zero or more plugins or scripts. |
artifacts(configureAction) | Configures the published artifacts for this project. |
beforeEvaluate(closure) | Adds a closure to be called immediately before this project is evaluated. The project is passed to the closureas a parameter. |
beforeEvaluate(action) | Adds an action to execute immediately before this project is evaluated. |
configure(objects, configureClosure) | Configures a collection of objects via a closure. This is equivalent to calling |
configure(objects, configureAction) | Configures a collection of objects via an action. |
configure(object, configureClosure) | Configures an object via a closure, with the closure's delegate set to the supplied object. This way you don'thave to specify the context of a configuration statement multiple times. |
container(type) | Creates a container for managing named objects of the specified type. The specified type must have a public constructor which takes the name as a String parameter. |
container(type, factoryClosure) | Creates a container for managing named objects of the specified type. The given closure is used to create object instances. The name of the instance to be created is passed as a parameter tothe closure. |
container(type, factory) | Creates a container for managing named objects of the specified type. The given factory is used to create object instances. |
copy(closure) | Copies the specified files. The given closure is used to configure a |
copy(action) | Copies the specified files. The given action is used to configure a |
copySpec() | Creates a |
copySpec(closure) | Creates a |
copySpec(action) | Creates a |
defaultTasks(defaultTasks) | Sets the names of the default tasks of this project. These are used when no tasks names are provided whenstarting the build. |
delete(paths) | Deletes files and directories. |
delete(action) | Deletes the specified files. The given action is used to configure a |
dependencyLocking(configuration) | Configures dependency locking |
evaluationDependsOn(path) | Declares that this project has an evaluation dependency on the project with the given path. |
exec(closure) | Executes an external command. The closure configures a |
exec(action) | Executes an external command. |
file(path) | Resolves a file path relative to the project directory of this project. This method converts the supplied pathbased on its type: |
file(path, validation) | Resolves a file path relative to the project directory of this project and validates it using the givenscheme. See |
fileTree(baseDir) | Creates a new |
fileTree(baseDir, configureClosure) | Creates a new |
fileTree(baseDir, configureAction) | Creates a new |
fileTree(args) | Creates a new |
files(paths, configureClosure) | Creates a new |
files(paths, configureAction) | Creates a new |
files(paths) | Returns a |
findProject(path) | Locates a project by path. If the path is relative, it is interpreted relative to this project. |
findProperty(propertyName) | Returns the value of the given property or null if not found.This method locates a property as follows: |
getAllTasks(recursive) | Returns a map of the tasks contained in this project, and optionally its subprojects. |
getTasksByName(name, recursive) | Returns the set of tasks with the given name contained in this project, and optionally its subprojects.NOTE: This is an expensive operation since it requires all projects to be configured. |
hasProperty(propertyName) | Determines if this project has the given property. Seehere for details of theproperties which are available for a project. |
javaexec(closure) | Executes a Java main class. The closure configures a |
javaexec(action) | Executes an external Java process. |
mkdir(path) | Creates a directory and returns a file pointing to it. |
normalization(configuration) | Configures input normalization. |
project(path) | Locates a project by path. If the path is relative, it is interpreted relative to this project. |
project(path, configureClosure) | Locates a project by path and configures it using the given closure. If the path is relative, it isinterpreted relative to this project. The target project is passed to the closure as the closure's delegate. |
project(path, configureAction) | Locates a project by path and configures it using the given action. If the path is relative, it isinterpreted relative to this project. |
property(propertyName) | Returns the value of the given property. This method locates a property as follows: |
relativePath(path) | Returns the relative path from the project directory to the given path. The given path object is (logically)resolved as described for |
relativeProjectPath(path) | Converts a name to a project path relative to this project. |
setProperty(name, value) | Sets a property of this project. This method searches for a property with the given name in the followinglocations, and sets the property on the first location where it finds the property. |
subprojects(action) | Configures the sub-projects of this project |
sync(action) | Synchronizes the contents of a destination directory with some source directories and files.The given action is used to configure a |
tarTree(tarPath) | Creates a new |
task(name) | Creates a |
task(name, configureClosure) | Creates a |
task(name, configureAction) | Creates a |
task(args, name) | Creates a |
task(args, name, configureClosure) | Creates a |
uri(path) | Resolves a file path to a URI, relative to the project directory of this project. Evaluates the provided pathobject as described for |
zipTree(zipPath) | Creates a new |
Method | Description |
appDirName(appDirName) | Allows changing the application directory.Default is "src/main/application". |
deploymentDescriptor(configureAction) | Configures the deployment descriptor for this EAR archive. |
libDirName(libDirName) | Allows changing the library directory in the EAR file. Default is "lib". |
Method | Description |
disableAutoTargetJvm() | If this method is called, Gradle will not automatically try to fetchdependencies which have a JVM version compatible with the target compatibilityof this module. |
manifest() | Creates a new instance of a |
manifest(closure) | Creates and configures a new instance of a |
manifest(action) | Creates and configures a new instance of a |
registerFeature(name, configureAction) | Registers a feature. |
toolchain(action) | Incubating Configures the project wide toolchain requirements for tasks that require a tool from the toolchain (e.g. |
withJavadocJar() | Incubating Adds a task |
withSourcesJar() | Incubating Adds a task |
Block | Description |
allprojects | Configures this project and each of its sub-projects. |
ant | Executes the given closure against the |
artifacts | Configures the published artifacts for this project. |
buildscript | Configures the build script classpath for this project. |
configurations | Configures the dependency configurations for this project. |
dependencies | Configures the dependencies for this project. |
repositories | Configures the repositories for this project. |
subprojects | Configures the sub-projects of this project. |
Block | Description |
application | Configures the |
Block | Description |
checkstyle | Configures the |
Block | Description |
codenarc | Configures the |
Block | Description |
distributions | Configures the |
Block | Description |
deploymentDescriptor | Configures the deployment descriptor for this EAR archive. |
Block | Description |
eclipse | Configures the |
Block | Description |
jacoco | Configures the |
Block | Description |
reporting | Configures the |
sourceSets | Configures the source sets of this project. |
Block | Description |
pmd | Configures the |
Block | Description |
publishing | Configures the |
Block | Description |
signing | Configures the |
Block | Description |
visualStudio | Configures the |
Block | Description |
xcode | Configures the |
AntBuilder
ant
(read-only)
TheAntBuilder
for this project. You can use this in your build file to execute anttasks. See example below.
task printChecksum { doLast { ant {//using ant checksum task to store the file checksum in the checksumOut ant property checksum(property:'checksumOut', file:'someFile.txt')//we can refer to the ant property created by checksum task: println"The checksum is: " + checksumOut }//we can refer to the ant property later as well: println"I just love to print checksums: " + ant.checksumOut }}
Consider following example of ant target:
<target name='printChecksum'> <checksum property='checksumOut'> <fileset dir='.'> <include name='agile.txt'/> </fileset> </checksum> <echo>The checksum is: ${checksumOut}</echo></target>
Here's how it would look like in gradle. Observe how the ant XML is represented in groovy by the ant builder
task printChecksum { doLast { ant { checksum(property:'checksumOut') { fileset(dir:'.') { include name:'agile1.txt' } } } logger.lifecycle("The checksum is $ant.checksumOut") }}
ArtifactHandler
artifacts
(read-only)
Returns a handler for assigning artifacts produced by the project to configurations.
See docs forArtifactHandler
File
buildDir
The build directory of this project. The build directory is the directory which all artifacts aregenerated into. The default value for the build directory isprojectDir/build
File
buildFile
(read-only)
The build script for this project.
If the file exists, it will be evaluated against this project when this project is configured.
ScriptHandler
buildscript
(read-only)
The build script handler for this project. You can use this handler to query details about the buildscript for this project, and manage the classpath used to compile and execute the project's build script.
ConfigurationContainer
configurations
(read-only)
The configurations of this project.
See docs forConfigurationContainer
Convention
convention
(read-only)
TheConvention
for this project.
You can access this property in your build fileusingconvention
. You can also access the properties and methods of the convention objectas if they were properties and methods of this project. Seehere for more details
The names of the default tasks of this project. These are used when no tasks names are provided whenstarting the build.
DependencyHandler
dependencies
(read-only)
The dependency handler of this project. The returned dependency handler instance can be used for addingnew dependencies. For accessing already declared dependencies, the configurations can be used.
See docs forDependencyHandler
DependencyLockingHandler
dependencyLocking
(read-only)
Provides access to configuring dependency locking
String
description
The description of this project, if any.
ExtensionContainer
extensions
(read-only)
Allows adding DSL extensions to the project. Useful for plugin authors.
Object
group
The group of this project. Gradle always uses thetoString()
value of the group. The groupdefaults to the path with dots as separators.
Logger
logger
(read-only)
The logger for this project. You can use this in your build file to write log messages.
LoggingManager
logging
(read-only)
TheLoggingManager
which can be used to receive logging and to control thestandard output/error capture for this project's build script. By default, System.out is redirected to the Gradlelogging system at the QUIET log level, and System.err is redirected at the ERROR log level.
String
name
(read-only)
The name of this project. The project's name is not necessarily unique within a project hierarchy. Youshould use theProject.getPath()
method for a unique identifier for the project.
InputNormalizationHandler
normalization
(read-only)
Provides access to configuring input normalization.
Project
parent
(read-only)
The parent project of this project, if any.
String
path
(read-only)
The path of this project. The path is the fully qualified name of the project.
PluginManager
pluginManager
(read-only)
The plugin manager for this plugin aware object.
PluginContainer
plugins
(read-only)
The container of plugins that have been applied to this object.
While not deprecated, it is preferred to use the methods of this interface or thePluginAware.getPluginManager()
than use the plugin container.
Use one of the 'apply' methods on this interface or on thePluginAware.getPluginManager()
to apply plugins instead of applying via the plugin container.
UsePluginManager.hasPlugin(java.lang.String)
or similar to query for the application of plugins instead of doing so via the plugin container.
Project
project
(read-only)
Returns this project. This method is useful in build files to explicitly access project properties andmethods. For example, usingproject.name
can express your intent better than usingname
. This method also allows you to access project properties from a scope where the property maybe hidden, such as, for example, from a method or closure.
File
projectDir
(read-only)
The directory containing the project build file.
The properties of this project. Seehere for details of the properties whichare available for a project.
RepositoryHandler
repositories
(read-only)
Returns a handler to create repositories which are used for retrieving dependencies and uploading artifactsproduced by the project.
ResourceHandler
resources
(read-only)
Provides access to resource-specific utility methods, for example factory methods that create various resources.
File
rootDir
(read-only)
The root directory of this project. The root directory is the project directory of the rootproject.
Project
rootProject
(read-only)
The root project for the hierarchy that this project belongs to. In the case of a single-projectbuild, this method returns this project.
ProjectState
state
(read-only)
The evaluation state of this project. You can use this to access information about the evaluation of thisproject, such as whether it has failed.
Object
status
The status of this project. Gradle always uses thetoString()
value of the status. The statusdefaults torelease
.
The status of the project is only relevant, if you upload libraries together with a module descriptor. Thestatus specified here, will be part of this module descriptor.
TaskContainer
tasks
(read-only)
The tasks of this project.
Object
version
The version of this project. Gradle always uses thetoString()
value of the version. Theversion defaults tounspecified
.
JavaApplication
application
(read-only)
TheJavaApplication
added by the application plugin.
Array of string arguments to pass to the JVM when running the application
CopySpec
applicationDistribution
The specification of the contents of the distribution.
Use thisCopySpec
to include extra files/resource in the application distribution.
plugins { id'application'}applicationDistribution.from("some/dir") { include"*.txt"}
Note that the application plugin pre configures this spec to; include the contents of "src/dist
",copy the application start scripts into the "bin
" directory, and copy the built jar and its dependenciesinto the "lib
" directory.
String
applicationName
The name of the application.
String
executableDir
Directory to place executables in
String
mainClassName
The fully qualified name of the application's main class.
CheckstyleExtension
checkstyle
(read-only)
TheCheckstyleExtension
added by the checkstyle plugin.
CodeNarcExtension
codenarc
(read-only)
TheCodeNarcExtension
added by the codenarc plugin.
DistributionContainer
distributions
(read-only)
TheDistributionContainer
added by the distribution plugin.
String
appDirName
The name of the application directory, relative to the project directory.Default is "src/main/application".
DeploymentDescriptor
deploymentDescriptor
A custom deployment descriptor configuration.Default is an "application.xml" with sensible defaults.
Note: This property isincubating and may change in a future version of Gradle.
Specifies if the deploymentDescriptor should be generated if it does not exist.Default is true.
String
libDirName
The name of the library directory in the EAR file.Default is "lib".
EclipseModel
eclipse
(read-only)
TheEclipseModel
added by the eclipse plugin.
JacocoPluginExtension
jacoco
(read-only)
TheJacocoPluginExtension
added by the jacoco plugin.
String
archivesBaseName
The base name to use for archive files.
File
distsDir
(read-only)
Note: This property isdeprecated and will be removed in the next major version of Gradle.
The directory to generate TAR and ZIP archives into.
This property has been replaced by distsDirectory.
String
distsDirName
The name for the distributions directory. This in interpreted relative to the project' build directory.
DirectoryProperty
distsDirectory
The directory to generate TAR and ZIP archives into.
File
docsDir
(read-only)
Returns a file pointing to the root directory supposed to be used for all docs.
String
docsDirName
The name of the docs directory. Can be a name or a path relative to the build dir.
File
libsDir
(read-only)
Note: This property isdeprecated and will be removed in the next major version of Gradle.
The directory to generate JAR and WAR archives into.
This property has been replaced by libsDirectory.
String
libsDirName
The name for the libs directory. This in interpreted relative to the project' build directory.
DirectoryProperty
libsDirectory
The directory to generate JAR and WAR archives into.
ReportingExtension
reporting
(read-only)
TheReportingExtension
added by the java plugin.
JavaVersion
sourceCompatibility
The source compatibility used for compiling Java sources.
JavaVersion
sourceCompatibility
The source compatibility used for compiling Java sources.
SourceSetContainer
sourceSets
(read-only)
The source sets container.
JavaVersion
targetCompatibility
The target compatibility used for compiling Java sources.
JavaVersion
targetCompatibility
The target compatibility used for compiling Java sources.
File
testReportDir
(read-only)
Returns a file pointing to the root directory to be used for reports.
String
testReportDirName
The name of the test reports directory. Can be a name or a path relative toReportingExtension.getBaseDir()
.
File
testResultsDir
(read-only)
Returns a file pointing to the root directory of the test results.
String
testResultsDirName
The name of the test results directory. Can be a name or a path relative to the build dir.
JavaToolchainSpec
toolchain
(read-only)
Note: This property isincubating and may change in a future version of Gradle.
Gets the project wide toolchain requirements that will be used for tasks requiring a tool from the toolchain (e.g.JavaCompile
).
Configuring a toolchain cannot be used together withsourceCompatibility
ortargetCompatibility
on this extension.Both values will be sourced from the toolchain.
Conf2ScopeMappingContainer
conf2ScopeMappings
The set of rules for how to map Gradle dependencies to Maven scopes.
File
mavenPomDir
The directory to generate Maven POMs into.
PmdExtension
pmd
(read-only)
ThePmdExtension
added by the pmd plugin.
File
projectReportDir
(read-only)
The directory to generate the project reports into.
String
projectReportDirName
The name of the directory to generate the project reports into, relative to the project's reports dir.
PublishingExtension
publishing
(read-only)
ThePublishingExtension
added by the publishing plugin.
SigningExtension
signing
(read-only)
TheSigningExtension
added by the signing plugin.
VisualStudioRootExtension
visualStudio
(read-only)
TheVisualStudioRootExtension
added by the visual-studio plugin.
File
webAppDir
(read-only)
The web application directory.
String
webAppDirName
The name of the web application directory, relative to the project directory.
XcodeRootExtension
xcode
(read-only)
TheXcodeRootExtension
added by the xcode plugin.
Converts a name to an absolute project path, resolving names relative to this project.
void
afterEvaluate
(Closure
closure)
Adds a closure to be called immediately after this project has been evaluated. The project is passed to theclosure as a parameter. Such a listener gets notified when the build file belonging to this project has beenexecuted. A parent project may for example add such a listener to its child project. Such a listener can furtherconfigure those child projects based on the state of the child projects after their build files have beenrun.
Adds an action to execute immediately after this project is evaluated.
Configures this project and each of its sub-projects.
This method executes the givenAction
against this project and each of its sub-projects.
AntBuilder
ant
(Action
<? superAntBuilder
>
configureAction)
Action
<? superAntBuilder
>Executes the given action against theAntBuilder
for this project. You can use this in yourbuild file to execute ant tasks. See example in javadoc forProject.getAnt()
void
apply
(Closure
closure)
Applies zero or more plugins or scripts.
The given closure is used to configure anObjectConfigurationAction
, which “builds” the plugin application.
This method differs fromPluginAware.apply(java.util.Map)
in that it allows methods of the configuration action to be invoked more than once.
Applies a plugin or script, using the given options provided as a map. Does nothing if the plugin has already been applied.
The given map is applied as a series of method calls to a newly createdObjectConfigurationAction
.That is, each key in the map is expected to be the name of a methodObjectConfigurationAction
and the value to be compatible arguments to that method.
The following options are available:
from
: A script to apply. Accepts any path supported byProject.uri(java.lang.Object)
.plugin
: The id or implementation class of the plugin to apply.to
: The target delegate object or objects. The default is this plugin aware object. Use this to configure objects other than this object.
void
apply
(Action
<? superObjectConfigurationAction
>
action)
Action
<? superObjectConfigurationAction
>Applies zero or more plugins or scripts.
The given closure is used to configure anObjectConfigurationAction
, which “builds” the plugin application.
This method differs fromPluginAware.apply(java.util.Map)
in that it allows methods of the configuration action to be invoked more than once.
void
artifacts
(Action
<? superArtifactHandler
>
configureAction)
Action
<? superArtifactHandler
>Configures the published artifacts for this project.
This method executes the given action against theArtifactHandler
for this project.
Example:
configurations {//declaring new configuration that will be used to associate with artifacts schema}task schemaJar(type: Jar) {//some imaginary task that creates a jar artifact with the schema}//associating the task that produces the artifact with the configurationartifacts {//configuration name and the task: schema schemaJar}
void
beforeEvaluate
(Closure
closure)
Adds a closure to be called immediately before this project is evaluated. The project is passed to the closureas a parameter.
Adds an action to execute immediately before this project is evaluated.
Configures a collection of objects via a closure. This is equivalent to callingProject.configure(java.lang.Object, groovy.lang.Closure)
for each of the given objects.
Configures a collection of objects via an action.
Configures an object via a closure, with the closure's delegate set to the supplied object. This way you don'thave to specify the context of a configuration statement multiple times.
Instead of:
MyType myType =new MyType()myType.doThis()myType.doThat()
you can do:
MyType myType = configure(new MyType()) { doThis() doThat()}
The object being configured is also passed to the closure as a parameter, so you can access it explicitly ifrequired:
configure(someObj) { obj -> obj.doThis() }
NamedDomainObjectContainer
<T
>
container
(Class
<T
>
type)
NamedDomainObjectContainer
<T
>Class
<T
>Creates a container for managing named objects of the specified type. The specified type must have a public constructor which takes the name as a String parameter.
All objectsMUST expose their name as a bean property named "name". The name must be constant for the life of the object.
NamedDomainObjectContainer
<T
>
container
(Class
<T
>
type,Closure
factoryClosure)
NamedDomainObjectContainer
<T
>Class
<T
>Creates a container for managing named objects of the specified type. The given closure is used to create object instances. The name of the instance to be created is passed as a parameter tothe closure.
All objectsMUST expose their name as a bean property named "name". The name must be constant for the life of the object.
NamedDomainObjectContainer
<T
>
container
(Class
<T
>
type,NamedDomainObjectFactory
<T
>
factory)
NamedDomainObjectContainer
<T
>Class
<T
>NamedDomainObjectFactory
<T
>Creates a container for managing named objects of the specified type. The given factory is used to create object instances.
All objectsMUST expose their name as a bean property named "name". The name must be constant for the life of the object.
WorkResult
copy
(Closure
closure)
Copies the specified files. The given closure is used to configure aCopySpec
, which is then used tocopy the files. Example:
copy { from configurations.runtimeClasspath into'build/deploy/lib'}
Note that CopySpecs can be nested:
copy { into'build/webroot' exclude'**/.svn/**' from('src/main/webapp') { include'**/*.jsp' filter(ReplaceTokens, tokens:[copyright:'2009', version:'2.3.1']) } from('src/main/js') { include'**/*.js' }}
WorkResult
copy
(Action
<? superCopySpec
>
action)
Action
<? superCopySpec
>Copies the specified files. The given action is used to configure aCopySpec
, which is then used tocopy the files.
Creates aCopySpec
which can later be used to copy files or create an archive. The given closure is usedto configure theCopySpec
before it is returned by this method.
def baseSpec = copySpec { from"source" include"**/*.java"}task copy(type: Copy) { into"target" with baseSpec}
Creates aCopySpec
which can later be used to copy files or create an archive. The given action is usedto configure theCopySpec
before it is returned by this method.
void
defaultTasks
(String
...
defaultTasks)
String
...Sets the names of the default tasks of this project. These are used when no tasks names are provided whenstarting the build.
boolean
delete
(Object
...
paths)
Object
...Deletes files and directories.
This will not follow symlinks. If you need to follow symlinks too useProject.delete(org.gradle.api.Action)
.
WorkResult
delete
(Action
<? superDeleteSpec
>
action)
Action
<? superDeleteSpec
>Deletes the specified files. The given action is used to configure aDeleteSpec
, which is then used todelete the files.
Example:
project.delete { delete'somefile' followSymlinks = true}
void
dependencyLocking
(Action
<? superDependencyLockingHandler
>
configuration)
Action
<? superDependencyLockingHandler
>Configures dependency locking
Declares that this project has an evaluation dependency on the project with the given path.
ExecResult
exec
(Closure
closure)
Executes an external command. The closure configures aExecSpec
.
ExecResult
exec
(Action
<? superExecSpec
>
action)
Action
<? superExecSpec
>Executes an external command.
The given action configures aExecSpec
, which is used to launch the process.This method blocks until the process terminates, with its result being returned.
Resolves a file path relative to the project directory of this project. This method converts the supplied pathbased on its type:
- A
CharSequence
, includingString
orGString
. Interpreted relative to the project directory. A string that starts withfile:
is treated as a file URL. - A
File
. If the file is an absolute file, it is returned as is. Otherwise, the file's path isinterpreted relative to the project directory. - A
Path
. The path must be associated with the default provider and is treated thesame way as an instance ofFile
. - A
URI
orURL
. The URL's path is interpreted as the file path. Onlyfile:
URLs are supported. - A
Directory
orRegularFile
. - A
Provider
of any supported type. The provider's value is resolved recursively. - A
TextResource
. - A Groovy
Closure
or Kotlin function that returns any supported type. The closure's return value is resolved recursively. - A
Callable
that returns any supported type. The callable's return value is resolved recursively.
File
file
(Object
path,PathValidation
validation)
Resolves a file path relative to the project directory of this project and validates it using the givenscheme. SeePathValidation
for the list of possible validations.
ConfigurableFileTree
fileTree
(Object
baseDir)
Creates a newConfigurableFileTree
using the given base directory. The given baseDir path is evaluatedas perProject.file(java.lang.Object)
.
The returned file tree is lazy, so that it scans for files only when the contents of the file tree arequeried. The file tree is also live, so that it scans for files each time the contents of the file tree arequeried.
def myTree = fileTree("src")myTree.include"**/*.java"myTree.builtBy"someTask"task copy(type: Copy) { from myTree}
The order of the files in aFileTree
is not stable, even on a single computer.
ConfigurableFileTree
fileTree
(Object
baseDir,Closure
configureClosure)
Creates a newConfigurableFileTree
using the given base directory. The given baseDir path is evaluatedas perProject.file(java.lang.Object)
. The closure will be used to configure the new file tree.The file tree is passed to the closure as its delegate. Example:
def myTree = fileTree('src') { exclude'**/.data/**' builtBy'someTask'}task copy(type: Copy) { from myTree}
The returned file tree is lazy, so that it scans for files only when the contents of the file tree arequeried. The file tree is also live, so that it scans for files each time the contents of the file tree arequeried.
The order of the files in aFileTree
is not stable, even on a single computer.
ConfigurableFileTree
fileTree
(Object
baseDir,Action
<? superConfigurableFileTree
>
configureAction)
Action
<? superConfigurableFileTree
>Creates a newConfigurableFileTree
using the given base directory. The given baseDir path is evaluatedas perProject.file(java.lang.Object)
. The action will be used to configure the new file tree. Example:
def myTree = fileTree('src') { exclude'**/.data/**' builtBy'someTask'}task copy(type: Copy) { from myTree}
The returned file tree is lazy, so that it scans for files only when the contents of the file tree arequeried. The file tree is also live, so that it scans for files each time the contents of the file tree arequeried.
The order of the files in aFileTree
is not stable, even on a single computer.
ConfigurableFileTree
fileTree
(Map
<String
, ?>
args)
Map
<String
, ?>Creates a newConfigurableFileTree
using the provided map of arguments. The map will be applied asproperties on the new file tree. Example:
def myTree = fileTree(dir:'src', excludes:['**/ignore/**','**/.data/**'])task copy(type: Copy) { from myTree}
The returned file tree is lazy, so that it scans for files only when the contents of the file tree arequeried. The file tree is also live, so that it scans for files each time the contents of the file tree arequeried.
The order of the files in aFileTree
is not stable, even on a single computer.
ConfigurableFileCollection
files
(Object
paths,Closure
configureClosure)
Creates a newConfigurableFileCollection
using the given paths. The paths are evaluated as perProject.files(java.lang.Object[])
. The file collection is configured using the given closure. The file collection is passed tothe closure as its delegate. Example:
files"$buildDir/classes" { builtBy'compile'}
The returned file collection is lazy, so that the paths are evaluated only when the contents of the filecollection are queried. The file collection is also live, so that it evaluates the above each time the contentsof the collection is queried.
ConfigurableFileCollection
files
(Object
paths,Action
<? superConfigurableFileCollection
>
configureAction)
Action
<? superConfigurableFileCollection
>Creates a newConfigurableFileCollection
using the given paths. The paths are evaluated as perProject.files(java.lang.Object[])
. The file collection is configured using the given action. Example:
files"$buildDir/classes" { builtBy'compile'}
The returned file collection is lazy, so that the paths are evaluated only when the contents of the filecollection are queried. The file collection is also live, so that it evaluates the above each time the contentsof the collection is queried.
ConfigurableFileCollection
files
(Object
...
paths)
Object
...Returns aConfigurableFileCollection
containing the given files. You can pass any of the followingtypes to this method:
- A
CharSequence
, includingString
orGString
. Interpreted relative to the project directory, as perProject.file(java.lang.Object)
. A string that starts withfile:
is treated as a file URL. - A
File
. Interpreted relative to the project directory, as perProject.file(java.lang.Object)
. - A
Path
, as perProject.file(java.lang.Object)
. - A
URI
orURL
. The URL's path is interpreted as a file path. Onlyfile:
URLs are supported. - A
Directory
orRegularFile
. - A
Collection
,Iterable
, or an array that contains objects of any supported type. The elements of the collection are recursively converted to files. - A
FileCollection
. The contents of the collection are included in the returned collection. - A
FileTree
orDirectoryTree
. The contents of the tree are included in the returned collection. - A
Provider
of any supported type. The provider's value is recursively converted to files. If the provider represents an output of a task, that task is executed if the file collection is used as an input to another task. - A
Callable
that returns any supported type. The return value of thecall()
method is recursively converted to files. Anull
return value is treated as an empty collection. - A Groovy
Closure
or Kotlin function that returns any of the types listed here. The return value of the closure is recursively converted to files. Anull
return value is treated as an empty collection. - A
Task
. Converted to the task's output files. The task is executed if the file collection is used as an input to another task. - A
TaskOutputs
. Converted to the output files the related task. The task is executed if the file collection is used as an input to another task. - Anything else is treated as an error.
The returned file collection is lazy, so that the paths are evaluated only when the contents of the filecollection are queried. The file collection is also live, so that it evaluates the above each time the contentsof the collection is queried.
The returned file collection maintains the iteration order of the supplied paths.
The returned file collection maintains the details of the tasks that produce the files, so that these tasks are executed if this file collection is used as an input to some task.
This method can also be used to create an empty collection, which can later be mutated to add elements.
Locates a project by path. If the path is relative, it is interpreted relative to this project.
Returns the value of the given property or null if not found.This method locates a property as follows:
- If this project object has a property with the given name, return the value of the property.
- If this project has an extension with the given name, return the extension.
- If this project's convention object has a property with the given name, return the value of theproperty.
- If this project has an extra property with the given name, return the value of the property.
- If this project has a task with the given name, return the task.
- Search up through this project's ancestor projects for a convention property or extra property with thegiven name.
- If not found, null value is returned.
Returns a map of the tasks contained in this project, and optionally its subprojects.
Returns the set of tasks with the given name contained in this project, and optionally its subprojects.NOTE: This is an expensive operation since it requires all projects to be configured.
boolean
hasProperty
(String
propertyName)
Determines if this project has the given property. Seehere for details of theproperties which are available for a project.
ExecResult
javaexec
(Closure
closure)
Executes a Java main class. The closure configures aJavaExecSpec
.
ExecResult
javaexec
(Action
<? superJavaExecSpec
>
action)
Action
<? superJavaExecSpec
>Executes an external Java process.
The given action configures aJavaExecSpec
, which is used to launch the process.This method blocks until the process terminates, with its result being returned.
void
normalization
(Action
<? superInputNormalizationHandler
>
configuration)
Action
<? superInputNormalizationHandler
>Configures input normalization.
Locates a project by path. If the path is relative, it is interpreted relative to this project.
Locates a project by path and configures it using the given closure. If the path is relative, it isinterpreted relative to this project. The target project is passed to the closure as the closure's delegate.
Locates a project by path and configures it using the given action. If the path is relative, it isinterpreted relative to this project.
Returns the value of the given property. This method locates a property as follows:
- If this project object has a property with the given name, return the value of the property.
- If this project has an extension with the given name, return the extension.
- If this project's convention object has a property with the given name, return the value of theproperty.
- If this project has an extra property with the given name, return the value of the property.
- If this project has a task with the given name, return the task.
- Search up through this project's ancestor projects for a convention property or extra property with thegiven name.
- If not found, a
MissingPropertyException
is thrown.
Returns the relative path from the project directory to the given path. The given path object is (logically)resolved as described forProject.file(java.lang.Object)
, from which a relative path is calculated.
Sets a property of this project. This method searches for a property with the given name in the followinglocations, and sets the property on the first location where it finds the property.
- The project object itself. For example, the
rootDir
project property. - The project's
Convention
object. For example, thesrcRootName
java pluginproperty. - The project's extra properties.
If the property is not found, aMissingPropertyException
is thrown.
Configures the sub-projects of this project
This method executes the givenAction
against the sub-projects of this project.
WorkResult
sync
(Action
<? superCopySpec
>
action)
Action
<? superCopySpec
>Synchronizes the contents of a destination directory with some source directories and files.The given action is used to configure aCopySpec
, which is then used to synchronize the files.
This method is like theProject.copy(org.gradle.api.Action)
task, except the destination directory will only contain the files copied.All files that exist in the destination directory will be deleted before copying files, unless a preserve option is specified.
Example:
project.sync { from'my/shared/dependencyDir' into'build/deps/compile'}
Note that you can preserve output that already exists in the destination directory:
project.sync { from'source' into'dest' preserve { include'extraDir/**' include'dir1/**' exclude'dir1/extra.txt' }}
Creates a newFileTree
which contains the contents of the given TAR file. The given tarPath path can be:
- an instance of
Resource
- any other object is evaluated as per
Project.file(java.lang.Object)
The returned file tree is lazy, so that it scans for files only when the contents of the file tree arequeried. The file tree is also live, so that it scans for files each time the contents of the file tree arequeried.
Unless custom implementation of resources is passed, the tar tree attempts to guess the compression based on the file extension.
You can combine this method with theProject.copy(groovy.lang.Closure)
method to untar a TAR file:
task untar(type: Copy) { from tarTree('someCompressedTar.gzip')//tar tree attempts to guess the compression based on the file extension//however if you must specify the compression explicitly you can: from tarTree(resources.gzip('someTar.ext'))//in case you work with unconventionally compressed tars//you can provide your own implementation of a ReadableResource://from tarTree(yourOwnResource as ReadableResource) into'dest'}
Creates aTask
with the given name and adds it to this project. Calling this method is equivalent tocallingProject.task(java.util.Map, java.lang.String)
with an empty options map.
After the task is added to the project, it is made available as a property of the project, so that you canreference the task by name in your build file. Seehere for more details
If a task with the given name already exists in this project, an exception is thrown.
Creates aTask
with the given name and adds it to this project. Before the task is returned, the givenclosure is executed to configure the task.
After the task is added to the project, it is madeavailable as a property of the project, so that you can reference the task by name in your build file. Seehere for more details
Creates aTask
with the given name and adds it to this project. Before the task is returned, the givenaction is executed to configure the task.
After the task is added to the project, it is madeavailable as a property of the project, so that you can reference the task by name in your build file. Seehere for more details
Creates aTask
with the given name and adds it to this project. A map of creation options can bepassed to this method to control how the task is created. The following options are available:
Option | Description | Default Value |
| The class of the task tocreate. | DefaultTask |
| Replace an existingtask? | false |
| A task name or set of task names whichthis task depends on | [] |
| A closure orAction to add to thetask. | null |
| A description of the task. | null |
| A task group which this task belongs to. | null |
After the task is added to the project, it is made available as a property of the project, so that you canreference the task by name in your build file. Seehere for more details
If a task with the given name already exists in this project and theoverride
option is not setto true, an exception is thrown.
Creates aTask
with the given name and adds it to this project. Before the task is returned, the givenclosure is executed to configure the task. A map of creation options can be passed to this method to control howthe task is created. SeeProject.task(java.util.Map, java.lang.String)
for the available options.
After the task is added to the project, it is made available as a property of the project, so that you canreference the task by name in your build file. Seehere for more details
If a task with the given name already exists in this project and theoverride
option is not setto true, an exception is thrown.
Resolves a file path to a URI, relative to the project directory of this project. Evaluates the provided pathobject as described forProject.file(java.lang.Object)
, with the exception that any URI scheme is supported, not just'file:' URIs.
Creates a newFileTree
which contains the contents of the given ZIP file. The given zipPath path isevaluated as perProject.file(java.lang.Object)
. You can combine this method with theProject.copy(groovy.lang.Closure)
method to unzip a ZIP file.
The returned file tree is lazy, so that it scans for files only when the contents of the file tree arequeried. The file tree is also live, so that it scans for files each time the contents of the file tree arequeried.
void
appDirName
(String
appDirName)
Allows changing the application directory.Default is "src/main/application".
EarPluginConvention
deploymentDescriptor
(Action
<? superDeploymentDescriptor
>
configureAction)
Action
<? superDeploymentDescriptor
>Configures the deployment descriptor for this EAR archive.
The given action is executed to configure the deployment descriptor.
void
libDirName
(String
libDirName)
Allows changing the library directory in the EAR file. Default is "lib".
If this method is called, Gradle will not automatically try to fetchdependencies which have a JVM version compatible with the target compatibilityof this module.
This should be used whenever the default behavior is notapplicable, in particular when for some reason it's not possible to splita module and that this module only has some classes which require dependencieson higher versions.
Creates and configures a new instance of aManifest
. The given closure configuresthe new manifest instance before it is returned.
void
registerFeature
(String
name,Action
<? superFeatureSpec
>
configureAction)
Action
<? superFeatureSpec
>Registers a feature.
JavaToolchainSpec
toolchain
(Action
<? superJavaToolchainSpec
>
action)
Action
<? superJavaToolchainSpec
>Note: This method isincubating and may change in a future version of Gradle.
Configures the project wide toolchain requirements for tasks that require a tool from the toolchain (e.g.JavaCompile
).
Configuring a toolchain cannot be used together withsourceCompatibility
ortargetCompatibility
on this extension.Both values will be sourced from the toolchain.
Note: This method isincubating and may change in a future version of Gradle.
Adds a taskjavadocJar
that will package the output of thejavadoc
task in a JAR with classifierjavadoc
.
The produced artifact is registered as a documentation variant on thejava
component and added as a dependency on theassemble
task.This means that ifmaven-publish
orivy-publish
is also applied, the javadoc JAR will be published.
If the project already has a task namedjavadocJar
then no task is created.
The publishing of the Javadoc variant can also be disabled usingConfigurationVariantDetails.skip()
throughAdhocComponentWithVariants.withVariantsFromConfiguration(org.gradle.api.artifacts.Configuration, org.gradle.api.Action)
,if it should only be built locally by calling or wiring the ':javadocJar' task.
Note: This method isincubating and may change in a future version of Gradle.
Adds a tasksourcesJar
that will package the Java sources of the mainSourceSet
in a JAR with classifiersources
.
The produced artifact is registered as a documentation variant on thejava
component and added as a dependency on theassemble
task.This means that ifmaven-publish
orivy-publish
is also applied, the sources JAR will be published.
If the project already has a task namedsourcesJar
then no task is created.
The publishing of the sources variant can be disabled usingConfigurationVariantDetails.skip()
throughAdhocComponentWithVariants.withVariantsFromConfiguration(org.gradle.api.artifacts.Configuration, org.gradle.api.Action)
,if it should only be built locally by calling or wiring the ':sourcesJar' task.
Creates and configures a newMavenPom
. The given closure is executed to configure the new POM instance.
Configures this project and each of its sub-projects.
This method executes the given closure against this project and its sub-projects. The targetProject
is passed to the closure as the closure's delegate.
- Delegates to:
- Each
Project
inallprojects
Executes the given closure against theAntBuilder
for this project. You can use this in yourbuild file to execute ant tasks. TheAntBuild
is passed to the closure as the closure'sdelegate. See example in javadoc forProject.getAnt()
- Delegates to:
AntBuilder
fromant
Configures the published artifacts for this project.
This method executes the given closure against theArtifactHandler
for this project. TheArtifactHandler
is passed to the closure as the closure's delegate.
Example:
configurations {//declaring new configuration that will be used to associate with artifacts schema}task schemaJar(type: Jar) {//some imaginary task that creates a jar artifact with the schema}//associating the task that produces the artifact with the configurationartifacts {//configuration name and the task: schema schemaJar}
- Delegates to:
ArtifactHandler
fromartifacts
Configures the build script classpath for this project.
The given closure is executed against this project'sScriptHandler
. TheScriptHandler
ispassed to the closure as the closure's delegate.
- Delegates to:
ScriptHandler
frombuildscript
Configures the dependency configurations for this project.
This method executes the given closure against theConfigurationContainer
for this project. TheConfigurationContainer
is passed to the closure as the closure's delegate.
See docs forConfigurationContainer
- Delegates to:
ConfigurationContainer
fromconfigurations
Configures the dependencies for this project.
This method executes the given closure against theDependencyHandler
for this project. TheDependencyHandler
is passed to the closure as the closure's delegate.
See docs forDependencyHandler
- Delegates to:
DependencyHandler
fromdependencies
Configures the repositories for this project.
This method executes the given closure against theRepositoryHandler
for this project. TheRepositoryHandler
is passed to the closure as the closure's delegate.
- Delegates to:
RepositoryHandler
fromrepositories
Configures the sub-projects of this project.
This method executes the given closure against each of the sub-projects of this project. The targetProject
is passed to the closure as the closure's delegate.
- Delegates to:
- Each
Project
insubprojects
Configures theJavaApplication
added by the application plugin.
- Delegates to:
JavaApplication
fromapplication
Configures theCheckstyleExtension
added by the checkstyle plugin.
- Delegates to:
CheckstyleExtension
fromcheckstyle
Configures theCodeNarcExtension
added by the codenarc plugin.
- Delegates to:
CodeNarcExtension
fromcodenarc
Configures theDistributionContainer
added by the distribution plugin.
- Delegates to:
DistributionContainer
fromdistributions
Configures the deployment descriptor for this EAR archive.
The given closure is executed to configure the deployment descriptor.TheDeploymentDescriptor
is passed to the closure as its delegate.
- Delegates to:
DeploymentDescriptor
fromdeploymentDescriptor
Configures theEclipseModel
added by the eclipse plugin.
- Delegates to:
EclipseModel
fromeclipse
Configures theJacocoPluginExtension
added by the jacoco plugin.
- Delegates to:
JacocoPluginExtension
fromjacoco
Configures theReportingExtension
added by the java plugin.
- Delegates to:
ReportingExtension
fromreporting
Configures the source sets of this project.
The given closure is executed to configure theSourceSetContainer
. TheSourceSetContainer
is passed to the closure as its delegate.
See the example below howSourceSet
'main' is accessed and how theSourceDirectorySet
'java'is configured to exclude some package from compilation.
plugins { id'java'}sourceSets { main { java { exclude'some/unwanted/package/**' } }}
- Delegates to:
SourceSetContainer
fromsourceSets
Configures thePublishingExtension
added by the publishing plugin.
- Delegates to:
PublishingExtension
frompublishing
Configures theSigningExtension
added by the signing plugin.
- Delegates to:
SigningExtension
fromsigning
Configures theVisualStudioRootExtension
added by the visual-studio plugin.
- Delegates to:
VisualStudioRootExtension
fromvisualStudio
Configures theXcodeRootExtension
added by the xcode plugin.
- Delegates to:
XcodeRootExtension
fromxcode