|
Groovy Documentation | |||||||
FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | METHOD | DETAIL: FIELD | METHOD |
public interface Settings
Settings
declares the configuration required to instantiate and evaluate the hierarchy of Project instances which are to participate in a build.
There is a one-to-one correspondence between a Settings
instance and a {
settings file. Before Gradle assembles the projects for a build, it creates a
Settings
instance and executes the settings file against it.
One of the purposes of the Settings
object is to allow you to declare the projects which are to be
included in the build. You add projects to the build using the include(String[]) method. There is always a
root project included in a build. It is added automatically when the Settings
object is created. The
root project's name defaults to the name of the directory containing the settings file. The root project's project
directory defaults to the directory containing the settings file.
When a project is included in the build, a ProjectDescriptor is created. You can use this descriptor to change the default vaules for several properties of the project.
In addition to the properties of this interface, the Settings object makes some additional read-only properties available to the settings script. This includes properties from the following sources:
Groovy Documentation