package librarymanagement
- Alphabetic
- Public
- All
Type Members
- final class Artifact extends ArtifactExtra with Serializable
- trait ArtifactFilter extends SubDepFilter[Artifact, ArtifactFilter]
- trait ArtifactFormats extends AnyRef
-
final
class
ArtifactTypeFilter extends ArtifactTypeFilterExtra with Serializable
Work around the inadequacy of Ivy's ArtifactTypeFilter (that it cannot reverse a filter)
- trait ArtifactTypeFilterFormats extends AnyRef
-
final
class
Binary extends CrossVersion with Serializable
Cross-versions a module using the result of prepending
prefix
and appendingsuffix
to the binary version.Cross-versions a module using the result of prepending
prefix
and appendingsuffix
to the binary version. For example, ifprefix = "foo_"
andsuffix = "_bar"
and the binary version is "2.10", the module is cross-versioned with "foo_2.10_bar". - trait BinaryFormats extends AnyRef
- final class Caller extends Serializable
- trait CallerFormats extends AnyRef
- final class ChainedResolver extends Resolver with Serializable
- trait ChainedResolverFormats extends AnyRef
- final class Checksum extends Serializable
- trait ChecksumFormats extends AnyRef
-
final
class
ConfigRef extends Serializable
A reference to Configuration.
- trait ConfigRefFormats extends AnyRef
-
final
class
Configuration extends ConfigurationExtra with Serializable
Represents an Ivy configuration.
- trait ConfigurationFilter extends SubDepFilter[ConfigRef, ConfigurationFilter]
- trait ConfigurationFormats extends AnyRef
-
final
class
ConfigurationReport extends ConfigurationReportExtra with Serializable
Provides information about resolution of a single configuration.
- trait ConfigurationReportFormats extends AnyRef
- trait ConfigurationReportLiteFormats extends AnyRef
-
final
class
ConflictManager extends Serializable
See http://ant.apache.org/ivy/history/latest-milestone/settings/conflict-managers.html for details of the different conflict managers.
- trait ConflictManagerFormats extends AnyRef
-
final
case class
ConflictWarning(label: String, level: util.Level.Value, failOnConflict: Boolean) extends Product with Serializable
Provide warnings for cross version conflicts.
Provide warnings for cross version conflicts. A library foo_2.10 and foo_2.11 can potentially be both included on the library dependency graph by mistake, but it won't be caught by eviction.
-
final
class
Constant extends CrossVersion with Serializable
Cross-versions a module using the string
value
. - trait ConstantFormats extends AnyRef
-
abstract
class
CrossVersion extends Serializable
Configures how a module will be cross-versioned.
- trait CrossVersionFormats extends AnyRef
-
trait
DependencyBuilders extends AnyRef
DependencyBuilders implements the implicits for % and %% DSL.
- trait DependencyFilter extends AnyRef
- trait DependencyFilterExtra extends AnyRef
-
class
DependencyResolution extends AnyRef
Library management API to resolve dependencies.
-
trait
DependencyResolutionInterface extends AnyRef
Interface for dependency resolution intended for engine authors.
- final class Developer extends Serializable
- trait DeveloperFormats extends AnyRef
-
sealed
class
Disabled extends CrossVersion with Serializable
Disables cross versioning for a module.
- trait DisabledFormats extends AnyRef
- final class EvictionError extends AnyRef
- final class EvictionPair extends AnyRef
- final class EvictionWarning extends AnyRef
- final class EvictionWarningOptions extends AnyRef
-
final
class
FileConfiguration extends Serializable
Configuration specific to an Ivy filesystem resolver.
- trait FileConfigurationFormats extends AnyRef
-
final
class
FileRepository extends PatternsBasedRepository with Serializable
sbt interface for an Ivy filesystem repository.
sbt interface for an Ivy filesystem repository. More convenient construction is done using Resolver.file.
- trait FileRepositoryFormats extends AnyRef
-
final
class
For2_13Use3 extends CrossVersion with Serializable
Similar to Binary except that if the binary version is 2.13 it uses 3 instead.
Similar to Binary except that if the binary version is 2.13 it uses 3 instead. For example, if
prefix = "foo_"
andsuffix = "_bar"
and the binary version is "2.13", the module is cross-versioned with "foo_3_bar". - trait For2_13Use3Formats extends AnyRef
-
final
class
For3Use2_13 extends CrossVersion with Serializable
Similar to Binary except that if the binary version is 3 (or if it is of the form 3.0.0-x) it uses 2.13 instead.
Similar to Binary except that if the binary version is 3 (or if it is of the form 3.0.0-x) it uses 2.13 instead. For example, if
prefix = "foo_"
andsuffix = "_bar"
and the binary version is "3", the module is cross-versioned with "foo_2.13_bar". - trait For3Use2_13Formats extends AnyRef
-
final
class
Full extends CrossVersion with Serializable
Cross-versions a module with the result of prepending
prefix
and appendingsuffix
to the full version.Cross-versions a module with the result of prepending
prefix
and appendingsuffix
to the full version. For example, ifprefix = "foo_"
andsuffix = "_bar"
and the full version is "2.12.1", the module is cross-versioned with "foo_2.12.1_bar". - trait FullFormats extends AnyRef
- final class GetClassifiersConfiguration extends Serializable
- trait GetClassifiersConfigurationFormats extends AnyRef
- final class GetClassifiersModule extends Serializable
- trait GetClassifiersModuleFormats extends AnyRef
-
final
class
InclExclRule extends Serializable
Defines a rule to either:
Defines a rule to either:
- Exclude unwanted dependencies pulled in transitively by a module, or to
- Include and merge artifacts coming from the ModuleDescriptor if "dependencyArtifacts" are also provided.
The use case that is applied depends on the parameter name which it is passed to, but the filter has the same fields in both cases.
- trait InclExclRuleFormats extends AnyRef
- final class IvyFileConfiguration extends ModuleSettings with Serializable
- trait IvyFileConfigurationFormats extends AnyRef
- final class KeyFileAuthentication extends SshAuthentication with Serializable
- trait KeyFileAuthenticationFormats extends AnyRef
- trait LibraryManagementCodec extends ConfigRefFormats with BasicJsonProtocol with RetrieveConfigurationFormats with UpdateLoggingFormats with LogicalClockFormats with ArtifactTypeFilterFormats with UpdateConfigurationFormats with ChecksumFormats with ArtifactFormats with CrossVersionFormats with DisabledFormats with BinaryFormats with ConstantFormats with PatchFormats with FullFormats with For3Use2_13Formats with For2_13Use3Formats with InclExclRuleFormats with ModuleIDFormats with ConfigurationFormats with ScalaModuleInfoFormats with GetClassifiersModuleFormats with GetClassifiersConfigurationFormats with PublishConfigurationFormats with CallerFormats with ModuleReportFormats with OrganizationArtifactReportFormats with ConfigurationReportFormats with ConflictManagerFormats with DeveloperFormats with FileConfigurationFormats with ChainedResolverFormats with MavenRepoFormats with MavenCacheFormats with PatternsFormats with FileRepositoryFormats with URLRepositoryFormats with PasswordAuthenticationFormats with KeyFileAuthenticationFormats with SshAuthenticationFormats with SshConnectionFormats with SshRepositoryFormats with SftpRepositoryFormats with ResolverFormats with ModuleConfigurationFormats with ScmInfoFormats with ModuleInfoFormats with IvyFileConfigurationFormats with PomConfigurationFormats with NodeSeqFormat with ModuleDescriptorConfigurationFormats with ModuleSettingsFormats with MavenRepositoryFormats with PatternsBasedRepositoryFormats with SshBasedRepositoryFormats with UpdateStatsFormats with UpdateReportFormats with ConfigurationReportLiteFormats with UpdateReportLiteFormats
- trait LibraryManagementSyntax extends LibraryManagementSyntax0 with DependencyBuilders with DependencyFilterExtra
- trait LibraryManagementSyntax0 extends AnyRef
-
trait
LogicalClock extends AnyRef
Represents a logical time point for dependency resolution.
Represents a logical time point for dependency resolution. This is used to cache dependencies across subproject resolution which may change over time.
- final class MakePomConfiguration extends Serializable
-
final
class
MavenCache extends MavenRepository with Serializable
An instance of maven CACHE directory.
An instance of maven CACHE directory. You cannot treat a cache directory the same as a a remote repository because the metadata is different (see Aether ML discussion).
- trait MavenCacheFormats extends AnyRef
-
final
class
MavenRepo extends MavenRepository with Serializable
This is the internal implementation of actual Maven Repository (as opposed to a file cache).
- trait MavenRepoFormats extends AnyRef
-
abstract
class
MavenRepository extends Resolver with Serializable
An instance of a remote maven repository.
An instance of a remote maven repository. Note: This will use Aether/Maven to resolve artifacts.
- trait MavenRepositoryFormats extends AnyRef
- final class ModuleConfiguration extends Serializable
- trait ModuleConfigurationFormats extends AnyRef
-
trait
ModuleDescriptor extends AnyRef
Decribes the representation of a module, including its dependencies and the version of Scala it uses, if any.
- final class ModuleDescriptorConfiguration extends ModuleSettings with Serializable
- trait ModuleDescriptorConfigurationFormats extends AnyRef
- trait ModuleFilter extends SubDepFilter[ModuleID, ModuleFilter]
- final class ModuleID extends ModuleIDExtra with Serializable
- trait ModuleIDFormats extends AnyRef
-
final
class
ModuleInfo extends Serializable
Additional information about a project module
- trait ModuleInfoFormats extends AnyRef
-
final
class
ModuleReport extends ModuleReportExtra with Serializable
Provides information about the resolution of a module.
Provides information about the resolution of a module. This information is in the context of a specific configuration.
- trait ModuleReportFormats extends AnyRef
- abstract class ModuleSettings extends Serializable
- trait ModuleSettingsFormats extends AnyRef
-
final
class
OrganizationArtifactReport extends Serializable
OrganizationArtifactReport represents an organization+name entry in Ivy resolution report.
OrganizationArtifactReport represents an organization+name entry in Ivy resolution report. In sbt's terminology, "module" consists of organization, name, and version. In Ivy's, "module" means just organization and name, and the one including version numbers are called revisions.
A sequence of OrganizationArtifactReport called details is newly added to ConfigurationReport, replacing evicted. (Note old evicted was just a seq of ModuleIDs). OrganizationArtifactReport groups the ModuleReport of both winners and evicted reports by their organization and name, which can be used to calculate detailed eviction warning etc.
- trait OrganizationArtifactReportFormats extends AnyRef
- final class PasswordAuthentication extends SshAuthentication with Serializable
- trait PasswordAuthenticationFormats extends AnyRef
-
final
class
Patch extends CrossVersion with Serializable
Cross-versions a module by stripping off -bin-suffix.
Cross-versions a module by stripping off -bin-suffix. This is intended for patch-version compatible alternative replacements.
- trait PatchFormats extends AnyRef
- final class Patterns extends Serializable
-
abstract
class
PatternsBasedRepository extends Resolver with Serializable
sbt interface to an Ivy repository based on patterns, which is most Ivy repositories.
- trait PatternsBasedRepositoryFormats extends AnyRef
- trait PatternsFormats extends AnyRef
- final class PomConfiguration extends ModuleSettings with Serializable
- trait PomConfigurationFormats extends AnyRef
- final class PublishConfiguration extends Serializable
- trait PublishConfigurationFormats extends AnyRef
-
class
Publisher extends AnyRef
Library management API to publish artifacts.
-
trait
PublisherInterface extends AnyRef
Interface for publishing modules.
- final class RawRepository extends Resolver
- final class ResolveException extends RuntimeException
- abstract class Resolver extends Serializable
- trait ResolverFormats extends AnyRef
- final class RetrieveConfiguration extends Serializable
- trait RetrieveConfigurationFormats extends AnyRef
-
final
class
RichUpdateReport extends AnyRef
Provides extra methods for filtering the contents of an
UpdateReport
and for obtaining references to a selected subset of the underlying files. - final class ScalaModuleInfo extends Serializable
- trait ScalaModuleInfoFormats extends AnyRef
- final case class ScalaVersion(full: String, binary: String) extends Product with Serializable
-
final
class
ScmInfo extends Serializable
Basic SCM information for a project module
- trait ScmInfoFormats extends AnyRef
-
final
class
SemanticSelector extends Serializable
Semantic version selector API to check if the VersionNumber satisfies conditions described by semantic version selector.
Semantic version selector API to check if the VersionNumber satisfies conditions described by semantic version selector.
A
comparator
generally consist of an operator and version specifier. The set of operators is -<
: Less than -<=
: Less than or equal to ->
: Greater than ->=
: Greater than or equal to -=
: Equal If no operator is specified,=
is assumed.If minor or patch versions are not specified, some numbers are assumed. -
<=1.0
is equivalent to<1.1.0
. -<1.0
is equivalent to<1.0.0
. ->=1.0
is equivalent to>=1.0.0
. ->1.0
is equivalent to>=1.1.0
. -=1.0
is equivalent to>=1.0 <=1.0
(so>=1.0.0 <1.1.0
).Comparators can be combined by spaces to form the intersection set of the comparators. For example,
>1.2.3 <4.5.6
matches versions that aregreater than 1.2.3 AND less than 4.5.6
.The (intersection) set of comparators can combined by
||
(spaces are required) to form the union set of the intersection sets. So the semantic selector is in disjunctive normal form.Wildcard (
x
,X
,*
) can be used to match any number of minor or patch version. Actually,1.0.x
is equivalent to=1.0
(that is equivalent to>=1.0.0 <1.1.0
)The hyphen range like
1.2.3 - 4.5.6
matches inclusive set of versions. So1.2.3 - 4.5.6
is equivalent to>=1.2.3 <=4.5.6
. Both sides of comparators around - are required and they can not have any operators. For example,>=1.2.3 - 4.5.6
is invalid.The order of versions basically follows the rule specified in https://semver.org/#spec-item-11 > When major, minor, and patch are equal, a pre-release version has lower precedence > than a normal version. Example: 1.0.0-alpha < 1.0.0. > Precedence for two pre-release versions with the same major, minor, and patch version > Must be determined by comparing each dot separated identifier from left to right > until a difference is found as follows: > identifiers consisting of only digits are compared numerically > and identifiers with letters or hyphens are compared lexically in ASCII sort order. > Numeric identifiers always have lower precedence than non-numeric identifiers. > A larger set of pre-release fields has a higher precedence than a smaller set, > if all of the preceding identifiers are equal. > Example: 1.0.0-alpha < 1.0.0-alpha.1 < 1.0.0-alpha.beta < 1.0.0-beta < 1.0.0-beta.2 < 1.0.0-beta.11 < 1.0.0-rc.1 < 1.0.0.
The differences from the original specification are following -
SemanticVersionSelector
separetes the pre-release fields by hyphen instead of dot - hyphen cannot be used in pre-release identifiers because it is used as separator for pre-release fieldsTherefore, in order to match pre-release versions like
1.0.0-beta
we need to explicitly specify the pre-release identifiers like>=1.0.0-alpha
. -
final
class
SftpRepository extends SshBasedRepository with SftpRepositoryExtra with Serializable
sbt interface for an Ivy repository over sftp.
sbt interface for an Ivy repository over sftp. More convenient construction is done using Resolver.sftp.
- trait SftpRepositoryFormats extends AnyRef
- abstract class SshAuthentication extends Serializable
- trait SshAuthenticationFormats extends AnyRef
-
abstract
class
SshBasedRepository extends PatternsBasedRepository with SshBasedRepositoryExtra with Serializable
sbt interface for an Ivy ssh-based repository (ssh and sftp).
sbt interface for an Ivy ssh-based repository (ssh and sftp). Requires the Jsch library..
- trait SshBasedRepositoryFormats extends AnyRef
- final class SshConnection extends Serializable
- trait SshConnectionFormats extends AnyRef
-
final
class
SshRepository extends SshBasedRepository with SshRepositoryExtra with Serializable
sbt interface for an Ivy repository over ssh.
sbt interface for an Ivy repository over ssh. More convenient construction is done using Resolver.ssh.
- trait SshRepositoryFormats extends AnyRef
- sealed trait SubDepFilter[Arg, Self <: SubDepFilter[Arg, Self]] extends DependencyFilter
- sealed trait TrackLevel extends AnyRef
- final class URLRepository extends PatternsBasedRepository with Serializable
- trait URLRepositoryFormats extends AnyRef
-
final
class
UnresolvedWarning extends AnyRef
Represents unresolved dependency warning, which displays reconstructed dependency tree along with source position of each node.
- final class UnresolvedWarningConfiguration extends AnyRef
- final class UpdateConfiguration extends Serializable
- trait UpdateConfigurationFormats extends AnyRef
-
sealed abstract
class
UpdateLogging extends Serializable
Configures logging during an 'update'.
Configures logging during an 'update'.
level
determines the amount of other information logged.Full
is the default and logs the most.DownloadOnly
only logs what is downloaded.Quiet
only displays errors.Default
uses the current log level ofupdate
task. - trait UpdateLoggingFormats extends AnyRef
-
final
class
UpdateReport extends UpdateReportExtra with Serializable
Provides information about dependency resolution.
Provides information about dependency resolution. It does not include information about evicted modules, only about the modules ultimately selected by the conflict manager. This means that for a given configuration, there should only be one revision for a given organization and module name.
- trait UpdateReportFormats extends AnyRef
- trait UpdateReportLiteFormats extends AnyRef
- final class UpdateStats extends Serializable
- trait UpdateStatsFormats extends AnyRef
- final class VersionNumber extends AnyRef
- trait VersionNumberCompatibility extends AnyRef
Value Members
- object Artifact extends ArtifactFunctions with Serializable
- object ArtifactTypeFilter extends ArtifactTypeFilterFunctions with Serializable
- object Binary extends Serializable
- object Caller extends Serializable
- object ChainedResolver extends Serializable
- object Checksum extends Serializable
- object ConfigRef extends ConfigRefFunctions with Serializable
- object Configuration extends Serializable
- object ConfigurationReport extends Serializable
- object Configurations
- object ConflictManager extends ConflictManagerFunctions with Serializable
- object ConflictWarning extends Serializable
- object Constant extends Serializable
- object CrossVersion extends CrossVersionFunctions with Serializable
- object DependencyBuilders
- object DependencyFilter extends DependencyFilterExtra
- object DependencyResolution
- object Developer extends Serializable
- object Disabled extends Disabled
- object EvictionError
- object EvictionPair
- object EvictionWarning
- object EvictionWarningOptions
- object FileConfiguration extends Serializable
- object FileRepository extends Serializable
- object For2_13Use3 extends Serializable
- object For3Use2_13 extends Serializable
- object Full extends Serializable
- object GetClassifiersConfiguration extends Serializable
- object GetClassifiersModule extends Serializable
- object Http
- object InclExclRule extends InclExclRuleFunctions with Serializable
- object IvyFileConfiguration extends Serializable
- object KeyFileAuthentication extends Serializable
- object LibraryManagementCodec extends LibraryManagementCodec
-
object
License
Commonly used software licenses Names are SPDX ids: https://raw.githubusercontent.com/spdx/license-list-data/master/json/licenses.json
- object LogicalClock
- object MakePomConfiguration extends MakePomConfigurationFunctions with Serializable
- object MavenCache extends Serializable
- object MavenRepo extends Serializable
- object MavenRepository extends MavenRepositoryFunctions with Serializable
- object ModuleConfiguration extends Serializable
- object ModuleDescriptorConfiguration extends InlineConfigurationFunctions with Serializable
- object ModuleID extends ModuleIDFunctions with Serializable
- object ModuleInfo extends Serializable
- object ModuleReport extends Serializable
- object ModuleSettings extends Serializable
- object OrganizationArtifactReport extends Serializable
- object PasswordAuthentication extends Serializable
- object Patch extends Serializable
- object Patterns extends PatternsFunctions with Serializable
- object PatternsBasedRepository extends Serializable
- object PomConfiguration extends Serializable
- object PublishConfiguration extends Serializable
- object Publisher
- object Resolver extends ResolverFunctions with Serializable
- object RetrieveConfiguration extends Serializable
- object SbtArtifacts
- object ScalaArtifacts
- object ScalaModuleInfo extends Serializable
- object ScmInfo extends Serializable
- object SemanticSelector extends Serializable
- object SftpRepository extends Serializable
- object SshAuthentication extends Serializable
- object SshBasedRepository extends Serializable
- object SshConnection extends Serializable
- object SshRepository extends Serializable
-
object
TrackLevel
An enumeration defining the tracking of dependencies.
An enumeration defining the tracking of dependencies. A level includes all of the levels with id larger than its own id. For example, Warn (id=3) includes Error (id=4).
- object URLRepository extends Serializable
- object UnresolvedWarning
- object UnresolvedWarningConfiguration
- object UpdateConfiguration extends Serializable
- object UpdateLogging extends Serializable
- object UpdateReport extends Serializable
- object UpdateStats extends Serializable
- object VersionNumber
- object syntax extends LibraryManagementSyntax