Deprecated API

Contents

• Interfaces
• Classes
• Enums
• Exceptions
• Fields
• Methods
• Constructors

Interfaces

Interface	Description
org.gradle.api.artifacts.ArtifactIdentifier	Will be removed in Gradle 9.0.
org.gradle.api.artifacts.ClientModule
org.gradle.api.artifacts.SelfResolvingDependency	Dependencies should not be resolved outside a resolvable configuration. To resolve this dependency, add it to a resolvable configuration and resolve that configuration.
org.gradle.api.execution.TaskActionListener	This type is not supported when configuration caching is enabled.
org.gradle.api.execution.TaskExecutionListener	This type is not supported when configuration caching is enabled.
org.gradle.api.plugins.Convention	Use extensions instead. This is scheduled for removal in Gradle 9.
org.gradle.api.publish.ivy.IvyDependency	This type is not referenced by any other public API classes. It will be removed in Gradle 9.0
org.gradle.api.publish.maven.MavenDependency	This type is not referenced by any other public API classes. It will be removed in Gradle 9.0
org.gradle.api.tasks.GroovySourceSet	Using convention to contribute to source sets is deprecated. You can configure the groovy sources via the GroovySourceDirectorySet extension (e.g. sourceSet.getExtensions().getByType(GroovySourceDirectorySet.class).setSrcDirs(...)). This interface is scheduled for removal in Gradle 9.0.
org.gradle.api.tasks.ScalaSourceSet	Using conventions to contribute source sets is deprecated. You can configure the groovy sources via the ScalaSourceDirectorySet extension (e.g. sourceSet.getExtensions().getByType(ScalaSourceDirectorySet.class).setSrcDirs(...)). This interface is scheduled for removal in Gradle 9.0.
org.gradle.util.VersionNumber.Scheme

Classes

Class	Description
org.gradle.api.artifacts.Configuration.Namer	Use Named.Namer.INSTANCE instead (since Configuration now extends Named).
org.gradle.api.plugins.ApplicationPluginConvention	Use JavaApplication instead. This class is scheduled for removal in Gradle 9.0.
org.gradle.api.plugins.BasePluginConvention	Use BasePluginExtension instead. This class is scheduled for removal in Gradle 9.0.
org.gradle.api.plugins.JavaPluginConvention	Replaced by JavaPluginExtension. This class is scheduled for removal in Gradle 9.0.
org.gradle.api.plugins.ProjectReportsPluginConvention	Please configure the tasks directly. This class is scheduled for removal in Gradle 9.0.
org.gradle.api.plugins.WarPluginConvention	Please configure the tasks directly. This class is scheduled for removal in Gradle 9.0.
org.gradle.api.reporting.components.ComponentReport
org.gradle.api.reporting.dependents.DependentComponentsReport
org.gradle.api.reporting.model.ModelReport
org.gradle.api.Task.Namer	Use Named.Namer.INSTANCE instead (since Task now extends Named).
org.gradle.api.tasks.compile.AbstractOptions	This class will be removed in Gradle 9.0. All classes that extend this class will no longer extend it.
org.gradle.api.tasks.diagnostics.AbstractReportTask	Use AbstractProjectBasedReportTask instead.
org.gradle.api.tasks.diagnostics.ProjectBasedReportTask	Use AbstractProjectBasedReportTask instead.
org.gradle.api.tasks.Upload	This class is scheduled for removal in a future version. To upload artifacts, use the `maven-publish` or `ivy-publish` plugins instead.
org.gradle.plugins.ear.EarPluginConvention	Instead of using conventions, configure the tasks directly. This class is scheduled for removal in Gradle 9.0.
org.gradle.util.ClosureBackedAction	Will be removed in Gradle 9.0.
org.gradle.util.CollectionUtils	Will be removed in Gradle 9.0.
org.gradle.util.CollectionUtils.InjectionStep
org.gradle.util.ConfigureUtil	Will be removed in Gradle 9.0.
org.gradle.util.ConfigureUtil.WrappedConfigureAction
org.gradle.util.DistributionLocator	Will be removed in Gradle 9.0.
org.gradle.util.GFileUtils	Will be removed in Gradle 9.0.
org.gradle.util.GUtil	Will be removed in Gradle 9.0.
org.gradle.util.NameMatcher	Will be removed in Gradle 9.0.
org.gradle.util.NameValidator	Will be removed in Gradle 9.0.
org.gradle.util.RelativePathUtil	Will be removed in Gradle 9.0.
org.gradle.util.SingleMessageLogger	Will be removed in Gradle 9.0.
org.gradle.util.TextUtil	Will be removed in Gradle 9.0.
org.gradle.util.VersionNumber	Will be removed in Gradle 9.0.
org.gradle.util.WrapUtil	Will be removed in Gradle 9.0.

