|
Groovy Documentation | |||||||
FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.gradle.logging.LoggingConfiguration
org.gradle.StartParameter
public class StartParameter extends LoggingConfiguration
StartParameter defines the configuration used by a GradleLauncher instance to execute a build. The properties of StartParameter generally correspond to the command-line options of Gradle. You pass a StartParameter instance to GradleLauncher#newInstance(StartParameter)#newInstance(StartParameter) when you create a new Gradle instance.
You can obtain an instance of a StartParameter by either creating a new one, or duplicating an existing one using newInstance or newBuild.
Field Summary | |
---|---|
static File |
DEFAULT_GRADLE_USER_HOME
The default user home directory. |
static String |
GRADLE_USER_HOME_PROPERTY_KEY
|
Constructor Summary | |
StartParameter()
Creates a StartParameter with default values. |
Method Summary | |
---|---|
void
|
addInitScript(File initScriptFile)
Adds the given file to the list of init scripts that are run before the build starts. |
boolean
|
equals(Object obj)
|
File
|
getBuildFile()
Returns the build file to use to select the default project. |
CacheUsage
|
getCacheUsage()
|
File
|
getCurrentDir()
Returns the directory to use to select the default project, and to search for the settings file. |
Set
|
getExcludedTaskNames()
Returns the names of the tasks to be excluded from this build. |
File
|
getGradleUserHomeDir()
Returns the directory to use as the user home directory. |
List
|
getInitScripts()
Returns all explicitly added init scripts that will be run before the build starts. |
Map
|
getMergedSystemProperties()
Returns a newly constructed map that is the JVM system properties merged with the system property args. |
File
|
getProjectCacheDir()
Returns the project's cache dir. |
File
|
getProjectDir()
Returns the project dir to use to select the default project. |
Map
|
getProjectProperties()
|
RefreshOptions
|
getRefreshOptions()
Returns the refresh options used for the build. |
File
|
getSettingsFile()
Returns the explicit settings file to use for the build, or null. |
Map
|
getSystemPropertiesArgs()
|
List
|
getTaskNames()
Returns the names of the tasks to execute in this build. |
int
|
hashCode()
|
boolean
|
isBuildProjectDependencies()
Returns true if project dependencies are to be built, false if they should not be. |
boolean
|
isContinueOnFailure()
Specifies whether the build should continue on task failure. |
boolean
|
isDryRun()
|
boolean
|
isNoOpt()
|
boolean
|
isOffline()
Specifies whether the build should be performed offline (ie without network access). |
boolean
|
isProfile()
Returns true if a profile report will be generated. |
boolean
|
isSearchUpwards()
|
boolean
|
isUseEmptySettings()
Returns whether an empty settings script will be used regardless of whether one exists in the default location. |
StartParameter
|
newBuild()
|
StartParameter
|
newInstance()
Duplicates this StartParameter instance. |
void
|
setBuildFile(File buildFile)
Sets the build file to use to select the default project. |
StartParameter
|
setBuildProjectDependencies(boolean build)
Specifies whether project dependencies should be built. |
void
|
setCacheUsage(CacheUsage cacheUsage)
|
void
|
setContinueOnFailure(boolean continueOnFailure)
Specifies whether the build should continue on task failure. |
void
|
setCurrentDir(File currentDir)
Sets the directory to use to select the default project, and to search for the settings file. |
void
|
setDryRun(boolean dryRun)
|
void
|
setExcludedTaskNames(Iterable excludedTaskNames)
Sets the tasks to exclude from this build. |
void
|
setGradleUserHomeDir(File gradleUserHomeDir)
Sets the directory to use as the user home directory. |
void
|
setInitScripts(List initScripts)
Sets the list of init scripts to be run before the build starts. |
void
|
setNoOpt(boolean noOpt)
|
void
|
setOffline(boolean offline)
Specifies whether the build should be performed offline (ie without network access). |
void
|
setProfile(boolean profile)
Specifies if a profile report should be generated. |
void
|
setProjectCacheDir(File projectCacheDir)
Sets the project's cache location. |
void
|
setProjectDir(File projectDir)
Sets the project directory to use to select the default project. |
void
|
setProjectProperties(Map projectProperties)
|
void
|
setRefreshOptions(RefreshOptions refreshOptions)
Supplies the refresh options to use for the build. |
void
|
setSearchUpwards(boolean searchUpwards)
|
void
|
setSettingsFile(File settingsFile)
Sets the settings file to use for the build. |
void
|
setSystemPropertiesArgs(Map systemPropertiesArgs)
|
void
|
setTaskNames(Iterable taskNames)
|
String
|
toString()
|
StartParameter
|
useEmptySettings()
Specifies that an empty settings script should be used. |
StartParameter
|
useEmptySettingsScript()
Deprecated. |
Field Detail |
---|
public static final File DEFAULT_GRADLE_USER_HOME
public static final String GRADLE_USER_HOME_PROPERTY_KEY
Constructor Detail |
---|
public StartParameter()
Method Detail |
---|
public void addInitScript(File initScriptFile)
initScriptFile
- The init scripts.
public boolean equals(Object obj)
public File getBuildFile()
public CacheUsage getCacheUsage()
public File getCurrentDir()
public Set getExcludedTaskNames()
public File getGradleUserHomeDir()
public List getInitScripts()
public Map getMergedSystemProperties()
System property args take precedency overy JVM system properties.
public File getProjectCacheDir()
public File getProjectDir()
public Map getProjectProperties()
public RefreshOptions getRefreshOptions()
public File getSettingsFile()
public Map getSystemPropertiesArgs()
public List getTaskNames()
public int hashCode()
public boolean isBuildProjectDependencies()
public boolean isContinueOnFailure()
public boolean isDryRun()
public boolean isNoOpt()
public boolean isOffline()
public boolean isProfile()
public boolean isSearchUpwards()
public boolean isUseEmptySettings()
public StartParameter newBuild()
Creates the parameters for a new build, using these parameters as a template. Copies the environmental properties from this parameter (eg gradle user home dir, etc), but does not copy the build specific properties (eg task names).
public StartParameter newInstance()
public void setBuildFile(File buildFile)
buildFile
- The build file. May be null.
public StartParameter setBuildProjectDependencies(boolean build)
public void setCacheUsage(CacheUsage cacheUsage)
public void setContinueOnFailure(boolean continueOnFailure)
public void setCurrentDir(File currentDir)
currentDir
- The directory. Should not be null.
public void setDryRun(boolean dryRun)
public void setExcludedTaskNames(Iterable excludedTaskNames)
excludedTaskNames
- The task names. Can be null.
public void setGradleUserHomeDir(File gradleUserHomeDir)
gradleUserHomeDir
- The home directory. May be null.
public void setInitScripts(List initScripts)
initScripts
- The init scripts.
public void setNoOpt(boolean noOpt)
public void setOffline(boolean offline)
public void setProfile(boolean profile)
profile
- true if a profile report should be generated
public void setProjectCacheDir(File projectCacheDir)
public void setProjectDir(File projectDir)
projectDir
- The project directory. May be null.
public void setProjectProperties(Map projectProperties)
public void setRefreshOptions(RefreshOptions refreshOptions)
public void setSearchUpwards(boolean searchUpwards)
public void setSettingsFile(File settingsFile)
settingsFile
- The settings file to use. May be null.
public void setSystemPropertiesArgs(Map systemPropertiesArgs)
public void setTaskNames(Iterable taskNames)
Sets the tasks to execute in this build. Set to an empty list, or null, to execute the default tasks for the project. The tasks are executed in the order provided, subject to dependency between the tasks.
taskNames
- the names of the tasks to execute in this build.
@Override public String toString()
public StartParameter useEmptySettings()
@Deprecated public StartParameter useEmptySettingsScript()
Gradle API 1.0-milestone-9