Main Settings
API
Generated with
Main Settings/sbt/TaskKey

TaskKey

sbt.TaskKey
See theTaskKey companion object
sealed abstract class TaskKey[A1] extends ScopedTaskable[A1], KeyedInitialize[Task[A1]], ScopingSetting[TaskKey[A1]], DefinableTask[A1]

Identifies a task. It consists of three parts: the scope, the name, and the type of the value computed by a task associated with this key. The scope is represented by a value of type Scope. The name and the type are represented by a value of type AttributeKey[Task[T]]. Instances are constructed using the companion object.

Attributes

Companion
object
Graph
Supertypes
trait DefinableTask[A1]
trait ScopingSetting[TaskKey[A1]]
trait KeyedInitialize[Task[A1]]
trait Keyed[Task[A1], Task[A1]]
trait Initialize[Task[A1]]
trait ScopedTaskable[A1]
trait Taskable[A1]
trait Scoped
trait Equals
class Object
trait Matchable
class Any
Show all

Members list

Value members

Concrete methods

inline def ++=[A2](inline vs: A2)(using Values[A1, A2]): Setting[Task[A1]]

Appends a sequence of values to the task key.

Appends a sequence of values to the task key.

Attributes

inline def +=[A2](inline v: A2)(using Value[A1, A2]): Setting[Task[A1]]

Appends a single value to the task key.

Appends a single value to the task key.

Attributes

final inline def --=[A2](vs: A2)(using r: Values[A1, A2]): Setting[Task[A1]]
final inline def -=[A2](v: A2)(using Value[A1, A2]): Setting[Task[A1]]
inline def <++=[A2](vs: Initialize[Task[A2]]): Setting[Task[A1]]
inline def <+=[A2](v: Initialize[Task[A2]]): Setting[Task[A1]]
inline def append1[A2](v: Initialize[Task[A2]])(using ev: Value[A1, A2]): Setting[Task[A1]]
inline def appendN[A2](vs: Initialize[Task[A2]])(using ev: Values[A1, A2]): Setting[Task[A1]]
def canEqual(that: Any): Boolean
inline def make[A2](other: Initialize[Task[A2]], source: SourcePosition)(f: (A1, A2) => A1): Setting[Task[A1]]
inline def make[A2](other: Initialize[Task[A2]])(f: (A1, A2) => A1): Setting[Task[A1]]
final inline def remove1[A2](v: Initialize[Task[A2]])(using ev: Value[A1, A2]): Setting[Task[A1]]
final inline def removeN[A2](vs: Initialize[Task[A2]])(using ev: Values[A1, A2]): Setting[Task[A1]]
def scopedKey: ScopedKey[Task[A1]]
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 toTask: Initialize[Task[A1]]
final def withRank(rank: Int): TaskKey[A1]

Inherited methods

final def /[K](subkey: ScopingSetting[K]): K

Attributes

Inherited from:
Scoped
inline def :=(inline a: A1): Setting[Task[A1]]

Attributes

Inherited from:
DefinableTask
inline def <<=(app: Initialize[Task[A1]]): Setting[Task[A1]]

Attributes

Inherited from:
DefinableTask
def ?: Initialize[Task[Option[A1]]]

A symbolic alias for option.

A symbolic alias for option.

Attributes

Inherited from:
DefinableTask
def ??[A2 >: A1](or: => A2): Initialize[Task[A2]]

Attributes

Inherited from:
DefinableTask
final override def apply[A2](g: Task[A1] => A2): Init.this.Initialize[A2]

Attributes

Definition Classes
KeyedInitialize -> Initialize
Inherited from:
KeyedInitialize
final override def dependencies: Seq[Init.this.ScopedKey[_]]

Attributes

Definition Classes
Keyed -> Initialize
Inherited from:
Keyed
override def equals(that: 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
Scoped -> Equals -> Any
Inherited from:
Scoped
final override def evaluate(ss: Settings): Task[A1]

Attributes

Definition Classes
KeyedInitialize -> Initialize
Inherited from:
KeyedInitialize
def get(settings: Settings): Option[Task[A1]]

Attributes

Inherited from:
DefinableTask
def getOrElse[A2 >: A1](or: => A2): Initialize[Task[A2]]

Attributes

Inherited from:
DefinableTask
override def hashCode(): Int

Calculates a hash code value for the object.

Calculates 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
Scoped -> Any
Inherited from:
Scoped
final override def mapConstant(g: MapConstant): Init.this.Initialize[Task[A1]]

Attributes

Definition Classes
KeyedInitialize -> Initialize
Inherited from:
KeyedInitialize
final override def mapReferenced(g: MapScoped): Init.this.Initialize[Task[A1]]

Attributes

Definition Classes
KeyedInitialize -> Initialize
Inherited from:
KeyedInitialize
def option: Initialize[Task[Option[A1]]]

Creates an Def.Initialize with value scala.None if there was no previous definition of this key, and scala.Some(value) if a definition exists. Useful for when you want to use the ''existence'' of one setting in order to define another setting.

Creates an Def.Initialize with value scala.None if there was no previous definition of this key, and scala.Some(value) if a definition exists. Useful for when you want to use the ''existence'' of one setting in order to define another setting.

Attributes

Returns

currently bound value wrapped in Initialize[Some[T]], or Initialize[None] if unbound.

Inherited from:
DefinableTask
infix def or[A2 >: A1](i: Initialize[Task[A2]]): Initialize[Task[A2]]

Attributes

Inherited from:
DefinableTask
inline def set(inline app: Initialize[Task[A1]]): Setting[Task[A1]]

In addition to creating Def.setting(...), this captures the source position.

In addition to creating Def.setting(...), this captures the source position.

Attributes

Inherited from:
DefinableTask
inline def taskMacro[A2](inline a: A2): Initialize[Task[A2]]

Internal function for the task macro.

Internal function for the task macro.

Attributes

Inherited from:
DefinableTask
def toSettingKey: SettingKey[Task[A1]]

Attributes

Inherited from:
DefinableTask
inline def transform(f: A1 => A1): Setting[Task[A1]]

Attributes

Inherited from:
DefinableTask
def zip[A2](o: Initialize[A2]): Init.this.Initialize[(Task[A1], A2)]

Attributes

Inherited from:
Initialize
def zipWith[A2, U](o: Initialize[A2])(f: (Task[A1], A2) => U): Init.this.Initialize[U]

Attributes

Inherited from:
Initialize
inline def ~=(inline f: A1 => A1): Setting[Task[A1]]

Attributes

Inherited from:
DefinableTask

Inherited and Abstract methods

def scope: Scope

Attributes

Inherited from:
Scoped

Abstract fields

val key: AttributeKey[Task[A1]]
Generated with