ModuleID

sbt.librarymanagement.ModuleID
See theModuleID companion object
final class ModuleID extends Serializable

Attributes

Companion:
object
Graph
Supertypes
trait Serializable
class Object
trait Matchable
class Any

Members list

Concise view

Value members

Concrete methods

override def equals(o: Any): Boolean

Compares the receiver object (this) with the argument object (that) for equivalence.

Compares the receiver object (this) with the argument object (that) for equivalence.

Any implementation of this method should be an equivalence relation:

  • It is reflexive: for any instance x of type Any, x.equals(x) should return true.
  • It is symmetric: for any instances x and y of type Any, x.equals(y) should return true if and only if y.equals(x) returns true.
  • It is transitive: for any instances x, y, and z of type Any if x.equals(y) returns true and y.equals(z) returns true, then x.equals(z) should return true.

If you override this method, you should verify that your implementation remains an equivalence relation. Additionally, when overriding this method it is usually necessary to override hashCode to ensure that objects which are "equal" (o1.equals(o2) returns true) hash to the same scala.Int. (o1.hashCode.equals(o2.hashCode)).

Attributes

that

the object to compare against this object for equality.

Returns:

true if the receiver object is equivalent to the argument; false otherwise.

Definition Classes
Any
override def hashCode: Int

Calculate a hash code value for the object.

Calculate a hash code value for the object.

The default hashing algorithm is platform dependent.

Note that it is allowed for two objects to have identical hash codes (o1.hashCode.equals(o2.hashCode)) yet not be equal (o1.equals(o2) returns false). A degenerate implementation could always return 0. However, it is required that if two objects are equal (o1.equals(o2) returns true) that they have identical hash codes (o1.hashCode.equals(o2.hashCode)). Therefore, when overriding this method, be sure to verify that the behavior is consistent with the equals method.

Attributes

Returns:

the hash code value for this object.

Definition Classes
Any
override def toString: String

Returns a string representation of the object.

Returns a string representation of the object.

The default representation is platform dependent.

Attributes

Returns:

a string representation of the object.

Definition Classes
Any
def withBranchName(branchName: Option[String]): ModuleID
def withConfigurations(configurations: Option[String]): ModuleID
def withExclusions(exclusions: Vector[InclExclRule]): ModuleID
def withExplicitArtifacts(explicitArtifacts: Vector[Artifact]): ModuleID
def withExtraAttributes(extraAttributes: Map[String, String]): ModuleID
def withInclusions(inclusions: Vector[InclExclRule]): ModuleID
def withIsChanging(isChanging: Boolean): ModuleID
def withIsForce(isForce: Boolean): ModuleID
def withIsTransitive(isTransitive: Boolean): ModuleID
def withName(name: String): ModuleID
def withOrganization(organization: String): ModuleID
def withRevision(revision: String): ModuleID

Inherited methods

def artifacts(newArtifacts: Artifact*): ModuleID

Declares the explicit artifacts for this module. If this ModuleID represents a dependency, these artifact definitions override the information in the dependency's published metadata.

Declares the explicit artifacts for this module. If this ModuleID represents a dependency, these artifact definitions override the information in the dependency's published metadata.

Attributes

Inherited from:
ModuleIDExtra (hidden)
protected def attributeString: String

Attributes

Inherited from:
ModuleIDExtra (hidden)
def branch(branchName: Option[String]): ModuleID

Attributes

Inherited from:
ModuleIDExtra (hidden)
def branch(branchName: String): ModuleID

Sets the Ivy branch of this module.

Sets the Ivy branch of this module.

Attributes

Inherited from:
ModuleIDExtra (hidden)

Marks this dependency as "changing". Ivy will always check if the metadata has changed and then if the artifact has changed, redownload it. sbt configures all -SNAPSHOT dependencies to be changing.

Marks this dependency as "changing". Ivy will always check if the metadata has changed and then if the artifact has changed, redownload it. sbt configures all -SNAPSHOT dependencies to be changing.

See the "Changes in artifacts" section of https://ant.apache.org/ivy/history/trunk/concept.html for full details.

Attributes

Inherited from:
ModuleIDExtra (hidden)
def classifier(c: String): ModuleID

Adds a dependency on the artifact for this module with classifier c.

Adds a dependency on the artifact for this module with classifier c.

Attributes

Inherited from:
ModuleIDExtra (hidden)

Specifies the cross-version behavior for this module. See [CrossVersion] for details. Unlike withCrossVersion(...), cross(...) will preserve the prefix and suffix values from the existing crossVersion value.

Specifies the cross-version behavior for this module. See [CrossVersion] for details. Unlike withCrossVersion(...), cross(...) will preserve the prefix and suffix values from the existing crossVersion value.

ModuleID("com.example", "foo", "1.0")
   .cross(CrossVersion.binaryWith("sjs1_", ""))
   .cross(CrossVersion.for3Use2_13)

This allows .cross(...) to play well with %%% operator provided by sbt-platform-deps.

Attributes

Inherited from:
ModuleIDExtra (hidden)
def exclude(org: String, name: String): ModuleID

Excludes the dependency with organization org and name from being introduced by this dependency during resolution.

Excludes the dependency with organization org and name from being introduced by this dependency during resolution.

Attributes

Inherited from:
ModuleIDExtra (hidden)

Applies the provided exclusions to dependencies of this module. Note that only exclusions that specify both the exact organization and name and nothing else will be included in a pom.xml.

Applies the provided exclusions to dependencies of this module. Note that only exclusions that specify both the exact organization and name and nothing else will be included in a pom.xml.

