Main Settings
API
Generated with
Main Settings/sbt/InputKey

InputKey

sbt.InputKey
See theInputKey companion object
sealed trait InputKey[A1] extends Scoped, KeyedInitialize[InputTask[A1]], ScopingSetting[InputKey[A1]], DefinableSetting[InputTask[A1]]

Identifies an input task. An input task parses input and produces a task to run. It consists of three parts: the scope, the name, and the type of the value produced by an input 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[InputTask[T]]. Instances are constructed using the companion object.

Attributes

Companion
object
Graph
Supertypes
trait Keyed[InputTask[A1], InputTask[A1]]
trait Initialize[InputTask[A1]]
trait Scoped
trait Equals
class Object
trait Matchable
class Any
Show all

Members list

Value members

Concrete methods

final def /[A1](subkey: ScopingSetting[A1]): A1
inline def :=(inline a: A1): Setting[InputTask[A1]]
def canEqual(that: Any): Boolean
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
final inline def transform(f: A1 => A1): Setting[InputTask[A1]]
final def withRank(rank: Int): InputKey[A1]
final inline def ~=(f: A1 => A1): Setting[InputTask[A1]]

Inherited methods

inline def <<=(app: Initialize[InputTask[A1]]): Setting[A1]

Attributes

Inherited from:
DefinableSetting
final def ?: Initialize[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:
DefinableSetting
final def ??[T >: InputTask[A1]](or: => T): Initialize[T]

Like ?, but with a call-by-name parameter rather than an existing Def.Initialize. Useful when you want to have a value computed when no value is bound to this key.

Like ?, but with a call-by-name parameter rather than an existing Def.Initialize. Useful when you want to have a value computed when no value is bound to this key.

Value parameters

or

by-name expression evaluated when a value is needed.

Attributes

Returns

currently bound setting value, or the result of or if unbound.

Inherited from:
DefinableSetting
final override def apply[A2](g: InputTask[A1] => A2): Initialize[A2]

Attributes

Definition Classes
Keyed -> Initialize
Inherited from:
Keyed
final override def dependencies: Seq[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[Scope]): A1

Attributes

Definition Classes
Keyed -> Initialize
Inherited from:
Keyed
final def get(settings: Settings[Scope]): Option[A1]

From the given Settings, extract the value bound to this key.

From the given Settings, extract the value bound to this key.

Attributes

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

Attributes

Definition Classes
Keyed -> Initialize
Inherited from:
Keyed
final override def mapReferenced(g: MapScoped): Initialize[A1]

Attributes

Definition Classes
Keyed -> Initialize
Inherited from:
Keyed
final def or[T >: InputTask[A1]](i: Initialize[T]): Initialize[T]

Creates an Def.Initialize with value bound to this key, or returns i parameter if unbound.

Creates an Def.Initialize with value bound to this key, or returns i parameter if unbound.

Value parameters

i

value to return if this setting doesn't have a value.

Attributes

Returns

currently bound setting value, or i if unbound.

Inherited from:
DefinableSetting
def scope: Scope

Attributes

Inherited from:
Scoped
inline def set(inline app: Initialize[InputTask[A1]]): Setting[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:
DefinableSetting
final def set0(app: Initialize[InputTask[A1]], source: SourcePosition): Setting[A1]

Internally used function for setting a value along with the .sbt file location where it is defined.

Internally used function for setting a value along with the .sbt file location where it is defined.

Attributes

Inherited from:
DefinableSetting
def zip[A2](o: Initialize[A2]): Initialize[(A1, A2)]

Attributes

Inherited from:
Initialize
def zipWith[A2, U](o: Initialize[A2])(f: (InputTask[A1], A2) => U): Initialize[U]

Attributes

Inherited from:
Initialize

Abstract fields

val key: AttributeKey[InputTask[A1]]

Inherited fields

final val transform: InputTask[A1] => InputTask[A1]

Attributes

Inherited from:
KeyedInitialize
Generated with