org.gradle.initialization

Class BaseSettings

java.lang.Object

org.gradle.initialization.BaseSettings

All Implemented Interfaces:

Settings, SettingsInternal

public class BaseSettings
extends Object
implements SettingsInternal

Author:

Hans Dockter

Field Summary

Fields

Modifier and Type	Field and Description
static String	DEFAULT_BUILD_SRC_DIR

Fields inherited from interface org.gradle.api.initialization.Settings

DEFAULT_SETTINGS_FILE

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	BaseSettings()
	BaseSettings(GradleInternal gradle, IProjectDescriptorRegistry projectDescriptorRegistry, URLClassLoader classloader, File settingsDir, ScriptSource settingsScript, StartParameter startParameter)

Method Summary

Methods

Modifier and Type	Method and Description
void	addDynamicProperties(Map<String,?> properties)
DefaultProjectDescriptor	createProjectDescriptor(DefaultProjectDescriptor parent, String name, File dir)
DefaultProjectDescriptor	findProject(File projectDir) Returns the project with the given project directory.
DefaultProjectDescriptor	findProject(String path) Returns the project with the given path.
URLClassLoader	getClassLoader()
protected DynamicObject	getDynamicObject()
GradleInternal	getGradle() Returns the Gradle instance for the current build.
IProjectDescriptorRegistry	getProjectDescriptorRegistry()
IProjectRegistry<DefaultProjectDescriptor>	getProjectRegistry()
File	getRootDir() Returns the root directory of the build.
ProjectDescriptor	getRootProject() Returns the root project of the build.
Settings	getSettings() Returns this settings object.
File	getSettingsDir() Returns the settings directory of the build.
ScriptSource	getSettingsScript()
StartParameter	getStartParameter() Returns the set of parameters used to invoke this instance of Gradle.
void	include(String[] projectPaths) Adds the given projects to the build.
void	includeFlat(String[] projectNames) Adds the given projects to the build.
DefaultProjectDescriptor	project(File projectDir) Returns the project with the given project directory.
DefaultProjectDescriptor	project(String path) Returns the project with the given path.
void	setProjectDescriptorRegistry(IProjectDescriptorRegistry projectDescriptorRegistry)
void	setRootProjectDescriptor(DefaultProjectDescriptor rootProjectDescriptor)
void	setSettingsDir(File settingsDir)
void	setSettingsScript(ScriptSource settingsScript)
void	setStartParameter(StartParameter startParameter)
String	toString()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

DEFAULT_BUILD_SRC_DIR

public static final String DEFAULT_BUILD_SRC_DIR

See Also:

Constant Field Values

Constructor Detail

BaseSettings

protected BaseSettings()

BaseSettings

public BaseSettings(GradleInternal gradle,
            IProjectDescriptorRegistry projectDescriptorRegistry,
            URLClassLoader classloader,
            File settingsDir,
            ScriptSource settingsScript,
            StartParameter startParameter)

Method Detail

toString

public String toString()

Overrides:

toString in class Object

getGradle

public GradleInternal getGradle()

Description copied from interface: Settings

Returns the Gradle instance for the current build.

Specified by:

getGradle in interface Settings

Returns:

The Gradle instance. Never returns null.

getSettings

public Settings getSettings()

Description copied from interface: Settings

Returns this settings object.

Specified by:

getSettings in interface Settings

Returns:

This settings object. Never returns null.

createProjectDescriptor

public DefaultProjectDescriptor createProjectDescriptor(DefaultProjectDescriptor parent,
                                               String name,
                                               File dir)

findProject

public DefaultProjectDescriptor findProject(String path)

Description copied from interface: Settings

Returns the project with the given path.

Specified by:

findProject in interface Settings

Parameters:

path - The path

Returns:

The project with the given path. Returns null if no such project exists.

findProject

public DefaultProjectDescriptor findProject(File projectDir)

Description copied from interface: Settings

Returns the project with the given project directory.

Specified by:

findProject in interface Settings

Parameters:

projectDir - The project directory.

Returns:

The project with the given project directory. Returns null if no such project exists.

project

public DefaultProjectDescriptor project(String path)

Description copied from interface: Settings

Returns the project with the given path.

Specified by:

project in interface Settings

Parameters:

path - The path.

Returns:

The project with the given path. Never returns null.

project

public DefaultProjectDescriptor project(File projectDir)

Description copied from interface: Settings

Returns the project with the given project directory.

Specified by:

project in interface Settings

Parameters:

projectDir - The project directory.

Returns:

The project with the given project directory. Never returns null.

include

public void include(String[] projectPaths)

Description copied from interface: Settings

Adds the given projects to the build. Each path in the supplied list is treated as the path of a project to add to the build. Note that these path are not file paths, but instead specify the location of the new project in the project heirarchy. As such, the supplied paths must use the ':' character as separator.

The last element of the supplied path is used as the project name. The supplied path is converted to a project directory relative to the root project directory.

As an example, the path a:b adds a project with path :a:b, name b and project directory $rootDir/a/b.

Specified by:

include in interface Settings

Parameters:

projectPaths - the projects to add.

includeFlat

public void includeFlat(String[] projectNames)

Description copied from interface: Settings

Adds the given projects to the build. Each name in the supplied list is treated as the name of a project to add to the build.

The supplied name is converted to a project directory relative to the parent directory of the root project directory.

As an example, the name a add a project with path :a, name a and project directory $rootDir/../a.

Specified by:

includeFlat in interface Settings

Parameters:

projectNames - the projects to add.

getClassLoader

public URLClassLoader getClassLoader()

Specified by:

getClassLoader in interface SettingsInternal

getRootProject

public ProjectDescriptor getRootProject()

Description copied from interface: Settings

Returns the root project of the build.

Specified by:

getRootProject in interface Settings

Returns:

The root project. Never returns null.

setRootProjectDescriptor

public void setRootProjectDescriptor(DefaultProjectDescriptor rootProjectDescriptor)

getRootDir

public File getRootDir()

Description copied from interface: Settings

Returns the root directory of the build. The root directory is the project directory of the root project.

Specified by:

getRootDir in interface Settings

Returns:

The root directory. Never returns null.

getStartParameter

public StartParameter getStartParameter()

Description copied from interface: Settings

Returns the set of parameters used to invoke this instance of Gradle.

Specified by:

getStartParameter in interface Settings

Specified by:

getStartParameter in interface SettingsInternal

Returns:

The parameters. Never returns null.

setStartParameter

public void setStartParameter(StartParameter startParameter)

getSettingsDir

public File getSettingsDir()

Description copied from interface: Settings

Returns the settings directory of the build. The settings directory is the directory containing the settings file.

Specified by:

getSettingsDir in interface Settings

Returns:

The settings directory. Never returns null.

setSettingsDir

public void setSettingsDir(File settingsDir)

getSettingsScript

public ScriptSource getSettingsScript()

Specified by:

getSettingsScript in interface SettingsInternal

setSettingsScript

public void setSettingsScript(ScriptSource settingsScript)

getProjectDescriptorRegistry

public IProjectDescriptorRegistry getProjectDescriptorRegistry()

setProjectDescriptorRegistry

public void setProjectDescriptorRegistry(IProjectDescriptorRegistry projectDescriptorRegistry)

addDynamicProperties

public void addDynamicProperties(Map<String,?> properties)

getDynamicObject

protected DynamicObject getDynamicObject()

getProjectRegistry

public IProjectRegistry<DefaultProjectDescriptor> getProjectRegistry()

Specified by:

getProjectRegistry in interface SettingsInternal