DependencyResolution

sbt.librarymanagement.DependencyResolution
See theDependencyResolution companion object

Library management API to resolve dependencies.

Attributes

Companion:
object
Graph
Supertypes
class Object
trait Matchable
class Any

Members list

Concise view

Value members

Concrete methods

Builds a ModuleDescriptor that describes a subproject with dependencies.

Builds a ModuleDescriptor that describes a subproject with dependencies.

Attributes

moduleSetting

It contains the information about the module including the dependencies.

Returns:

A ModuleDescriptor describing a subproject and its dependencies.

def moduleDescriptor(moduleId: ModuleID, directDependencies: Vector[ModuleID], scalaModuleInfo: Option[ScalaModuleInfo]): ModuleDescriptor

Build a ModuleDescriptor that describes a subproject with dependencies.

Build a ModuleDescriptor that describes a subproject with dependencies.

Attributes

configurations

The configurations that this module has.

directDependencies

The direct dependencies of the module.

moduleId

The root module for which to create a ModuleDescriptor.

scalaModuleInfo

The information about the Scala version used, if any.

Returns:

A ModuleDescriptor describing a subproject and its dependencies.

def retrieve(dependencyId: ModuleID, scalaModuleInfo: Option[ScalaModuleInfo], retrieveDirectory: File, log: Logger): Either[UnresolvedWarning, Vector[File]]

Resolves the given dependency, and retrieves the artifacts to a directory.

Resolves the given dependency, and retrieves the artifacts to a directory.

Attributes

dependencyId

The dependency to be resolved.

log

The logger.

retrieveDirectory

The directory to retrieve the files.

scalaModuleInfo

The module info about Scala.

Returns:

The result, either an unresolved warning or a sequence of files.

def retrieve(module: ModuleDescriptor, retrieveDirectory: File, log: Logger): Either[UnresolvedWarning, Vector[File]]

Resolves the given module's dependencies, and retrieves the artifacts to a directory.

Resolves the given module's dependencies, and retrieves the artifacts to a directory.

Attributes

log

The logger.

module

The module to be resolved.

retrieveDirectory

The directory to retrieve the files.

Returns:

The result, either an unresolved warning or a sequence of files.

def update(module: ModuleDescriptor, configuration: UpdateConfiguration, uwconfig: UnresolvedWarningConfiguration, log: Logger): Either[UnresolvedWarning, UpdateReport]

Resolves the given module's dependencies performing a retrieval.

Resolves the given module's dependencies performing a retrieval.

Attributes

configuration

The update configuration.

log

The logger.

module

The module to be resolved.

uwconfig

The configuration to handle unresolved warnings.

Returns:

The result, either an unresolved warning or an update report. Note that this update report will or will not be successful depending on the missingOk option.

def updateClassifiers(config: GetClassifiersConfiguration, uwconfig: UnresolvedWarningConfiguration, artifacts: Vector[(String, ModuleID, Artifact, File)], log: Logger): Either[UnresolvedWarning, UpdateReport]

Creates explicit artifacts for each classifier in config.module, and then attempts to resolve them directly. This is for Maven compatibility, where these artifacts are not "published" in the POM, so they don't end up in the Ivy that sbt generates for them either.
Artifacts can be obtained from calling toSeq on UpdateReport.
In addition, retrieves specific Ivy artifacts if they have one of the requested config.configuration.types.

Creates explicit artifacts for each classifier in config.module, and then attempts to resolve them directly. This is for Maven compatibility, where these artifacts are not "published" in the POM, so they don't end up in the Ivy that sbt generates for them either.
Artifacts can be obtained from calling toSeq on UpdateReport.
In addition, retrieves specific Ivy artifacts if they have one of the requested config.configuration.types.

Attributes

config

important to set config.configuration.types to only allow artifact types that can correspond to "classified" artifacts (sources and javadocs).

Returns a ModuleDescriptor that depends on dependencyId.

Returns a ModuleDescriptor that depends on dependencyId.

Attributes

dependencyId

The module to depend on.

Returns:

A ModuleDescriptor that depends on dependencyId.

def wrapDependencyInModule(dependencyId: ModuleID, scalaModuleInfo: Option[ScalaModuleInfo]): ModuleDescriptor

Returns a ModuleDescriptor that depends on dependencyId.

Returns a ModuleDescriptor that depends on dependencyId.

Attributes

dependencyId

The module to depend on.

scalaModuleInfo

The information about the Scala verson used, if any.

Returns:

A ModuleDescriptor that depends on dependencyId.