Package org.gradle.api.artifacts.dsl
Interface Dependencies
- All Known Subinterfaces:
GradleDependencies,JvmComponentDependencies
public interface Dependencies
Universal APIs that are available for all
dependencies blocks.- Since:
- 7.6
- See Also:
- API Note:
- This interface is intended to be used to mix-in DSL methods for
dependenciesblocks. - Implementation Requirements:
- The default implementation of all methods should not be overridden.
- Implementation Note:
- Changes to this interface may require changes to the
extension module for Groovy DSLorextension functions for Kotlin DSL.
-
Method Summary
Modifier and TypeMethodDescriptiondefault DependencyConstraintconstraint(CharSequence dependencyConstraintNotation) Create aDependencyConstraintfrom the given notation.default DependencyConstraintconstraint(ProjectDependency project) Create aDependencyConstraintfrom a project.default Provider<? extends DependencyConstraint>constraint(Provider<? extends MinimalExternalModuleDependency> dependencyConstraint) Create aDependencyConstraintfrom a minimal dependency.default Provider<? extends DependencyConstraint>constraint(ProviderConvertible<? extends MinimalExternalModuleDependency> dependencyConstraint) Create aDependencyConstraintfrom a minimal dependency.A dependency constraint factory is used to convert supported dependency notations intoDependencyConstraintinstances.A dependency factory is used to convert supported dependency notations intoDependencyinstances.Injected service to create named objects.The current project.default ExternalModuleDependencymodule(CharSequence dependencyNotation) Create anExternalModuleDependencyfrom the given notation.default ExternalModuleDependencyCreate anExternalModuleDependencyfrom a series of strings.default ProjectDependencyproject()Returns the current project as aProjectDependency.default ProjectDependencyConverts an absolute or relative path to a project into aProjectDependency.
-
Method Details
-
getDependencyFactory
A dependency factory is used to convert supported dependency notations intoDependencyinstances.- Returns:
- a dependency factory
- See Also:
- Implementation Requirements:
- Do not implement this method. Gradle generates the implementation automatically.
-
getDependencyConstraintFactory
A dependency constraint factory is used to convert supported dependency notations intoDependencyConstraintinstances.- Returns:
- a dependency constraint factory
- See Also:
- Implementation Requirements:
- Do not implement this method. Gradle generates the implementation automatically.
-
getProject
- Returns:
- current project
- Since:
- 8.0
- Implementation Requirements:
- Do not implement this method. Gradle generates the implementation automatically.
-
project
Converts an absolute or relative path to a project into aProjectDependency. Project paths are separated by colons. This method fails if the project cannot be found.- Parameters:
projectPath- an absolute or relative path (from the current project) to a project- Returns:
- a
ProjectDependencyfor the given path - See Also:
-
project
Returns the current project as aProjectDependency.- Returns:
- the current project as a dependency
-
module
Create anExternalModuleDependencyfrom the given notation.- Parameters:
dependencyNotation- dependency to add- Returns:
- the new dependency
- See Also:
-
module
default ExternalModuleDependency module(@Nullable String group, String name, @Nullable String version) Create anExternalModuleDependencyfrom a series of strings.- Parameters:
group- the group (optional)name- the nameversion- the version (optional)- Returns:
- the new dependency
-
constraint
Create aDependencyConstraintfrom the given notation.- Parameters:
dependencyConstraintNotation- dependency constraint to add- Returns:
- the new dependency constraint
- Since:
- 8.7
- See Also:
-
constraint
@Incubating default Provider<? extends DependencyConstraint> constraint(Provider<? extends MinimalExternalModuleDependency> dependencyConstraint) Create aDependencyConstraintfrom a minimal dependency.- Parameters:
dependencyConstraint- dependency constraint to add- Returns:
- the new dependency constraint
- Since:
- 8.7
-
constraint
@Incubating default Provider<? extends DependencyConstraint> constraint(ProviderConvertible<? extends MinimalExternalModuleDependency> dependencyConstraint) Create aDependencyConstraintfrom a minimal dependency.- Parameters:
dependencyConstraint- dependency constraint to add- Returns:
- the new dependency constraint
- Since:
- 8.7
-
constraint
Create aDependencyConstraintfrom a project.- Parameters:
project- the project- Returns:
- the new dependency constraint
- Since:
- 8.7
-
getObjectFactory
Injected service to create named objects.- Returns:
- injected service
- Implementation Requirements:
- Do not implement this method. Gradle generates the implementation automatically.
-