A ScriptHandler
allows you to manage the compilation and execution of a build script. You can declare the
classpath used to compile and execute a build script. This classpath is also used to load the plugins which the build
script uses.
You can obtain a ScriptHandler
instance using Project.getBuildscript or Script.getBuildscript.
To declare the script classpath, you use the DependencyHandler provided by getDependencies() to attach dependencies to the {
For most external dependencies you will also need to declare one or more repositories where the dependencies can be found, using the RepositoryHandler provided by getRepositories().
Modifiers | Name | Description |
---|---|---|
String |
CLASSPATH_CONFIGURATION |
The name of the configuration used to assemble the script classpath. |
Type | Name and description |
---|---|
void |
dependencies(Closure configureClosure) Configures the dependencies for the script. |
ClassLoader |
getClassLoader() Returns the ClassLoader which contains the classpath for this script. |
ConfigurationContainer |
getConfigurations() Returns the configurations of this handler. |
DependencyHandler |
getDependencies() Returns the dependencies of the script. |
RepositoryHandler |
getRepositories() Returns a handler to create repositories which are used for retrieving dependencies for the script classpath. |
File |
getSourceFile() Returns the file containing the source for the script, if any. |
URI |
getSourceURI() Returns the URI for the script source, if any. |
void |
repositories(Closure configureClosure) Configures the repositories for the script dependencies. |
The name of the configuration used to assemble the script classpath.
Configures the dependencies for the script. Executes the given closure against the DependencyHandler for this handler. The DependencyHandler is passed to the closure as the closure's delegate.
configureClosure
- the closure to use to configure the dependencies. Returns the ClassLoader
which contains the classpath for this script.
Returns the configurations of this handler. This usually contains a single configuration, called {
Returns the dependencies of the script. The returned dependency handler instance can be used for adding new dependencies. For accessing already declared dependencies, the configurations can be used.
Returns a handler to create repositories which are used for retrieving dependencies for the script classpath.
Returns the file containing the source for the script, if any.
Returns the URI for the script source, if any.
Configures the repositories for the script dependencies. Executes the given closure against the RepositoryHandler for this handler. The RepositoryHandler is passed to the closure as the closure's delegate.
configureClosure
- the closure to use to configure the repositories.