Package org.gradle

Class StartParameter

    • Field Detail

      • GRADLE_USER_HOME_PROPERTY_KEY

        public static final java.lang.String GRADLE_USER_HOME_PROPERTY_KEY
        See Also:
        Constant Field Values

      • DEFAULT_GRADLE_USER_HOME

        public static final java.io.File DEFAULT_GRADLE_USER_HOME
        The default user home directory.

      • gradleHomeDir

        protected java.io.File gradleHomeDir

    • Constructor Detail

      • StartParameter

        public StartParameter()
        Creates a StartParameter with default values. This is roughly equivalent to running Gradle on the command-line with no arguments.

      • StartParameter

        protected StartParameter​(org.gradle.initialization.BuildLayoutParameters layoutParameters)
        Creates a StartParameter initialized from the given BuildLayoutParameters.
        Since:
        7.0

    • Method Detail

      • setLogLevel

        public void setLogLevel​(LogLevel logLevel)
        Specifies the minimum logging level to use. All log messages with a lower log level are ignored.
        Specified by:
        setLogLevel in interface LoggingConfiguration

      • setProjectCacheDir

        public void setProjectCacheDir​(@Nullable
                               java.io.File projectCacheDir)
        Sets the project's cache location. Set to null to use the default location.

      • getProjectCacheDir

        @Nullable
public java.io.File getProjectCacheDir()
        Returns the project's cache dir.

        Note that this directory is managed by Gradle, and it assumes full ownership of its contents. Plugins and build logic should not store or modify any files or directories within this cache directory.

        Returns:
        project's cache dir, or null if the default location is to be used.

      • newInstance

        public StartParameter newInstance()
        Duplicates this StartParameter instance.
        Returns:
        the new parameters.

      • newBuild

        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).

        Returns:
        The new parameters.

      • equals

        public boolean equals​(java.lang.Object obj)
        Overrides:
        equals in class java.lang.Object

      • hashCode

        public int hashCode()
        Overrides:
        hashCode in class java.lang.Object

      • getBuildFile

        @Deprecated
@Nullable
public java.io.File getBuildFile()
        Deprecated.
        Setting custom build file to select the default project has been deprecated. This method will be removed in Gradle 9.0.
        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

        @Deprecated
