Packages

sealed abstract class SettingKey[T] extends ScopedTaskable[T] with sbt.Def.KeyedInitialize[T] with ScopingSetting[SettingKey[T]] with DefinableSetting[T]

Identifies a setting. It consists of three parts: the scope, the name, and the type of a value 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[T]. Instances are constructed using the companion object.

Linear Supertypes
DefinableSetting[T], ScopingSetting[SettingKey[T]], Def.KeyedInitialize[T], Def.Keyed[T, T], Def.Initialize[T], ScopedTaskable[T], Taskable[T], Scoped, Equals, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. SettingKey
  2. DefinableSetting
  3. ScopingSetting
  4. KeyedInitialize
  5. Keyed
  6. Initialize
  7. ScopedTaskable
  8. Taskable
  9. Scoped
  10. Equals
  11. AnyRef
  12. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Abstract Value Members

  1. abstract val key: AttributeKey[T]
    Definition Classes
    SettingKey → Scoped
  2. abstract def scope: Scope
    Definition Classes
    Scoped

Concrete Value Members

  1. final macro def ++=[U](vs: U)(implicit a: Values[T, U]): Def.Setting[T]
  2. final macro def +=[U](v: U)(implicit a: Append.Value[T, U]): Def.Setting[T]
  3. final macro def --=[U](vs: U)(implicit r: Values[T, U]): Def.Setting[T]
  4. final macro def -=[U](v: U)(implicit r: Remove.Value[T, U]): Def.Setting[T]
  5. final macro def :=(v: T): Def.Setting[T]
  6. final macro def <++=[V](vs: Def.Initialize[V])(implicit a: Values[T, V]): Def.Setting[T]
  7. final macro def <+=[V](v: Def.Initialize[V])(implicit a: Append.Value[T, V]): Def.Setting[T]
  8. final macro def <<=(app: Def.Initialize[T]): Def.Setting[T]
    Definition Classes
    DefinableSetting
  9. final def ?: Def.Initialize[Option[T]]

    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.

    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.

    returns

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

    Definition Classes
    DefinableSetting
  10. final def ??[T >: T](or: ⇒ T): Def.Initialize[T]

    Like ?, but with a call-by-name parameter rather than an existing Def.Initialize.

    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.

    or

    by-name expression evaluated when a value is needed.

    returns

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

    Definition Classes
    DefinableSetting
  11. final def append1[V](v: Def.Initialize[V], source: SourcePosition)(implicit a: Append.Value[T, V]): Def.Setting[T]
  12. final def appendN[V](vs: Def.Initialize[V], source: SourcePosition)(implicit a: Values[T, V]): Def.Setting[T]
  13. final def apply[Z](g: (T) ⇒ Z): Def.Initialize[Z]
    Definition Classes
    Keyed → Initialize
  14. def canEqual(that: Any): Boolean
    Definition Classes
    SettingKey → Equals
  15. final def dependencies: List[Def.ScopedKey[T]]
    Definition Classes
    Keyed → Initialize
  16. def equals(that: Any): Boolean
    Definition Classes
    Scoped → Equals → AnyRef → Any
  17. final def evaluate(ss: Settings[Scope]): T
    Definition Classes
    Keyed → Initialize
  18. final def get(settings: Settings[Scope]): Option[T]

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

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

    Definition Classes
    DefinableSetting
  19. def hashCode(): Int
    Definition Classes
    Scoped → AnyRef → Any
  20. final def in(scope: Scope): SettingKey[T]
    Definition Classes
    SettingKey → ScopingSetting
  21. final def mapConstant(g: Def.MapConstant): Def.Initialize[T]
    Definition Classes
    Keyed → Initialize
  22. final def mapReferenced(g: Def.MapScoped): Def.Initialize[T]
    Definition Classes
    Keyed → Initialize
  23. final def or[T >: T](i: Def.Initialize[T]): Def.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.

    i

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

    returns

    currently bound setting value, or i if unbound.

    Definition Classes
    DefinableSetting
  24. final def remove1[V](v: Def.Initialize[V], source: SourcePosition)(implicit r: Remove.Value[T, V]): Def.Setting[T]
  25. final def removeN[V](vs: Def.Initialize[V], source: SourcePosition)(implicit r: Values[T, V]): Def.Setting[T]
  26. final def scopedKey: Def.ScopedKey[T]
    Definition Classes
    SettingKey → DefinableSetting → Keyed
  27. final def set(app: Def.Initialize[T], source: SourcePosition): Def.Setting[T]

    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.

    Definition Classes
    DefinableSetting
  28. def toString(): String
    Definition Classes
    SettingKey → AnyRef → Any
  29. final def toTask: Def.Initialize[Task[T]]
    Definition Classes
    SettingKey → Taskable
  30. final def transform(f: (T) ⇒ T, source: SourcePosition): Def.Setting[T]
  31. final val transform: (T) ⇒ T
    Definition Classes
    KeyedInitialize → Keyed
  32. final def withRank(rank: Int): SettingKey[T]
  33. def zip[S](o: Def.Initialize[S]): Def.Initialize[(T, S)]
    Definition Classes
    Initialize
  34. def zipWith[S, U](o: Def.Initialize[S])(f: (T, S) ⇒ U): Def.Initialize[U]
    Definition Classes
    Initialize
  35. final macro def ~=(f: (T) ⇒ T): Def.Setting[T]

Deprecated Value Members

  1. def in(p: ScopeAxis[Reference], c: ScopeAxis[ConfigKey], t: ScopeAxis[AttributeKey[_]]): SettingKey[T]
    Definition Classes
    ScopingSetting
    Annotations
    @deprecated
    Deprecated

    (Since version 1.5.0)

  2. def in(p: Reference, c: ConfigKey, t: Scoped): SettingKey[T]
    Definition Classes
    ScopingSetting
    Annotations
    @deprecated
    Deprecated

    (Since version 1.5.0)

  3. def in(p: Reference, t: Scoped): SettingKey[T]
    Definition Classes
    ScopingSetting
    Annotations
    @deprecated
    Deprecated

    (Since version 1.5.0)

  4. def in(p: Reference, c: ConfigKey): SettingKey[T]
    Definition Classes
    ScopingSetting
    Annotations
    @deprecated
    Deprecated

    (Since version 1.5.0)

  5. def in(c: ConfigKey, t: Scoped): SettingKey[T]
    Definition Classes
    ScopingSetting
    Annotations
    @deprecated
    Deprecated

    (Since version 1.5.0)

  6. def in(c: ConfigKey): SettingKey[T]
    Definition Classes
    ScopingSetting
    Annotations
    @deprecated
    Deprecated

    (Since version 1.5.0)

  7. def in(t: Scoped): SettingKey[T]
    Definition Classes
    ScopingSetting
    Annotations
    @deprecated
    Deprecated

    (Since version 1.5.0)

  8. def in(p: Reference): SettingKey[T]
    Definition Classes
    ScopingSetting
    Annotations
    @deprecated
    Deprecated

    (Since version 1.5.0)