Groovy Documentation

org.gradle.api.artifacts
[Java] Interface ClientModule

org.gradle.tooling.model.ExternalDependency
  org.gradle.api.artifacts.ClientModule
      org.gradle.api.artifacts.Dependency
All Superinterfaces:
ExternalDependency, Dependency

public interface ClientModule
extends ExternalDependency

To model a module in your dependency declarations. Usually you can either declare a single dependency artifact or you declare a module dependency that depends on a module descriptor in a repository. With a client module you can declare a module dependency without the need of a module descriptor in a remote repository.


Field Summary
 
Fields inherited from interface Dependency
ARCHIVES_CONFIGURATION, CLASSIFIER, DEFAULT_CONFIGURATION
 
Method Summary
void addDependency(ModuleDependency dependency)

Add a dependency to the client module.

ClientModule copy()

{@inheritDoc}

Set getDependencies()

Returns all the dependencies added to the client module.

String getId()

Returns the id of the client module.

 
Methods inherited from interface ExternalDependency
getFile, getGradleModuleVersion, getJavadoc, getSource
 
Methods inherited from interface Dependency
contentEquals, copy, getGroup, getName, getVersion
 

Method Detail

addDependency

public void addDependency(ModuleDependency dependency)
Add a dependency to the client module. Such a dependency is transitive dependency for the project that has a dependency on the client module.
Parameters:
dependency - The dependency to add to the client module.
See Also:
getDependencies()


copy

public ClientModule copy()
{@inheritDoc}


getDependencies

public Set getDependencies()
Returns all the dependencies added to the client module.
See Also:
addDependency(ModuleDependency)


getId

public String getId()
Returns the id of the client module. This is usually only used for internal handling of the client module.
Returns:
The id of the client module


 

Gradle API 1.12