public void setBuildFile​(@Nullable
                         java.io.File buildFile)
        Deprecated.
        Setting custom build file to select the default project has been deprecated. Please use setProjectDir(File) to specify the directory of the default project instead. This method will be removed in Gradle 9.0.
        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.

      • getTaskNames

        public java.util.List<java.lang.String> getTaskNames()
        Returns the names of the tasks to execute in this build. When empty, the default tasks for the project will be executed. If TaskExecutionRequests 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

        public void setTaskNames​(@Nullable
                         java.lang.Iterable<java.lang.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.

        Parameters:
        taskNames - the names of the tasks to execute in this build.

      • getTaskRequests

        public java.util.List<TaskExecutionRequest> 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

        public void setTaskRequests​(java.lang.Iterable<? extends TaskExecutionRequest> taskParameters)

        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

        public java.util.Set<java.lang.String> 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

        public void setExcludedTaskNames​(java.lang.Iterable<java.lang.String> excludedTaskNames)
        Sets the tasks to exclude from this build.
        Parameters:
        excludedTaskNames - The task names.

      • getCurrentDir

        public java.io.File 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

        public void setCurrentDir​(@Nullable
                          java.io.File currentDir)
        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.

      • getProjectProperties

        public java.util.Map<java.lang.String,​java.lang.String> getProjectProperties()

      • setProjectProperties

        public void setProjectProperties​(java.util.Map<java.lang.String,​java.lang.String> projectProperties)

      • getSystemPropertiesArgs

        public java.util.Map<java.lang.String,​java.lang.String> getSystemPropertiesArgs()

      • setSystemPropertiesArgs

        public void setSystemPropertiesArgs​(java.util.Map<java.lang.String,​java.lang.String> systemPropertiesArgs)

      • getGradleUserHomeDir

        public java.io.File getGradleUserHomeDir()
        Returns the directory to use as the user home directory.
        Returns:
        The home directory.

      • setGradleUserHomeDir

        public void setGradleUserHomeDir​(@Nullable
                                 java.io.File gradleUserHomeDir)
        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

        public StartParameter setBuildProjectDependencies​(boolean build)
        Specifies whether project dependencies should be built. Defaults to true.
        Returns:
        this

      • isDryRun

        public boolean isDryRun()

      • setDryRun

        public void setDryRun​(boolean dryRun)

      • setSettingsFile

        @Deprecated
public void setSettingsFile​(@Nullable
                            java.io.File settingsFile)
        Deprecated.
        Setting custom settings file for the build has been deprecated. Please use setProjectDir(File) to specify the directory of the default project instead. This method will be removed in Gradle 9.0.
        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

        @Deprecated
@Nullable
public java.io.File getSettingsFile()
        Deprecated.
        Setting custom build file to select the default project has been deprecated. This method will be removed in Gradle 9.0.
        Returns the explicit settings file to use for the build, or null. Will return null if the default settings file is to be used.
        Returns:
        The settings file. May be null.

      • addInitScript

        public void addInitScript​(java.io.File initScriptFile)
        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

        public void setInitScripts​(java.util.List<java.io.File> initScripts)
        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

        public java.util.List<java.io.File> 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

        public java.util.List<java.io.File> 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

        public void setProjectDir​(@Nullable
                          java.io.File projectDir)
        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

        @Nullable
public java.io.File 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.

      • isBuildCacheEnabled

        public boolean isBuildCacheEnabled()
        Returns true if the build cache is enabled.
        Since:
        3.5

      • setBuildCacheEnabled

        public void setBuildCacheEnabled​(boolean buildCacheEnabled)
        Enables/disables the build cache.
        Since:
        3.5

      • isBuildCacheDebugLogging

        public boolean isBuildCacheDebugLogging()
        Whether build cache debug logging is enabled.
        Since:
        4.6

      • setBuildCacheDebugLogging

        public void setBuildCacheDebugLogging​(boolean buildCacheDebugLogging)
        Whether build cache debug logging is enabled.
        Since:
        4.6

      • getMaxWorkerCount

        public int 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
        Defaults to the number of processors available to the Java virtual machine.
        Specified by:
        getMaxWorkerCount in interface ParallelismConfiguration
        Returns:
        maximum number of concurrent workers, always >= 1.
        See Also:
        Runtime.availableProcessors()

      • isConfigureOnDemand

        @Incubating
public boolean isConfigureOnDemand()
        If the configure-on-demand mode is active

      • toString

        public java.lang.String toString()
        Overrides:
        toString in class java.lang.Object

      • setConfigureOnDemand

        @Incubating
public void setConfigureOnDemand​(boolean configureOnDemand)

      • isContinuous

        public boolean isContinuous()

      • setContinuous

        public void setContinuous​(boolean enabled)

      • includeBuild

        public void includeBuild​(java.io.File includedBuild)

      • setIncludedBuilds

        public void setIncludedBuilds​(java.util.List<java.io.File> includedBuilds)

      • getIncludedBuilds

        public java.util.List<java.io.File> getIncludedBuilds()

      • isBuildScan

        public boolean isBuildScan()
        Returns true if build scan should be created.
        Since:
        3.4

      • setBuildScan

        public void setBuildScan​(boolean buildScan)
        Specifies whether a build scan should be created.
        Since:
        3.4

      • isNoBuildScan

        public boolean isNoBuildScan()
        Returns true when build scan creation is explicitly disabled.
        Since:
        3.4

      • setNoBuildScan

        public void setNoBuildScan​(boolean noBuildScan)
        Specifies whether build scan creation is explicitly disabled.
        Since:
        3.4

      • setWriteDependencyLocks

        public void setWriteDependencyLocks​(boolean writeDependencyLocks)
        Specifies whether dependency resolution needs to be persisted for locking
        Since:
        4.8

      • isWriteDependencyLocks

        public boolean isWriteDependencyLocks()
        Returns true when dependency resolution is to be persisted for locking
        Since:
        4.8

      • setLockedDependenciesToUpdate

        public void setLockedDependenciesToUpdate​(java.util.List<java.lang.String> lockedDependenciesToUpdate)
        Indicates that specified dependencies are to be allowed to update their version. Implicitly activates dependency locking persistence.
        Parameters:
        lockedDependenciesToUpdate - the modules to update
        Since:
        4.8
        See Also:
        isWriteDependencyLocks()

      • getWriteDependencyVerifications

        public java.util.List<java.lang.String> getWriteDependencyVerifications()
        Indicates if a dependency verification metadata file should be written at the end of this build. If the list is not empty, then it means we need to generate or update the dependency verification file with the checksums specified in the list.
        Since:
        6.1

      • setWriteDependencyVerifications

        public void setWriteDependencyVerifications​(java.util.List<java.lang.String> checksums)
        Tells if a dependency verification metadata file should be written at the end of this build.
        Parameters:
        checksums - the list of checksums to generate
        Since:
        6.1

      • getLockedDependenciesToUpdate

        public java.util.List<java.lang.String> getLockedDependenciesToUpdate()
        Returns the list of modules that are to be allowed to update their version compared to the lockfile.
        Returns:
        a list of modules allowed to have a version update
        Since:
        4.8

      • setDependencyVerificationMode

        public void setDependencyVerificationMode​(DependencyVerificationMode verificationMode)
        Sets the dependency verification mode. There are three different modes:
        • strict, the default, verification is enabled as soon as a dependency verification file is present.
        • lenient, in this mode, failure to verify a checksum, missing checksums or signatures will be logged but will not fail the build. This mode should only be used when updating dependencies as it is inherently unsafe.
        • off, this mode disables all verifications
        Parameters:
        verificationMode - the verification mode to use
        Since:
        6.2

      • getDependencyVerificationMode

        public DependencyVerificationMode getDependencyVerificationMode()
        Returns the dependency verification mode.
        Since:
        6.2

      • setRefreshKeys

        public void setRefreshKeys​(boolean refresh)
        Sets the key refresh flag.
        Parameters:
        refresh - If set to true, missing keys will be checked again. By default missing keys are cached for 24 hours.
        Since:
        6.2

      • isRefreshKeys

        public boolean isRefreshKeys()
        If true, Gradle will try to download missing keys again.
        Since:
        6.2

      • isExportKeys

        public boolean isExportKeys()
        If true, after writing the dependency verification file, a public keyring file will be generated with all keys seen during generation of the file. This file can then be used as a source for public keys instead of reaching out public key servers.
        Returns:
        true if keys should be exported
        Since:
        6.2

      • setExportKeys

        public void setExportKeys​(boolean exportKeys)
        If true, after writing the dependency verification file, a public keyring file will be generated with all keys seen during generation of the file. This file can then be used as a source for public keys instead of reaching out public key servers.
        Parameters:
        exportKeys - set to true if keys should be exported
        Since:
        6.2

      • setWelcomeMessageConfiguration

        @Incubating
public void setWelcomeMessageConfiguration​(WelcomeMessageConfiguration welcomeMessageConfiguration)
        Updates when to display a welcome message on the command line.
        Parameters:
        welcomeMessageConfiguration - The welcome message configuration.
        Since:
        7.5
        See Also:
        WelcomeMessageDisplayMode

      • isConfigurationCacheRequested

        @Incubating
@Deprecated
public boolean isConfigurationCacheRequested()
        Deprecated.
        Use Configuration Cache build feature instead.
        Returns true if configuration caching has been requested. Note that the configuration cache may not necessarily be used even when requested, for example it may be disabled due to the presence of configuration cache problems. It is also currently not used during an IDE import/sync.
        Since:
        7.6