Enums

Enum	Description
org.gradle.workers.IsolationMode

Exceptions

Exceptions	Description
org.gradle.util.ConfigureUtil.IncompleteInputException
org.gradle.util.GFileUtils.TailReadingException

Fields

Field	Description
org.gradle.api.plugins.WarPlugin.WEB_APP_GROUP	This constant scheduled for removal in Gradle 9.0
org.gradle.jvm.toolchain.JvmVendorSpec.IBM_SEMERU	We are grouping all IBM runtimes under the 'IBM' vendor, won't keep a separate constant for Semeru ones. Just use 'IBM' instead.
org.gradle.util.GradleVersion.RESOURCE_NAME	will be removed in Gradle 9.
org.gradle.util.GradleVersion.URL	will be removed in Gradle 9.
org.gradle.util.GradleVersion.VERSION_NUMBER_PROPERTY	will be removed in Gradle 9.
org.gradle.util.GradleVersion.VERSION_OVERRIDE_VAR	will be removed in Gradle 9.

Methods

Method	Description
org.gradle.api.artifacts.component.BuildIdentifier.getName()	Use BuildIdentifier.getBuildPath() instead.
org.gradle.api.artifacts.component.BuildIdentifier.isCurrentBuild()	Compare BuildIdentifier.getBuildPath() with the build path of the current build instead.
org.gradle.api.artifacts.component.ProjectComponentSelector.getBuildName()	Use ProjectComponentSelector.getBuildPath() instead.
org.gradle.api.artifacts.Configuration.fileCollection(Spec<? super Dependency>)	Use getIncoming().artifactView(Action) with a componentFilter instead.
org.gradle.api.artifacts.Configuration.files(Closure)	Use getIncoming().artifactView(Action) with a componentFilter instead.
org.gradle.api.artifacts.Configuration.getAll()
org.gradle.api.artifacts.Configuration.getUploadTaskName()
org.gradle.api.artifacts.Dependency.contentEquals(Dependency)	Use Object.equals(Object) instead.
org.gradle.api.artifacts.dsl.DependencyHandler.module(Object)	Please use component metadata rules instead. This method will be removed in Gradle 9.0.
org.gradle.api.artifacts.dsl.RepositoryHandler.jcenter(Action<? super MavenArtifactRepository>)	JFrog announced JCenter's sunset in February 2021. Use RepositoryHandler.mavenCentral() instead.
org.gradle.api.artifacts.FileCollectionDependency.getBuildDependencies()	This class will no longer implement SelfResolvingDependency in Gradle 9.0.
org.gradle.api.artifacts.FileCollectionDependency.resolve()	This class will no longer implement SelfResolvingDependency in Gradle 9.0. Use FileCollectionDependency.getFiles() instead.
org.gradle.api.artifacts.LenientConfiguration.getArtifacts(Spec<? super Dependency>)	Use a lenient ArtifactView with a componentFilter instead.
org.gradle.api.artifacts.LenientConfiguration.getFiles()	Use a lenient ArtifactView instead.
org.gradle.api.artifacts.LenientConfiguration.getFirstLevelModuleDependencies(Spec<? super Dependency>)	Use LenientConfiguration.getFirstLevelModuleDependencies().
org.gradle.api.artifacts.ProjectDependency.getBuildDependencies()	This class will no longer implement SelfResolvingDependency in Gradle 9.0
org.gradle.api.artifacts.ProjectDependency.getDependencyProject()	This method will be removed in Gradle 9.0. Accessing the mutable state of other projects should be avoided.
org.gradle.api.artifacts.ProjectDependency.resolve()	This class will no longer implement SelfResolvingDependency in Gradle 9.0
org.gradle.api.artifacts.ResolvedConfiguration.getFiles()	Use ResolvableDependencies.getFiles() instead.
org.gradle.api.artifacts.ResolvedConfiguration.getFirstLevelModuleDependencies(Spec<? super Dependency>)	Use ResolvedConfiguration.getFirstLevelModuleDependencies().
org.gradle.api.artifacts.SelfResolvingDependency.resolve()
org.gradle.api.execution.TaskExecutionGraph.addTaskExecutionListener(TaskExecutionListener)	This method is not supported when configuration caching is enabled.
org.gradle.api.execution.TaskExecutionGraph.afterTask(Closure)	This method is not supported when configuration caching is enabled.
org.gradle.api.execution.TaskExecutionGraph.beforeTask(Closure)	This method is not supported when configuration caching is enabled.
org.gradle.api.execution.TaskExecutionGraph.removeTaskExecutionListener(TaskExecutionListener)	This method is not supported when configuration caching is enabled.
org.gradle.api.file.CopyProcessingSpec.getDirMode()	Use CopyProcessingSpec.getDirPermissions() instead. This method is scheduled for removal in Gradle 9.0.
org.gradle.api.file.CopyProcessingSpec.getFileMode()	Use CopyProcessingSpec.getFilePermissions() instead. This method is scheduled for removal in Gradle 9.0.
org.gradle.api.file.CopyProcessingSpec.setDirMode(Integer)	Use CopyProcessingSpec.dirPermissions(Action) instead. This method is scheduled for removal in Gradle 9.0.
org.gradle.api.file.CopyProcessingSpec.setFileMode(Integer)	Use CopyProcessingSpec.filePermissions(Action) instead. This method is scheduled for removal in Gradle 9.0.
org.gradle.api.file.FileCopyDetails.setMode(int)	Use FileCopyDetails.permissions(Action) instead. This method is scheduled for removal in Gradle 9.0.
org.gradle.api.file.FileTreeElement.getMode()	Use FileTreeElement.getPermissions() instead. This method is scheduled for removal in Gradle 9.0.
org.gradle.api.invocation.Gradle.buildFinished(Closure)	This method is not supported when configuration caching is enabled.
org.gradle.api.invocation.Gradle.useLogger(Object)	Will be removed in Gradle 9. Logging customization through listeners is no longer supported.
org.gradle.api.plugins.BasePluginExtension.getArchivesBaseName()	Use BasePluginExtension.getArchivesName(). This method is scheduled for removal in Gradle 9.0.
org.gradle.api.plugins.BasePluginExtension.getDistsDirName()	Use BasePluginExtension.getDistsDirectory(). This method is scheduled for removal in Gradle 9.0.
org.gradle.api.plugins.BasePluginExtension.getLibsDirName()	Use BasePluginExtension.getLibsDirectory(). This method is scheduled for removal in Gradle 9.0.
org.gradle.api.plugins.BasePluginExtension.setArchivesBaseName(String)	Use BasePluginExtension.getArchivesName(). This method is scheduled for removal in Gradle 9.0.
org.gradle.api.plugins.BasePluginExtension.setDistsDirName(String)	Use BasePluginExtension.getDistsDirectory(). This method is scheduled for removal in Gradle 9.0.
org.gradle.api.plugins.BasePluginExtension.setLibsDirName(String)	Use BasePluginExtension.getLibsDirectory(). This method is scheduled for removal in Gradle 9.0.
org.gradle.api.plugins.Convention.findPlugin(Class<T>)	Use extensions instead. This is scheduled for removal in Gradle 9.
org.gradle.api.plugins.Convention.getPlugin(Class<T>)	Use extensions instead. This is scheduled for removal in Gradle 9.
org.gradle.api.plugins.Convention.getPlugins()	Use extensions instead. This is scheduled for removal in Gradle 9.
org.gradle.api.plugins.PluginCollection.add(T)	Use PluginManager.apply(Class) instead.
org.gradle.api.plugins.PluginCollection.addAll(Collection<? extends T>)	Use PluginManager.apply(Class) instead.
org.gradle.api.plugins.PluginCollection.clear()	plugins cannot be removed.
org.gradle.api.plugins.PluginCollection.remove(Object)	plugins cannot be removed.
org.gradle.api.plugins.PluginCollection.removeAll(Collection<?>)	plugins cannot be removed.
org.gradle.api.plugins.WarPlugin.configureConfigurations(ConfigurationContainer)	This method will be removed in Gradle 9.0.
org.gradle.api.Project.exec(Closure)	Since 8.11. This method will be removed in Gradle 9.0. Use ExecOperations.exec(Action) or ProviderFactory.exec(Action) instead.
org.gradle.api.Project.getBuildDir()	Use getLayout().getBuildDirectory() instead
org.gradle.api.Project.getConvention()	The concept of conventions is deprecated. Use extensions if possible.
org.gradle.api.Project.javaexec(Closure)	Since 8.11. This method will be removed in Gradle 9.0. Use ExecOperations.javaexec(Action) or ProviderFactory.javaexec(Action) instead.
org.gradle.api.Project.setBuildDir(File)	Use getLayout().getBuildDirectory() and set the DirectoryProperty
org.gradle.api.provider.Provider.forUseAtConfigurationTime()	Since version 7.4 this method does nothing. All providers can be used at configuration time without explicit opt-in.
org.gradle.api.publish.maven.tasks.GenerateMavenPom.getVersionRangeMapper()	This method will be removed in Gradle 9.0
org.gradle.api.publish.maven.tasks.GenerateMavenPom.withCompileScopeAttributes(ImmutableAttributes)	This method will be removed in Gradle 9.0.
org.gradle.api.publish.maven.tasks.GenerateMavenPom.withRuntimeScopeAttributes(ImmutableAttributes)	This method will be removed in Gradle 9.0.
org.gradle.api.reporting.ConfigurableReport.setDestination(File)	Use Report.getOutputLocation().set() instead. This method will be removed in Gradle 9.0.
org.gradle.api.reporting.GenerateBuildDashboard.getCollectionCallbackActionDecorator()
org.gradle.api.reporting.GenerateBuildDashboard.getInstantiator()
org.gradle.api.Script.exec(Closure)	Since 8.11. This method will be removed in Gradle 9.0. Use ExecOperations.exec(Action) or ProviderFactory.exec(Action) instead.
org.gradle.api.Script.javaexec(Closure)	Since 8.11. This method will be removed in Gradle 9.0. Use ExecOperations.javaexec(Action) or ProviderFactory.javaexec(Action) instead.
org.gradle.api.Task.getConvention()	The concept of conventions is deprecated. Use extensions if possible.
org.gradle.api.tasks.AbstractCopyTask.getDirMode()
org.gradle.api.tasks.AbstractCopyTask.getFileMode()
org.gradle.api.tasks.AbstractCopyTask.setDirMode(Integer)
org.gradle.api.tasks.AbstractCopyTask.setFileMode(Integer)
org.gradle.api.tasks.bundling.AbstractArchiveTask.getArchivePath()	Use AbstractArchiveTask.getArchiveFile()
org.gradle.api.tasks.compile.AbstractCompile.getDestinationDir()	Use AbstractCompile.getDestinationDirectory() instead. This method will be removed in Gradle 9.0.
org.gradle.api.tasks.compile.AbstractCompile.setDestinationDir(File)	Use AbstractCompile.getDestinationDirectory().set() instead. This method will be removed in Gradle 9.0.
org.gradle.api.tasks.compile.AbstractOptions.define(Map<String, Object>)	This method will be removed in Gradle 9.0
org.gradle.api.tasks.compile.CompileOptions.debug(Map<String, Object>)	This method will be removed in Gradle 9.0
org.gradle.api.tasks.compile.CompileOptions.fork(Map<String, Object>)	This method will be removed in Gradle 9.0
org.gradle.api.tasks.compile.CompileOptions.getAnnotationProcessorGeneratedSourcesDirectory()	Use CompileOptions.getGeneratedSourceOutputDirectory() instead. This method will be removed in Gradle 9.0.
org.gradle.api.tasks.compile.CompileOptions.setAnnotationProcessorGeneratedSourcesDirectory(File)	Use CompileOptions.getGeneratedSourceOutputDirectory().set() instead. This method will be removed in Gradle 9.0.
org.gradle.api.tasks.compile.CompileOptions.setDebugOptions(DebugOptions)	Setting a new instance of this property is unnecessary. This method will be removed in Gradle 9.0. Use CompileOptions.debugOptions(Action) instead.
org.gradle.api.tasks.compile.CompileOptions.setForkOptions(ForkOptions)	Setting a new instance of this property is unnecessary. This method will be removed in Gradle 9.0. Use CompileOptions.forkOptions(Action) instead.
org.gradle.api.tasks.compile.ForkOptions.getJavaHome()
org.gradle.api.tasks.compile.ForkOptions.setJavaHome(File)
org.gradle.api.tasks.compile.GroovyCompileOptions.fork(Map<String, Object>)	This method will be removed in Gradle 9.0
org.gradle.api.tasks.compile.GroovyCompileOptions.setForkOptions(GroovyForkOptions)	Setting a new instance of this property is unnecessary. This method will be removed in Gradle 9.0. Use GroovyCompileOptions.forkOptions(Action) instead.
org.gradle.api.tasks.GradleBuild.getBuildFile()	Use GradleBuild.getDir() instead to get the root of the nested build. This method will be removed in Gradle 9.0.
org.gradle.api.tasks.GradleBuild.setBuildFile(File)	Use GradleBuild.setDir(File) instead to set the root of the nested build. This method will be removed in Gradle 9.0.
org.gradle.api.tasks.javadoc.Javadoc.isVerbose()	This method duplicates the functionality of getOptions().isVerbose(). It will be removed in Gradle 9.0.
org.gradle.api.tasks.javadoc.Javadoc.setVerbose(boolean)	This method duplicates the functionality of getOptions().verbose(). It will be removed in Gradle 9.0.
org.gradle.api.tasks.scala.ScalaDoc.setScalaDocOptions(ScalaDocOptions)	Setting a new instance of this property is unnecessary. This method will be removed in Gradle 9.0. Use ScalaDoc.scalaDocOptions(Action) instead.
org.gradle.api.tasks.testing.Test.setForkEvery(Long)	Use Test.setForkEvery(long) instead.
org.gradle.api.tasks.testing.TestReport.getDestinationDir()
org.gradle.api.tasks.testing.TestReport.reportOn(Object...)
org.gradle.api.tasks.testing.TestReport.setDestinationDir(File)
org.gradle.api.tasks.Upload.getArtifacts()	This class is scheduled for removal in a future version, this method should not be used.
org.gradle.api.tasks.Upload.getConfiguration()	This class is scheduled for removal in a future version, this method should not be used.
org.gradle.api.tasks.Upload.getDescriptorDestination()	This class is scheduled for removal in a future version, this method should not be used.
org.gradle.api.tasks.Upload.getDocumentationRegistry()	This class is scheduled for removal in a future version, this method should not be used.
org.gradle.api.tasks.Upload.getRepositories()	This class is scheduled for removal in a future version, this method should not be used.
org.gradle.api.tasks.Upload.isUploadDescriptor()	This class is scheduled for removal in a future version, this method should not be used.
org.gradle.api.tasks.Upload.repositories(Closure)	This class is scheduled for removal in a future version, this method should not be used.
org.gradle.api.tasks.Upload.setConfiguration(Configuration)	This class is scheduled for removal in a future version, this method should not be used.
org.gradle.api.tasks.Upload.setDescriptorDestination(File)	This class is scheduled for removal in a future version, this method should not be used.
org.gradle.api.tasks.Upload.setUploadDescriptor(boolean)	This class is scheduled for removal in a future version, this method should not be used.
org.gradle.api.tasks.WriteProperties.getOutputFile()
org.gradle.api.tasks.WriteProperties.setOutputFile(File)	Use WriteProperties.getDestinationFile() instead.
org.gradle.BuildAdapter.buildFinished(BuildResult)
org.gradle.BuildListener.buildFinished(BuildResult)	This method is not supported when configuration caching is enabled.
org.gradle.caching.BuildCacheKey.getDisplayName()	Use BuildCacheKey.getHashCode() instead.
org.gradle.caching.local.DirectoryBuildCache.getRemoveUnusedEntriesAfterDays()
org.gradle.caching.local.DirectoryBuildCache.setRemoveUnusedEntriesAfterDays(int)
org.gradle.jvm.application.tasks.CreateStartScripts.getMainClassName()
org.gradle.jvm.application.tasks.CreateStartScripts.setMainClassName(String)
org.gradle.language.scala.tasks.BaseScalaCompileOptions.setForkOptions(ScalaForkOptions)	Setting a new instance of this property is unnecessary. This method will be removed in Gradle 9.0. Use BaseScalaCompileOptions.forkOptions(Action) instead.
org.gradle.language.scala.tasks.BaseScalaCompileOptions.setIncrementalOptions(IncrementalCompileOptions)	Setting a new instance of this property is unnecessary. This method will be removed in Gradle 9.0. Use BaseScalaCompileOptions.incrementalOptions(Action) instead.
org.gradle.plugins.ide.idea.model.IdeaModule.getTestResourceDirs()
org.gradle.plugins.ide.idea.model.IdeaModule.getTestSourceDirs()
org.gradle.plugins.ide.idea.model.IdeaModule.setTestResourceDirs(Set<File>)
org.gradle.plugins.ide.idea.model.IdeaModule.setTestSourceDirs(Set<File>)
org.gradle.process.JavaExecSpec.setMain(String)	Use JavaExecSpec.getMainClass().set(main) instead. This method will be removed in Gradle 9.0.
org.gradle.StartParameter.getBuildFile()	Setting custom build file to select the default project has been deprecated. This method will be removed in Gradle 9.0.
org.gradle.StartParameter.getSettingsFile()	Setting custom build file to select the default project has been deprecated. This method will be removed in Gradle 9.0.
org.gradle.StartParameter.isConfigurationCacheRequested()	Use Configuration Cache build feature instead.
org.gradle.StartParameter.setBuildFile(File)	Setting custom build file to select the default project has been deprecated. Please use StartParameter.setProjectDir(File) to specify the directory of the default project instead. This method will be removed in Gradle 9.0.
org.gradle.StartParameter.setSettingsFile(File)	Setting custom settings file for the build has been deprecated. Please use StartParameter.setProjectDir(File) to specify the directory of the default project instead. This method will be removed in Gradle 9.0.
org.gradle.util.GradleVersion.getBuildTime()	will be removed in Gradle 9.
org.gradle.util.GradleVersion.getNextMajor()	will be removed in Gradle 9.
org.gradle.util.GradleVersion.getRevision()	will be removed in Gradle 9.
org.gradle.util.GradleVersion.isValid()	will be removed in Gradle 9.
org.gradle.util.GUtil.addToCollection(T, boolean, Iterable<? extends V>...)

Constructors

Constructor	Description
org.gradle.api.artifacts.ResolveException(String, Throwable)	This constructor will be removed in 9.0