Attributes

Inherited from:
ModuleIDExtra (hidden)
def extra(attributes: (String, String)*): ModuleID

Adds extra attributes for this module. All keys are prefixed with e: if they are not already so prefixed. This information will only be published in an ivy.xml and not in a pom.xml.

Adds extra attributes for this module. All keys are prefixed with e: if they are not already so prefixed. This information will only be published in an ivy.xml and not in a pom.xml.

Attributes

Inherited from:
ModuleIDExtra (hidden)
def extraDependencyAttributes: Map[String, String]

Returns the extra attributes except for ones marked as information only (ones that typically would not be used for dependency resolution).

Returns the extra attributes except for ones marked as information only (ones that typically would not be used for dependency resolution).

Attributes

Inherited from:
ModuleIDExtra (hidden)
def extraString: String

String representation of the extra attributes, excluding any information only attributes.

String representation of the extra attributes, excluding any information only attributes.

Attributes

Inherited from:
ModuleIDExtra (hidden)

Indicates that conflict resolution should only select this module's revision. This prevents a newer revision from being pulled in by a transitive dependency, for example.

Indicates that conflict resolution should only select this module's revision. This prevents a newer revision from being pulled in by a transitive dependency, for example.

Attributes

Inherited from:
ModuleIDExtra (hidden)
def from(url: String, allowInsecureProtocol: Boolean): ModuleID

Specifies a URL from which the main artifact for this dependency can be downloaded. This value is only consulted if the module is not found in a repository. It is not included in published metadata.

Specifies a URL from which the main artifact for this dependency can be downloaded. This value is only consulted if the module is not found in a repository. It is not included in published metadata.

Attributes

Inherited from:
ModuleIDExtra (hidden)
def from(url: String): ModuleID

Specifies a URL from which the main artifact for this dependency can be downloaded. This value is only consulted if the module is not found in a repository. It is not included in published metadata.

Specifies a URL from which the main artifact for this dependency can be downloaded. This value is only consulted if the module is not found in a repository. It is not included in published metadata.

Attributes

Inherited from:
ModuleIDExtra (hidden)

Do not follow dependencies of this module. Synonym for notTransitive.

Do not follow dependencies of this module. Synonym for notTransitive.

Attributes

Inherited from:
ModuleIDExtra (hidden)
def jar(): ModuleID

Declares a dependency on the main artifact. This is implied by default unless artifacts are explicitly declared, such as when adding a dependency on an artifact with a classifier.

Declares a dependency on the main artifact. This is implied by default unless artifacts are explicitly declared, such as when adding a dependency on an artifact with a classifier.

Attributes

Inherited from:
ModuleIDExtra (hidden)

Not recommended for new use. This method is not deprecated, but the update-classifiers task is preferred for performance and correctness. This method adds a dependency on this module's artifact with the "javadoc" classifier. If you want to also depend on the main artifact, be sure to also call jar() or use withJavadoc() instead.

Not recommended for new use. This method is not deprecated, but the update-classifiers task is preferred for performance and correctness. This method adds a dependency on this module's artifact with the "javadoc" classifier. If you want to also depend on the main artifact, be sure to also call jar() or use withJavadoc() instead.

Attributes

Inherited from:
ModuleIDExtra (hidden)

Do not follow dependencies of this module. Synonym for intransitive.

Do not follow dependencies of this module. Synonym for intransitive.

Attributes

Inherited from:
ModuleIDExtra (hidden)

Attributes

Inherited from:
ModuleIDExtra (hidden)

Not recommended for new use. This method is not deprecated, but the update-classifiers task is preferred for performance and correctness. This method adds a dependency on this module's artifact with the "sources" classifier. If you want to also depend on the main artifact, be sure to also call jar() or use withSources() instead.

Not recommended for new use. This method is not deprecated, but the update-classifiers task is preferred for performance and correctness. This method adds a dependency on this module's artifact with the "sources" classifier. If you want to also depend on the main artifact, be sure to also call jar() or use withSources() instead.

Attributes

Inherited from:
ModuleIDExtra (hidden)
protected def toStringImpl: String

Attributes

Inherited from:
ModuleIDExtra (hidden)

Not recommended for new use. This method is not deprecated, but the update-classifiers task is preferred for performance and correctness. This method adds a dependency on this module's artifact with the "javadoc" classifier. If there is not already an explicit dependency on the main artifact, this adds one.

Not recommended for new use. This method is not deprecated, but the update-classifiers task is preferred for performance and correctness. This method adds a dependency on this module's artifact with the "javadoc" classifier. If there is not already an explicit dependency on the main artifact, this adds one.

Attributes

Inherited from:
ModuleIDExtra (hidden)

Not recommended for new use. This method is not deprecated, but the update-classifiers task is preferred for performance and correctness. This method adds a dependency on this module's artifact with the "sources" classifier. If there is not already an explicit dependency on the main artifact, this adds one.

Not recommended for new use. This method is not deprecated, but the update-classifiers task is preferred for performance and correctness. This method adds a dependency on this module's artifact with the "sources" classifier. If there is not already an explicit dependency on the main artifact, this adds one.

Attributes

Inherited from:
ModuleIDExtra (hidden)

Deprecated and Inherited methods

def cross(v: Boolean): ModuleID

Attributes

Deprecated
true
Inherited from:
ModuleIDExtra (hidden)

Concrete fields

val branchName: Option[String]
val configurations: Option[String]
val extraAttributes: Map[String, String]
val isChanging: Boolean
val isForce: Boolean
val isTransitive: Boolean
val name: String
val organization: String
val revision: String