org.gradle.api.internal.artifacts.dependencies

Class DefaultProjectDependency

java.lang.Object

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

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

org.gradle.api.internal.artifacts.dependencies.DefaultProjectDependency

All Implemented Interfaces:

Dependency, ModuleDependency, ProjectDependency, SelfResolvingDependency, Buildable, ResolvableDependency

public class DefaultProjectDependency
extends AbstractModuleDependency
implements ProjectDependency

Author:

Hans Dockter

Field Summary

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

ARCHIVES_CONFIGURATION, CLASSIFIER, DEFAULT_CONFIGURATION

Constructor Summary

Constructors

Constructor and Description
DefaultProjectDependency(ProjectInternal dependencyProject, ProjectDependenciesBuildInstruction instruction)
DefaultProjectDependency(ProjectInternal dependencyProject, String configuration, ProjectDependenciesBuildInstruction instruction)

Method Summary

Methods

Modifier and Type	Method and Description
boolean	contentEquals(Dependency dependency) Returns whether two dependencies have identical values for their properties.
ProjectDependency	copy() Creates and returns a new dependency with the property values of this one.
boolean	equals(Object o)
TaskDependency	getBuildDependencies() Returns a dependency which contains the tasks which build this artifact.
Project	getDependencyProject() Returns the project associated with this project dependency.
String	getGroup() Returns the group of this dependency.
String	getName() Returns the name of this dependency.
Configuration	getProjectConfiguration() Returns the configuration associated with this project dependency.
String	getVersion() Returns the version of this dependency.
int	hashCode()
Set<File>	resolve() Resolves this dependency.
Set<File>	resolve(boolean transitive) Resolves this dependency by specifying the transitive mode.
void	resolve(DependencyResolveContext context)
String	toString()

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

addArtifact, artifact, copyTo, exclude, getArtifacts, getConfiguration, getExcludeRules, isCommonContentEquals, isKeyEquals, isTransitive, setArtifacts, setTransitive

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

copyTo

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

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

addArtifact, artifact, exclude, getArtifacts, getConfiguration, getExcludeRules, isTransitive, setTransitive

Constructor Detail

DefaultProjectDependency

public DefaultProjectDependency(ProjectInternal dependencyProject,
                        ProjectDependenciesBuildInstruction instruction)

DefaultProjectDependency

public DefaultProjectDependency(ProjectInternal dependencyProject,
                        String configuration,
                        ProjectDependenciesBuildInstruction instruction)

Method Detail

getDependencyProject

public Project getDependencyProject()

Description copied from interface: ProjectDependency

Returns the project associated with this project dependency.

Specified by:

getDependencyProject in interface ProjectDependency

getGroup

public String getGroup()

Description copied from interface: Dependency

Returns the group of this dependency. The group is often required to find the artifacts of a dependency in a repository. For example, the group name corresponds to a directory name in a Maven like repository. Might return null.

Specified by:

getGroup in interface Dependency

getName

public String getName()

Description copied from interface: Dependency

Returns the name of this dependency. The name is almost always required to find the artifacts of a dependency in a repository. Never returns null.

Specified by:

getName in interface Dependency

getVersion

public String getVersion()

Description copied from interface: Dependency

Returns the version of this dependency. The version is often required to find the artifacts of a dependency in a repository. For example the version name corresponds to a directory name in a Maven like repository. Might return null.

Specified by:

getVersion in interface Dependency

getProjectConfiguration

public Configuration getProjectConfiguration()

Description copied from interface: ProjectDependency

Returns the configuration associated with this project dependency. The configuration belongs to the project associated with this project dependency.

Specified by:

getProjectConfiguration in interface ProjectDependency

See Also:

ProjectDependency.getDependencyProject()

copy

public ProjectDependency copy()

Description copied from interface: ProjectDependency

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

Specified by:

copy in interface Dependency

Specified by:

copy in interface ModuleDependency

Specified by:

copy in interface ProjectDependency

Returns:

The copy. Never returns null.

resolve

public Set<File> resolve()

Description copied from interface: SelfResolvingDependency

Resolves this dependency. A ProjectDependency is resolved with transitive equals true by this method.

Specified by:

resolve in interface SelfResolvingDependency

Returns:

The files which make up this dependency.

See Also:

SelfResolvingDependency.resolve(boolean)

resolve

public Set<File> resolve(boolean transitive)

Description copied from interface: SelfResolvingDependency

Resolves this dependency by specifying the transitive mode. This mode has only an effect if the self resolved dependency is of type ProjectDependency. In this case, if transitive is false, only the self resolving dependencies of the project configuration which are no project dependencies are resolved. If transitive is set to true, other project dependencies belonging to the configuration of the resolved project dependency are resolved recursively.

Specified by:

resolve in interface SelfResolvingDependency

Parameters:

transitive - Whether to resolve transitively. Has only an effect on a ProjectDependency

Returns:

The files which make up this dependency.

resolve

public void resolve(DependencyResolveContext context)

Specified by:

resolve in interface ResolvableDependency

Overrides:

resolve in class AbstractDependency

getBuildDependencies

public TaskDependency getBuildDependencies()

Description copied from interface: Buildable

Returns a dependency which contains the tasks which build this artifact. All Buildable implementations must ensure that the returned dependency object is live, so that it tracks changes to the dependencies of this buildable.

Specified by:

getBuildDependencies in interface Buildable

Returns:

The dependency. Never returns null. Returns an empty dependency when this artifact is not built by any tasks.

contentEquals

public boolean contentEquals(Dependency dependency)

Description copied from interface: Dependency

Returns whether two dependencies have identical values for their properties. A dependency is an entity with a key. Therefore dependencies might be equal and yet have different properties.

Specified by:

contentEquals in interface Dependency

Parameters:

dependency - The dependency to compare this dependency with

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class AbstractDependency

toString

public String toString()

Overrides:

toString in class Object