public class StartParameter extends org.gradle.logging.LoggingConfiguration implements Serializable
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)
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()
.
GradleLauncher
,
Serialized FormModifier and Type | Field and Description |
---|---|
static File |
DEFAULT_GRADLE_USER_HOME
The default user home directory.
|
static String |
GRADLE_USER_HOME_PROPERTY_KEY |
Constructor and Description |
---|
StartParameter()
Creates a
StartParameter with default values. |
Modifier and Type | Method and Description |
---|---|
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()
Deprecated.
Use #isRecompileScripts and/or #isRerunTasks instead.
|
File |
getCurrentDir()
Returns the directory to use to select the default project, and to search for the settings file.
|
Set<String> |
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<File> |
getInitScripts()
Returns all explicitly added init scripts that will be run before the build starts.
|
Map<String,String> |
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<String,String> |
getProjectProperties() |
RefreshOptions |
getRefreshOptions()
Deprecated.
Use #isRefreshDependencies instead.
|
File |
getSettingsFile()
Returns the explicit settings file to use for the build, or null.
|
Map<String,String> |
getSystemPropertiesArgs() |
List<String> |
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()
Deprecated.
Use #isRerunTasks instead.
|
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 |
isRecompileScripts()
Specifies whether the build scripts should be recompiled.
|
boolean |
isRefreshDependencies()
Specifies whether the depencendies should be refreshed..
|
boolean |
isRerunTasks()
Specifies whether the cached task results should be ignored and each task should be forced to be executed.
|
boolean |
isSearchUpwards() |
boolean |
isUseEmptySettings()
Returns whether an empty settings script will be used regardless of whether one exists in the default location.
|
StartParameter |
newBuild()
Creates the parameters for a new build, using these parameters as a template.
|
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)
Deprecated.
Use #setRecompileScripts and/or #setRerunTasks instead.
|
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<String> 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<File> initScripts)
Sets the list of init scripts to be run before the build starts.
|
void |
setNoOpt(boolean noOpt)
Deprecated.
Use #setRefreshDependencies(boolean) instead.
|
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<String,String> projectProperties) |
void |
setRecompileScripts(boolean recompileScripts)
Specifies whether the build scripts should be recompiled.
|
void |
setRefreshDependencies(boolean refreshDependencies)
Specifies whether the depencendies should be refreshed..
|
void |
setRefreshOptions(RefreshOptions refreshOptions)
Deprecated.
Use #setRefreshDependencies(boolean) instead.
|
void |
setRerunTasks(boolean rerunTasks)
Specifies whether the cached task results should be ignored and each task should be forced to be executed.
|
void |
setSearchUpwards(boolean searchUpwards) |
void |
setSettingsFile(File settingsFile)
Sets the settings file to use for the build.
|
void |
setSystemPropertiesArgs(Map<String,String> systemPropertiesArgs) |
void |
setTaskNames(Iterable<String> taskNames)
Sets the tasks to execute in this build.
|
String |
toString() |
StartParameter |
useEmptySettings()
Specifies that an empty settings script should be used.
|
StartParameter |
useEmptySettingsScript()
Deprecated.
|
public static final String GRADLE_USER_HOME_PROPERTY_KEY
public static final File DEFAULT_GRADLE_USER_HOME
public StartParameter()
StartParameter
with default values. This is roughly equivalent to running Gradle on the command-line with no arguments.public void setProjectCacheDir(File projectCacheDir)
public File getProjectCacheDir()
public StartParameter newInstance()
StartParameter
instance.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 File getBuildFile()
public void setBuildFile(File buildFile)
buildFile
- The build file. May be null.public StartParameter useEmptySettings()
setSettingsFile(java.io.File)
, it will not be used.
If setSettingsFile(java.io.File)
is called after this, it will supersede calling this method.@Deprecated public StartParameter useEmptySettingsScript()
useEmptySettings()
useEmptySettings()
.public boolean isUseEmptySettings()
public List<String> getTaskNames()
public void setTaskNames(Iterable<String> 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.public Set<String> getExcludedTaskNames()
public void setExcludedTaskNames(Iterable<String> excludedTaskNames)
excludedTaskNames
- The task names. Can be null.public File getCurrentDir()
public void setCurrentDir(File currentDir)
currentDir
- The directory. Should not be null.public boolean isSearchUpwards()
public void setSearchUpwards(boolean searchUpwards)
public void setSystemPropertiesArgs(Map<String,String> systemPropertiesArgs)
public Map<String,String> getMergedSystemProperties()
System property args take precedency overy JVM system properties.
public File getGradleUserHomeDir()
public void setGradleUserHomeDir(File gradleUserHomeDir)
gradleUserHomeDir
- The home directory. May be null.public boolean isBuildProjectDependencies()
public StartParameter setBuildProjectDependencies(boolean build)
@Deprecated public CacheUsage getCacheUsage()
@Deprecated public void setCacheUsage(CacheUsage cacheUsage)
public boolean isDryRun()
public void setDryRun(boolean dryRun)
@Deprecated public boolean isNoOpt()
@Deprecated public void setNoOpt(boolean noOpt)
noOpt
- The boolean value for disabling task optimsation.public void setSettingsFile(File settingsFile)
settingsFile
- The settings file to use. May be null.public File getSettingsFile()
isUseEmptySettings()
returns true, then no settings file at all will be used.isUseEmptySettings()
public void addInitScript(File initScriptFile)
initScriptFile
- The init scripts.public void setInitScripts(List<File> initScripts)
initScripts
- The init scripts.public List<File> getInitScripts()
public void setProjectDir(File projectDir)
projectDir
- The project directory. May be null.public File getProjectDir()
public void setProfile(boolean profile)
profile
- true if a profile report should be generatedpublic boolean isProfile()
public boolean isContinueOnFailure()
public void setContinueOnFailure(boolean continueOnFailure)
public boolean isOffline()
public void setOffline(boolean offline)
@Deprecated public void setRefreshOptions(RefreshOptions refreshOptions)
@Deprecated public RefreshOptions getRefreshOptions()
public boolean isRefreshDependencies()
public void setRefreshDependencies(boolean refreshDependencies)
public boolean isRerunTasks()
public void setRerunTasks(boolean rerunTasks)
public boolean isRecompileScripts()
public void setRecompileScripts(boolean recompileScripts)