org.gradle.api.internal.artifacts.dependencies

Class AbstractModuleDependency

java.lang.Object

org.gradle.api.internal.artifacts.dependencies.AbstractDependency

org.gradle.api.internal.artifacts.dependencies.AbstractModuleDependency

All Implemented Interfaces:

Dependency, ModuleDependency, ResolvableDependency

Direct Known Subclasses:

AbstractExternalDependency, DefaultProjectDependency

public abstract class AbstractModuleDependency
extends AbstractDependency
implements ModuleDependency

Field Summary

Fields inherited from interface org.gradle.api.artifacts.Dependency

ARCHIVES_CONFIGURATION, CLASSIFIER, DEFAULT_CONFIGURATION

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AbstractModuleDependency(String configuration)

Method Summary

Methods

Modifier and Type	Method and Description
AbstractModuleDependency	addArtifact(DependencyArtifact artifact) Adds an artifact to this dependency.
DependencyArtifact	artifact(Closure configureClosure) Adds an artifact to this dependency.
protected void	copyTo(AbstractModuleDependency target)
ModuleDependency	exclude(Map<String,String> excludeProperties) Adds an exclude rule to exclude transitive dependencies of this dependency.
Set<DependencyArtifact>	getArtifacts() Returns the artifacts belonging to this dependency.
String	getConfiguration() Returns the configuration of this dependency module (not the configurations this dependency belongs too).
Set<ExcludeRule>	getExcludeRules() Returns the exclude rules for this dependency.
protected boolean	isCommonContentEquals(ModuleDependency dependencyRhs)
protected boolean	isKeyEquals(ModuleDependency dependencyRhs)
boolean	isTransitive() Returns whether this dependency should be resolved including or excluding its transitive dependencies.
void	setArtifacts(Set<DependencyArtifact> artifacts)
ModuleDependency	setTransitive(boolean transitive) Sets whether this dependency should be resolved including or excluding its transitive dependencies.

Methods inherited from class org.gradle.api.internal.artifacts.dependencies.AbstractDependency

copyTo, hashCode, resolve

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.gradle.api.artifacts.ModuleDependency

copy

Methods inherited from interface org.gradle.api.artifacts.Dependency

contentEquals, getGroup, getName, getVersion

Constructor Detail

AbstractModuleDependency

protected AbstractModuleDependency(String configuration)

Method Detail

isTransitive

public boolean isTransitive()

Description copied from interface: ModuleDependency

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

Specified by:

isTransitive in interface ModuleDependency

See Also:

ModuleDependency.setTransitive(boolean)

setTransitive

public ModuleDependency setTransitive(boolean transitive)

Description copied from interface: ModuleDependency

Sets whether this dependency should be resolved including or excluding its transitive dependencies. The artifacts belonging to this dependency might themselve have dependencies on other artifacts. The latter are called transitive dependencies.

Specified by:

setTransitive in interface ModuleDependency

Parameters:

transitive - Whether transitive dependencies should be resolved.

Returns:

this

getConfiguration

public String getConfiguration()

Description copied from interface: ModuleDependency

Returns the configuration of this dependency module (not the configurations this dependency belongs too). Never returns null. The default value for the configuration is Dependency.DEFAULT_CONFIGURATION. A dependency source might have multiple configurations. Every configuration represents a different set of artifacts and dependencies for this dependency module.

Specified by:

getConfiguration in interface ModuleDependency

exclude

public ModuleDependency exclude(Map<String,String> excludeProperties)

Description copied from interface: ModuleDependency

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

Excluding a particular transitive dependency does not guarantee that it does not show up in the dependencies of a given configuration. For example, some other dependency, which does not have any exclude rules, might pull in exactly the same transitive dependency. To guarantee that the transitive dependency is excluded from the entire configuration please use per-configuration exclude rules: Configuration.getExcludeRules(). In fact, in majority of cases the actual intention of configuring per-dependency exclusions is really excluding a dependency from the entire configuration (or classpath).

If your intention is to exclude a particular transitive dependency because you don't like the version it pulls in to the configuration then consider using forced versions' feature: ResolutionStrategy.force(Object...).

 apply plugin: 'java' //so that I can declare 'compile' dependencies

 dependencies {
   compile('org.hibernate:hibernate:3.1') {
     //excluding a particular transitive dependency:
     exclude module: 'cglib' //by artifact name
     exclude group: 'org.jmock' //by group
     exclude group: 'org.unwanted', module: 'iAmBuggy' //by both name and group
   }
 }

 

Specified by:

exclude in interface ModuleDependency

Parameters:

excludeProperties - the properties to define the exclude rule.

Returns:

this

getExcludeRules

public Set<ExcludeRule> getExcludeRules()

Description copied from interface: ModuleDependency

Returns the exclude rules for this dependency.

Specified by:

getExcludeRules in interface ModuleDependency

See Also:

ModuleDependency.exclude(java.util.Map)

getArtifacts

public Set<DependencyArtifact> getArtifacts()

Description copied from interface: ModuleDependency

Returns the artifacts belonging to this dependency.

Specified by:

getArtifacts in interface ModuleDependency

See Also:

ModuleDependency.addArtifact(DependencyArtifact)

setArtifacts

public void setArtifacts(Set<DependencyArtifact> artifacts)

addArtifact

public AbstractModuleDependency addArtifact(DependencyArtifact artifact)

Description copied from interface: ModuleDependency

Adds an artifact to this dependency.

If no artifact is added to a dependency, an implicit default artifact is used. This default artifact has the same name as the module and its type and extension is jar. If at least one artifact is explicitly added, the implicit default artifact won't be used any longer.

Specified by:

addArtifact in interface ModuleDependency

Returns:

this

artifact

public DependencyArtifact artifact(Closure configureClosure)

Description copied from interface: ModuleDependency

Adds an artifact to this dependency. The given closure is passed a DependencyArtifact instance, which it can configure.

If no artifact is added to a dependency, an implicit default artifact is used. This default artifact has the same name as the module and its type and extension is jar. If at least one artifact is explicitly added, the implicit default artifact won't be used any longer.

Specified by:

artifact in interface ModuleDependency

Returns:

this

copyTo

protected void copyTo(AbstractModuleDependency target)

isKeyEquals

protected boolean isKeyEquals(ModuleDependency dependencyRhs)

isCommonContentEquals

protected boolean isCommonContentEquals(ModuleDependency dependencyRhs)