Class StartParameter
- All Implemented Interfaces:
Serializable
,LoggingConfiguration
,ParallelismConfiguration
StartParameter
defines the configuration used by a Gradle instance to execute a build. The properties of StartParameter
generally correspond to the command-line options of
Gradle.
You can obtain an instance of a StartParameter
by either creating a new one, or duplicating an existing one using newInstance()
or newBuild()
.
- See Also:
-
Field Summary
-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionvoid
addInitScript
(File initScriptFile) Adds the given file to the list of init scripts that are run before the build starts.boolean
Returns all init scripts, including explicit init scripts and implicit init scripts.Returns the build file to use to select the default project.Returns the style of logging output that should be written to the console.Returns the directory to use to select the default project, and to search for the settings file.Returns the names of the tasks to be excluded from this build.Returns the directory to use as the user home directory.Returns all explicitly added init scripts that will be run before the build starts.Returns the minimum logging level to use.int
Returns the maximum number of concurrent workers used for underlying build operations.Returns the project's cache dir.Returns the project dir to use to select the default project.Returns the explicit settings file to use for the build, or null.Returns the detail that should be included in stacktraces.Returns the names of the tasks to execute in this build.Returns the tasks to execute in this build.int
hashCode()
void
includeBuild
(File includedBuild) boolean
Returns true if the build cache is enabled.boolean
Returns true if project dependencies are to be built, false if they should not be.boolean
Returns true if build scan should be created.boolean
If the configure-on-demand mode is activeboolean
Specifies whether the build should continue on task failure.boolean
boolean
isDryRun()
boolean
Returns true when console is interactive.boolean
Returns true when build scan creation is explicitly disabled.boolean
Specifies whether the build should be performed offline (ie without network access).boolean
Returns true if parallel project execution is enabled.boolean
Returns true if a profile report will be generated.boolean
Specifies whether the build scripts should be recompiled.boolean
Specifies whether the dependencies should be refreshed..boolean
Specifies whether the cached task results should be ignored and each task should be forced to be executed.boolean
boolean
Deprecated.boolean
Returns whether an empty settings script will be used regardless of whether one exists in the default location.newBuild()
Creates the parameters for a new build, using these parameters as a template.Duplicates thisStartParameter
instance.protected StartParameter
protected StartParameter
void
setBuildCacheEnabled
(boolean buildCacheEnabled) Enables/disables the build cache.void
setBuildFile
(File buildFile) Sets the build file to use to select the default project.setBuildProjectDependencies
(boolean build) Specifies whether project dependencies should be built.void
setBuildScan
(boolean buildScan) Specifies whether a build scan should be created.void
setConfigureOnDemand
(boolean configureOnDemand) void
setConsoleOutput
(ConsoleOutput consoleOutput) Specifies the style of logging output that should be written to the console.void
setContinueOnFailure
(boolean continueOnFailure) Specifies whether the build should continue on task failure.void
setContinuous
(boolean enabled) 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
setIncludedBuilds
(List<File> includedBuilds) void
setInitScripts
(List<File> initScripts) Sets the list of init scripts to be run before the build starts.void
setInteractive
(boolean interactive) Specifies whether console is interactive.void
setLogLevel
(LogLevel logLevel) Specifies the minimum logging level to use.void
setMaxWorkerCount
(int maxWorkerCount) Specifies the maximum number of concurrent workers used for underlying build operations.void
setNoBuildScan
(boolean noBuildScan) Specifies whether build scan creation is explicitly disabled.void
setOffline
(boolean offline) Specifies whether the build should be performed offline (ie without network access).void
setParallelProjectExecutionEnabled
(boolean parallelProjectExecution) Enables/disables parallel project execution.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 dependencies should be refreshed..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
setShowStacktrace
(ShowStacktrace showStacktrace) Sets the detail that should be included in stacktraces.void
setSystemPropertiesArgs
(Map<String, String> systemPropertiesArgs) void
setTaskNames
(Iterable<String> taskNames) Sets the tasks to execute in this build.void
setTaskOutputCacheEnabled
(boolean buildCacheEnabled) Deprecated.void
setTaskRequests
(Iterable<? extends TaskExecutionRequest> taskParameters) Sets the task parameters to execute in this build.toString()
Specifies that an empty settings script should be used.
-
Field Details
-
GRADLE_USER_HOME_PROPERTY_KEY
- See Also:
-
DEFAULT_GRADLE_USER_HOME
The default user home directory.
-
-
Constructor Details
-
StartParameter
public StartParameter()Creates aStartParameter
with default values. This is roughly equivalent to running Gradle on the command-line with no arguments.
-
-
Method Details
-
getLogLevel
Returns the minimum logging level to use. All log messages with a lower log level are ignored. Defaults toLogLevel.LIFECYCLE
.- Specified by:
getLogLevel
in interfaceLoggingConfiguration
-
setLogLevel
Specifies the minimum logging level to use. All log messages with a lower log level are ignored.- Specified by:
setLogLevel
in interfaceLoggingConfiguration
-
getShowStacktrace
Returns the detail that should be included in stacktraces. Defaults toShowStacktrace.INTERNAL_EXCEPTIONS
.- Specified by:
getShowStacktrace
in interfaceLoggingConfiguration
-
setShowStacktrace
Sets the detail that should be included in stacktraces.- Specified by:
setShowStacktrace
in interfaceLoggingConfiguration
-
getConsoleOutput
Returns the style of logging output that should be written to the console. Defaults toConsoleOutput.Auto
- Specified by:
getConsoleOutput
in interfaceLoggingConfiguration
-
setConsoleOutput
Specifies the style of logging output that should be written to the console.- Specified by:
setConsoleOutput
in interfaceLoggingConfiguration
-
setProjectCacheDir
Sets the project's cache location. Set to null to use the default location. -
getProjectCacheDir
Returns the project's cache dir.- Returns:
- project's cache dir, or null if the default location is to be used.
-
newInstance
Duplicates thisStartParameter
instance.- Returns:
- the new parameters.
-
prepareNewInstance
-
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).
- Returns:
- The new parameters.
-
prepareNewBuild
-
equals
-
hashCode
public int hashCode() -
getBuildFile
Returns the build file to use to select the default project. Returns null when the build file is not used to select the default project.- Returns:
- The build file. May be null.
-
setBuildFile
Sets the build file to use to select the default project. Use null to disable selecting the default project using the build file.- Parameters:
buildFile
- The build file. May be null.
-
useEmptySettings
Specifies that an empty settings script should be used. This means that even if a settings file exists in the conventional location, or has been previously specified bysetSettingsFile(java.io.File)
, it will not be used. IfsetSettingsFile(java.io.File)
is called after this, it will supersede calling this method.- Returns:
- this
-
isUseEmptySettings
public boolean isUseEmptySettings()Returns whether an empty settings script will be used regardless of whether one exists in the default location.- Returns:
- Whether to use empty settings or not.
-
getTaskNames
Returns the names of the tasks to execute in this build. When empty, the default tasks for the project will be executed. IfTaskExecutionRequest
s are set for this build then names from these task parameters are returned.- Returns:
- the names of the tasks to execute in this build. Never returns null.
-
setTaskNames
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.
- Parameters:
taskNames
- the names of the tasks to execute in this build.
-
getTaskRequests
Returns the tasks to execute in this build. When empty, the default tasks for the project will be executed.- Returns:
- the tasks to execute in this build. Never returns null.
-
setTaskRequests
Sets the task parameters to execute in this build. Set to an empty list, to execute the default tasks for the project. The tasks are executed in the order provided, subject to dependency between the tasks.
- Parameters:
taskParameters
- the tasks to execute in this build.
-
getExcludedTaskNames
Returns the names of the tasks to be excluded from this build. When empty, no tasks are excluded from the build.- Returns:
- The names of the excluded tasks. Returns an empty set if there are no such tasks.
-
setExcludedTaskNames
Sets the tasks to exclude from this build.- Parameters:
excludedTaskNames
- The task names.
-
getCurrentDir
Returns the directory to use to select the default project, and to search for the settings file.- Returns:
- The current directory. Never returns null.
-
setCurrentDir
Sets the directory to use to select the default project, and to search for the settings file. Set to null to use the default current directory.- Parameters:
currentDir
- The directory. Set to null to use the default.
-
isSearchUpwards
public boolean isSearchUpwards() -
setSearchUpwards
public void setSearchUpwards(boolean searchUpwards) -
getProjectProperties
-
setProjectProperties
-
getSystemPropertiesArgs
-
setSystemPropertiesArgs
-
getGradleUserHomeDir
Returns the directory to use as the user home directory.- Returns:
- The home directory.
-
setGradleUserHomeDir
Sets the directory to use as the user home directory. Set to null to use the default directory.- Parameters:
gradleUserHomeDir
- The home directory. May be null.
-
isBuildProjectDependencies
public boolean isBuildProjectDependencies()Returns true if project dependencies are to be built, false if they should not be. The default is true. -
setBuildProjectDependencies
Specifies whether project dependencies should be built. Defaults to true.- Returns:
- this
-
isDryRun
public boolean isDryRun() -
setDryRun
public void setDryRun(boolean dryRun) -
setSettingsFile
Sets the settings file to use for the build. Use null to use the default settings file.- Parameters:
settingsFile
- The settings file to use. May be null.
-
getSettingsFile
Returns the explicit settings file to use for the build, or null. Will return null if the default settings file is to be used. However, ifisUseEmptySettings()
returns true, then no settings file at all will be used.- Returns:
- The settings file. May be null.
- See Also:
-
addInitScript
Adds the given file to the list of init scripts that are run before the build starts. This list is in addition to the default init scripts.- Parameters:
initScriptFile
- The init scripts.
-
setInitScripts
Sets the list of init scripts to be run before the build starts. This list is in addition to the default init scripts.- Parameters:
initScripts
- The init scripts.
-
getInitScripts
Returns all explicitly added init scripts that will be run before the build starts. This list does not contain the user init script located in ${user.home}/.gradle/init.gradle, even though that init script will also be run.- Returns:
- list of all explicitly added init scripts.
-
getAllInitScripts
Returns all init scripts, including explicit init scripts and implicit init scripts.- Returns:
- All init scripts, including explicit init scripts and implicit init scripts.
-
setProjectDir
Sets the project directory to use to select the default project. Use null to use the default criteria for selecting the default project.- Parameters:
projectDir
- The project directory. May be null.
-
getProjectDir
Returns the project dir to use to select the default project. Returns null when the build file is not used to select the default project- Returns:
- The project dir. May be null.
-
setProfile
public void setProfile(boolean profile) Specifies if a profile report should be generated.- Parameters:
profile
- true if a profile report should be generated
-
isProfile
public boolean isProfile()Returns true if a profile report will be generated. -
isContinueOnFailure
public boolean isContinueOnFailure()Specifies whether the build should continue on task failure. The default is false. -
setContinueOnFailure
public void setContinueOnFailure(boolean continueOnFailure) Specifies whether the build should continue on task failure. The default is false. -
isOffline
public boolean isOffline()Specifies whether the build should be performed offline (ie without network access). -
setOffline
public void setOffline(boolean offline) Specifies whether the build should be performed offline (ie without network access). -
isRefreshDependencies
public boolean isRefreshDependencies()Specifies whether the dependencies should be refreshed.. -
setRefreshDependencies
public void setRefreshDependencies(boolean refreshDependencies) Specifies whether the dependencies should be refreshed.. -
isRerunTasks
public boolean isRerunTasks()Specifies whether the cached task results should be ignored and each task should be forced to be executed. -
setRerunTasks
public void setRerunTasks(boolean rerunTasks) Specifies whether the cached task results should be ignored and each task should be forced to be executed. -
isRecompileScripts
public boolean isRecompileScripts()Specifies whether the build scripts should be recompiled. -
setRecompileScripts
public void setRecompileScripts(boolean recompileScripts) Specifies whether the build scripts should be recompiled. -
isParallelProjectExecutionEnabled
Returns true if parallel project execution is enabled.- Specified by:
isParallelProjectExecutionEnabled
in interfaceParallelismConfiguration
- See Also:
-
setParallelProjectExecutionEnabled
Enables/disables parallel project execution.- Specified by:
setParallelProjectExecutionEnabled
in interfaceParallelismConfiguration
- See Also:
-
isBuildCacheEnabled
Returns true if the build cache is enabled.- Since:
- 3.5
-
setBuildCacheEnabled
Enables/disables the build cache.- Since:
- 3.5
-
isTaskOutputCacheEnabled
Deprecated.Returns true if task output caching is enabled. -
setTaskOutputCacheEnabled
Deprecated.Enables/disables task output caching. -
getMaxWorkerCount
Returns the maximum number of concurrent workers used for underlying build operations. Workers can be threads, processes or whatever Gradle considers a "worker". Some examples:- A thread running a task
- A test process
- A language compiler in a forked process
- Specified by:
getMaxWorkerCount
in interfaceParallelismConfiguration
- Returns:
- maximum number of concurrent workers, always >= 1.
- See Also:
-
setMaxWorkerCount
Specifies the maximum number of concurrent workers used for underlying build operations.- Specified by:
setMaxWorkerCount
in interfaceParallelismConfiguration
- See Also:
-
isConfigureOnDemand
If the configure-on-demand mode is active -
toString
-
setConfigureOnDemand
-
isContinuous
-
setContinuous
-
includeBuild
-
setIncludedBuilds
-
getIncludedBuilds
-
isBuildScan
Returns true if build scan should be created.- Since:
- 3.4
-
setBuildScan
Specifies whether a build scan should be created.- Since:
- 3.4
-
isNoBuildScan
Returns true when build scan creation is explicitly disabled.- Since:
- 3.4
-
setNoBuildScan
Specifies whether build scan creation is explicitly disabled.- Since:
- 3.4
-
isInteractive
Returns true when console is interactive.- Since:
- 4.3
-
setInteractive
Specifies whether console is interactive.- Since:
- 4.3
-
isBuildCacheEnabled()