BuildTarget

sbt.internal.bsp.BuildTarget
See theBuildTarget companion object
final class BuildTarget extends Serializable

Build target

Value parameters

baseDirectory

The directory where this target belongs to. Multiple build targets are allowed to map to the same base directory, and a build target is not required to have a base directory. A base directory does not determine the sources of a target, see buildTarget/sources.

capabilities

The capabilities of this build target.

data

Language-specific metadata about this target. See ScalaBuildTarget as an example.

dataKind

Kind of data to expect in the data field. If this field is not set, the kind of data is not specified.

dependencies

The direct upstream build target dependencies of this build target

displayName

A human readable name for this target. May be presented in the user interface. Should be unique if possible. The id.uri is used if None.

id

The target’s unique identifier

languageIds

The set of languages that this target contains. The ID string for each language is defined in the LSP.

tags

Free-form string tags to categorize or label this build target. For example, can be used by the client to: - customize how the target should be translated into the client's project model. - group together different but related targets in the user interface. - display icons or colors in the user interface. Pre-defined tags are listed in BuildTargetTag but clients and servers are free to define new tags for custom purposes.

Attributes

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

Members list

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)).

Value parameters

that

the object to compare against this object for equality.

Attributes

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 withBaseDirectory(baseDirectory: Option[URI]): BuildTarget
def withBaseDirectory(baseDirectory: URI): BuildTarget
def withData(data: Option[JValue]): BuildTarget
def withData(data: JValue): BuildTarget
def withDataKind(dataKind: Option[String]): BuildTarget
def withDataKind(dataKind: String): BuildTarget
def withDependencies(dependencies: Vector[BuildTargetIdentifier]): BuildTarget
def withDisplayName(displayName: Option[String]): BuildTarget
def withDisplayName(displayName: String): BuildTarget
def withLanguageIds(languageIds: Vector[String]): BuildTarget
def withTags(tags: Vector[String]): BuildTarget

Concrete fields

val baseDirectory: Option[URI]
val data: Option[JValue]
val dataKind: Option[String]
val displayName: Option[String]
val languageIds: Vector[String]
val tags: Vector[String]