org.gradle.api.initialization.dsl

インタフェース ScriptHandler

public interface ScriptHandler

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 "classpath" configuration. These dependencies are resolved just prior to script compilation, and assembled into the classpath for the script.

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().

フィールドの概要

フィールド

修飾子とタイプ	フィールドと説明
static String	CLASSPATH_CONFIGURATION The name of the configuration used to assemble the script classpath.

メソッドの概要

修飾子とタイプ	メソッドと説明
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.

フィールドの詳細

CLASSPATH_CONFIGURATION

static final String CLASSPATH_CONFIGURATION

The name of the configuration used to assemble the script classpath.

関連項目:

定数フィールド値

メソッドの詳細

getSourceFile

File getSourceFile()

Returns the file containing the source for the script, if any.

戻り値:

The source file. Returns null if the script source is not a file.

getSourceURI

URI getSourceURI()

Returns the URI for the script source, if any.

戻り値:

The source URI. Returns null if the script source has no URI.

getRepositories

RepositoryHandler getRepositories()

Returns a handler to create repositories which are used for retrieving dependencies for the script classpath.

戻り値:

the repository handler. Never returns null.

repositories

void repositories(Closure configureClosure)

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.

getDependencies

DependencyHandler getDependencies()

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.

戻り値:

the dependency handler. Never returns null.

関連項目:

getConfigurations()

dependencies

void dependencies(Closure configureClosure)

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.

getConfigurations

ConfigurationContainer getConfigurations()

Returns the configurations of this handler. This usually contains a single configuration, called "classpath".

戻り値:

The configuration of this handler.

getClassLoader

ClassLoader getClassLoader()

Returns the ClassLoader which contains the classpath for this script.

戻り値:

The ClassLoader. Never returns null.