gradle/org.gradle.api.artifacts/ModuleDependency

ModuleDependency

interface ModuleDependency : Dependency, HasConfigurableAttributes<SELF> (source)

A ModuleDependency is a org.gradle.api.artifacts.Dependency on a component that exists outside of the current project.

Modules can supply multiple artifacts in addition to the implicit default artifact. Non-default artifacts available in a module can be selected by a consumer by specifying a classifier or extension when declaring a dependency on that module.

For examples on configuring exclude rules for modules please refer to exclude.

Inheritors

Properties

Link copied to clipboard
val ARCHIVES_CONFIGURATION: String = "archives"
Link copied to clipboard
val CLASSIFIER: String = "m:classifier"
Link copied to clipboard
val DEFAULT_CONFIGURATION: String = "default"

Functions

Link copied to clipboard
abstract fun addArtifact(artifact: DependencyArtifact): ModuleDependency
Adds an artifact to this dependency.
Link copied to clipboard
abstract fun artifact(@DelegatesTo(value = DependencyArtifact::class, strategy = 1) configureClosure: Closure): DependencyArtifact
abstract fun artifact(configureAction: Action<in DependencyArtifact>): DependencyArtifact
Adds an artifact to this dependency.
Link copied to clipboard
abstract fun attributes(configureAction: Action<in AttributeContainer>): ModuleDependency
Mutates the attributes of this dependency.
Link copied to clipboard
abstract fun because(reason: String)
Link copied to clipboard
abstract fun capabilities(configureAction: Action<in ModuleDependencyCapabilitiesHandler>): ModuleDependency
Configures the requested capabilities of this dependency.
Link copied to clipboard
abstract fun contentEquals(dependency: Dependency): Boolean
Link copied to clipboard
abstract fun copy(): ModuleDependency
Link copied to clipboard
abstract fun doNotEndorseStrictVersions()
Resets the isEndorsingStrictVersions state of this dependency.
Link copied to clipboard
abstract fun endorseStrictVersions()
Endorse version constraints with getStrictVersion strict versions} from the target module.
Link copied to clipboard
abstract fun exclude(excludeProperties: Map<String, String>): ModuleDependency
Adds an exclude rule to exclude transitive dependencies of this dependency.
Link copied to clipboard
abstract fun getArtifacts(): Set<DependencyArtifact>
Returns the artifacts belonging to this dependency.
Link copied to clipboard
abstract fun getAttributes(): AttributeContainer
Returns the attributes for this dependency.
Link copied to clipboard
@Incubating
abstract fun getCapabilitySelectors(): Set<CapabilitySelector>
Returns the set of capabilities that are requested for this dependency
Link copied to clipboard
abstract fun getExcludeRules(): Set<ExcludeRule>
Returns the exclude rules for this dependency.
Link copied to clipboard
abstract fun getGroup(): String
Link copied to clipboard
abstract fun getName(): String
Link copied to clipboard
abstract fun getReason(): String
Link copied to clipboard
abstract fun getRequestedCapabilities(): List<Capability>
Returns the explicitly requested capabilities for this dependency.
Link copied to clipboard
@Nullable
abstract fun getTargetConfiguration(): String
Returns the requested target configuration of this dependency.
Link copied to clipboard
abstract fun getVersion(): String
Link copied to clipboard
abstract fun isEndorsingStrictVersions(): Boolean
Are the getStrictVersion strict version} dependency constraints of the target module endorsed?
Link copied to clipboard
abstract fun isTransitive(): Boolean
Returns whether this dependency should be resolved including or excluding its transitive dependencies.
Link copied to clipboard
abstract fun setTargetConfiguration(@Nullable name: String)
Sets the requested target configuration of this dependency.
Link copied to clipboard
abstract fun setTransitive(transitive: Boolean): ModuleDependency
Sets whether this dependency should be resolved including or excluding its transitive dependencies.