org.gradle.api.internal.artifacts.dependencies

Class DefaultClientModule

java.lang.Object

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

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

org.gradle.api.internal.artifacts.dependencies.AbstractExternalDependency

org.gradle.api.internal.artifacts.dependencies.DefaultClientModule

All Implemented Interfaces:

ClientModule, Dependency, ExternalDependency, ModuleDependency, ModuleVersionSelector, ResolvableDependency

public class DefaultClientModule
extends AbstractExternalDependency
implements ClientModule

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
DefaultClientModule(String group, String name, String version)
DefaultClientModule(String group, String name, String version, String configuration)

Method Summary

Methods

Modifier and Type	Method and Description
void	addDependency(ModuleDependency dependency) Add a dependency to the client module.
boolean	contentEquals(Dependency dependency) Returns whether two dependencies have identical values for their properties.
ClientModule	copy() Creates and returns a new dependency with the property values of this one.
boolean	equals(Object o)
Set<ModuleDependency>	getDependencies() Returns all the dependencies added to the client module.
String	getGroup() Returns the group of this dependency.
String	getId() Returns the id of the client module.
String	getName() Returns the name of this dependency.
String	getVersion() Returns the version of this dependency.
int	hashCode()
boolean	isForce() Returns whether or not the version of this dependency should be enforced in the case of version conflicts.
ClientModule	setForce(boolean force) Sets whether or not the version of this dependency should be enforced in the case of version conflicts.
ClientModule	setGroup(String group)
ClientModule	setName(String name)
ClientModule	setVersion(String version)

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

copyTo, isContentEqualsFor

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, resolve

Methods inherited from class java.lang.Object

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

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

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

Constructor Detail

DefaultClientModule

public DefaultClientModule(String group,
                   String name,
                   String version)

DefaultClientModule

public DefaultClientModule(String group,
                   String name,
                   String version,
                   String configuration)

Method Detail

getDependencies

public Set<ModuleDependency> getDependencies()

Description copied from interface: ClientModule

Returns all the dependencies added to the client module.

Specified by:

getDependencies in interface ClientModule

See Also:

ClientModule.addDependency(ModuleDependency)

getId

public String getId()

Description copied from interface: ClientModule

Returns the id of the client module. This is usually only used for internal handling of the client module.

Specified by:

getId in interface ClientModule

Returns:

The id of the client module

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

Specified by:

getGroup in interface ModuleVersionSelector

Returns:

module group

setGroup

public ClientModule setGroup(String group)

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

Specified by:

getName in interface ModuleVersionSelector

Returns:

module name

setName

public ClientModule setName(String name)

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

Specified by:

getVersion in interface ModuleVersionSelector

Returns:

module version

setVersion

public ClientModule setVersion(String version)

isForce

public boolean isForce()

Description copied from interface: ExternalDependency

Returns whether or not the version of this dependency should be enforced in the case of version conflicts.

Specified by:

isForce in interface ExternalDependency

setForce

public ClientModule setForce(boolean force)

Description copied from interface: ExternalDependency

Sets whether or not the version of this dependency should be enforced in the case of version conflicts.

Specified by:

setForce in interface ExternalDependency

Parameters:

force - Whether to force this version or not.

Returns:

this

addDependency

public void addDependency(ModuleDependency dependency)

Description copied from interface: ClientModule

Add a dependency to the client module. Such a dependency is transitive dependency for the project that has a dependency on the client module.

Specified by:

addDependency in interface ClientModule

Parameters:

dependency - The dependency to add to the client module.

See Also:

ClientModule.getDependencies()

copy

public ClientModule copy()

Description copied from interface: ClientModule

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

Specified by:

copy in interface ClientModule

Specified by:

copy in interface Dependency

Specified by:

copy in interface ExternalDependency

Specified by:

copy in interface ModuleDependency

Returns:

The copy. Never returns null.

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