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
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
    SettingKeyScoped
  2. abstract def scope: Scope
    Definition Classes
    Scoped

Concrete Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int
    Definition Classes
    AnyRef → Any
  3. final macro def ++=[U](vs: U)(implicit a: Values[T, U]): Def.Setting[T]
  4. final macro def +=[U](v: U)(implicit a: Append.Value[T, U]): Def.Setting[T]
  5. final macro def --=[U](vs: U)(implicit r: Values[T, U]): Def.Setting[T]
  6. final macro def -=[U](v: U)(implicit r: Remove.Value[T, U]): Def.Setting[T]
  7. final macro def :=(v: T): Def.Setting[T]
  8. final macro def <++=[V](vs: Def.Initialize[V])(implicit a: Values[T, V]): Def.Setting[T]
  9. final macro def <+=[V](v: Def.Initialize[V])(implicit a: Append.Value[T, V]): Def.Setting[T]
  10. final macro def <<=(app: Def.Initialize[T]): Def.Setting[T]
    Definition Classes
    DefinableSetting
  11. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  12. 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
  13. 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
  14. final def append1[V](v: Def.Initialize[V], source: SourcePosition)(implicit a: Append.Value[T, V]): Def.Setting[T]
  15. final def appendN[V](vs: Def.Initialize[V], source: SourcePosition)(implicit a: Values[T, V]): Def.Setting[T]
  16. final def apply[Z](g: (T) ⇒ Z): Def.Initialize[Z]
    Definition Classes
    KeyedInitialize
  17. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  18. def canEqual(that: Any): Boolean
    Definition Classes
    SettingKey → Equals
  19. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()
  20. final def dependencies: List[Def.ScopedKey[T]]
    Definition Classes
    KeyedInitialize
  21. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  22. def equals(that: Any): Boolean
    Definition Classes
    Scoped → Equals → AnyRef → Any
  23. final def evaluate(ss: Settings[Scope]): T
    Definition Classes
    KeyedInitialize
  24. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  25. 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
  26. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  27. def hashCode(): Int
    Definition Classes
    Scoped → AnyRef → Any
  28. final def in(scope: Scope): SettingKey[T]
    Definition Classes
    SettingKeyScopingSetting
  29. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  30. def make[S](other: Def.Initialize[S], source: SourcePosition)(f: (T, S) ⇒ T): Def.Setting[T]
    Attributes
    protected[this]
  31. final def mapConstant(g: Def.MapConstant): Def.Initialize[T]
    Definition Classes
    KeyedInitialize
  32. final def mapReferenced(g: Def.MapScoped): Def.Initialize[T]
    Definition Classes
    KeyedInitialize
  33. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  34. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  35. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  36. 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
  37. final def remove1[V](v: Def.Initialize[V], source: SourcePosition)(implicit r: Remove.Value[T, V]): Def.Setting[T]
  38. final def removeN[V](vs: Def.Initialize[V], source: SourcePosition)(implicit r: Values[T, V]): Def.Setting[T]
  39. final def scopedKey: Def.ScopedKey[T]
    Definition Classes
    SettingKeyDefinableSettingKeyed
  40. 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
  41. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  42. def toString(): String
    Definition Classes
    SettingKey → AnyRef → Any
  43. final def toTask: Def.Initialize[Task[T]]
    Definition Classes
    SettingKeyTaskable
  44. final def transform(f: (T) ⇒ T, source: SourcePosition): Def.Setting[T]
  45. final val transform: (T) ⇒ T
    Definition Classes
    KeyedInitializeKeyed
  46. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  47. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  48. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()
  49. final def withRank(rank: Int): SettingKey[T]
  50. def zip[S](o: Def.Initialize[S]): Def.Initialize[(T, S)]
    Definition Classes
    Initialize
  51. def zipWith[S, U](o: Def.Initialize[S])(f: (T, S) ⇒ U): Def.Initialize[U]
    Definition Classes
    Initialize
  52. 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)

Inherited from DefinableSetting[T]

Inherited from ScopingSetting[SettingKey[T]]

Inherited from Def.KeyedInitialize[T]

Inherited from Def.Keyed[T, T]

Inherited from Def.Initialize[T]

Inherited from ScopedTaskable[T]

Inherited from Taskable[T]

Inherited from Scoped

Inherited from Equals

Inherited from AnyRef

Inherited from Any

Ungrouped