# ExternalDependency

interface ExternalDependency : ModuleDependency, ModuleVersionSelector

An `ExternalDependency` is a Dependency on a source outside the current project hierarchy.

#### Inheritors

ExternalModuleDependency

## Properties

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

## Functions

addArtifact
Link copied to clipboard
abstract fun addArtifact(artifact: DependencyArtifact): ModuleDependency
Adds an artifact to this dependency.
artifact
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.
attributes
Link copied to clipboard
abstract fun attributes(configureAction: Action<in AttributeContainer>): ModuleDependency
Mutates the attributes of this dependency.
abstract fun attributes(action: Action<in AttributeContainer>): SELF
Configure the attribute container that provides the attributes associated with this domain object.
because
Link copied to clipboard
abstract fun because(@Nullable reason: @Nullable String)
Sets the reason why this dependency should be used.
capabilities
Link copied to clipboard
abstract fun capabilities(configureAction: Action<in ModuleDependencyCapabilitiesHandler>): ModuleDependency
Configures the requested capabilities of this dependency.
copy
Link copied to clipboard
abstract fun copy(): Dependency
Creates and returns a new dependency with the property values of this one.
abstract fun copy(): ExternalDependency
doNotEndorseStrictVersions
Link copied to clipboard
abstract fun doNotEndorseStrictVersions()
Resets the isEndorsingStrictVersions state of this dependency.
endorseStrictVersions
Link copied to clipboard
abstract fun endorseStrictVersions()
Endorse version constraints with getStrictVersion strict versions} from the target module.
exclude
Link copied to clipboard
abstract fun exclude(excludeProperties: Map<String, String>): ModuleDependency
Adds an exclude rule to exclude transitive dependencies of this dependency.
getArtifacts
Link copied to clipboard
abstract fun getArtifacts(): Set<DependencyArtifact>
Returns the artifacts belonging to this dependency.
getAttributes
Link copied to clipboard
abstract fun getAttributes(): AttributeContainer
Returns the attributes for this dependency.
getCapabilitySelectors
Link copied to clipboard
@Incubating
abstract fun getCapabilitySelectors(): Set<CapabilitySelector>
Returns the set of capabilities that are requested for this dependency
getExcludeRules
Link copied to clipboard
abstract fun getExcludeRules(): Set<ExcludeRule>
Returns the exclude rules for this dependency.
getGroup
Link copied to clipboard
abstract fun getGroup(): String
The group of the module.
getModule
Link copied to clipboard
abstract fun getModule(): ModuleIdentifier
The module identifier of the component.
getName
Link copied to clipboard
abstract fun getName(): String
The name of the module.
getReason
Link copied to clipboard
@Nullable
abstract fun getReason(): @Nullable String
Returns a reason why this dependency should be used, in particular with regards to its version.
getRequestedCapabilities
Link copied to clipboard
abstract fun getRequestedCapabilities(): List<Capability>
Returns the explicitly requested capabilities for this dependency.
getTargetConfiguration
Link copied to clipboard
@Nullable
abstract fun getTargetConfiguration(): @Nullable String
Returns the requested target configuration of this dependency.
getVersion
Link copied to clipboard
@Nullable
abstract fun getVersion(): @Nullable String
The version of the module.
getVersionConstraint
Link copied to clipboard
abstract fun getVersionConstraint(): VersionConstraint
Returns the version constraint to be used during selection.
isEndorsingStrictVersions
Link copied to clipboard
abstract fun isEndorsingStrictVersions(): Boolean
Are the getStrictVersion strict version} dependency constraints of the target module endorsed?
isForce
Link copied to clipboard
abstract fun isForce(): Boolean
Returns whether or not the version of this dependency should be enforced in the case of version conflicts.
isTransitive
Link copied to clipboard
abstract fun isTransitive(): Boolean
Returns whether this dependency should be resolved including or excluding its transitive dependencies.
matchesStrictly
Link copied to clipboard
abstract fun matchesStrictly(identifier: ModuleVersionIdentifier): Boolean
To match strictly means that the given identifier needs to have equal group, module name and version.
setTargetConfiguration
Link copied to clipboard
abstract fun setTargetConfiguration(@Nullable name: @Nullable String)
Sets the requested target configuration of this dependency.
setTransitive
Link copied to clipboard
abstract fun setTransitive(transitive: Boolean): ModuleDependency
Sets whether this dependency should be resolved including or excluding its transitive dependencies.
version
Link copied to clipboard
abstract fun version(configureAction: Action<in MutableVersionConstraint>)
Configures the version constraint for this dependency.