gradle/org.gradle.api.artifacts/ProjectDependency

ProjectDependency

interface ProjectDependency : ModuleDependency(source)

A ProjectDependency is a Dependency on another project in the current project hierarchy.

Properties

ARCHIVES_CONFIGURATION

val ARCHIVES_CONFIGURATION: String = "archives"

CLASSIFIER

val CLASSIFIER: String = "m:classifier"

DEFAULT_CONFIGURATION

val DEFAULT_CONFIGURATION: String = "default"

Functions

addArtifact

abstract fun addArtifact(artifact: DependencyArtifact): ModuleDependency

Adds an artifact to this dependency.

artifact

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

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

abstract fun because(@Nullable reason: @Nullable String)

Sets the reason why this dependency should be used.

capabilities

abstract fun capabilities(configureAction: Action<in ModuleDependencyCapabilitiesHandler>): ModuleDependency

Configures the requested capabilities of this dependency.

copy

abstract fun copy(): Dependency

Creates and returns a new dependency with the property values of this one.

abstract fun copy(): ProjectDependency

doNotEndorseStrictVersions

abstract fun doNotEndorseStrictVersions()

Resets the isEndorsingStrictVersions state of this dependency.

endorseStrictVersions

abstract fun endorseStrictVersions()

Endorse version constraints with getStrictVersion strict versions} from the target module.

exclude

abstract fun exclude(excludeProperties: Map<String, String>): ModuleDependency

Adds an exclude rule to exclude transitive dependencies of this dependency.

getArtifacts

abstract fun getArtifacts(): Set<DependencyArtifact>

Returns the artifacts belonging to this dependency.

getAttributes

abstract fun getAttributes(): AttributeContainer

Returns the attributes for this dependency.

getCapabilitySelectors

@Incubating

abstract fun getCapabilitySelectors(): Set<CapabilitySelector>

Returns the set of capabilities that are requested for this dependency

getExcludeRules

abstract fun getExcludeRules(): Set<ExcludeRule>

Returns the exclude rules for this dependency.

getGroup

@Nullable

abstract fun getGroup(): @Nullable String

Returns the group of this dependency.

getName

abstract fun getName(): String

Returns the name of this dependency.

getPath

abstract fun getPath(): String

Get the path to the project that this dependency refers to relative to its owning build.

getReason

@Nullable

abstract fun getReason(): @Nullable String

Returns a reason why this dependency should be used, in particular with regards to its version.

getRequestedCapabilities

abstract fun getRequestedCapabilities(): List<Capability>

Returns the explicitly requested capabilities for this dependency.

getTargetConfiguration

@Nullable

abstract fun getTargetConfiguration(): @Nullable String

Returns the requested target configuration of this dependency.

getVersion

@Nullable

abstract fun getVersion(): @Nullable String

Returns the version of this dependency.

isEndorsingStrictVersions

abstract fun isEndorsingStrictVersions(): Boolean

Are the getStrictVersion strict version} dependency constraints of the target module endorsed?

isTransitive

abstract fun isTransitive(): Boolean

Returns whether this dependency should be resolved including or excluding its transitive dependencies.

setTargetConfiguration

abstract fun setTargetConfiguration(@Nullable name: @Nullable String)

Sets the requested target configuration of this dependency.

setTransitive

abstract fun setTransitive(transitive: Boolean): ModuleDependency

Sets whether this dependency should be resolved including or excluding its transitive dependencies.