sbt

SettingKey

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], Scoped, AnyRef, Any
Ordering
  1. Alphabetic
  2. By inheritance
Inherited
  1. SettingKey
  2. DefinableSetting
  3. ScopingSetting
  4. KeyedInitialize
  5. Keyed
  6. Initialize
  7. ScopedTaskable
  8. Scoped
  9. AnyRef
  10. Any
  1. Hide All
  2. Show all
Learn more about member selection
Visibility
  1. Public
  2. All

Instance Constructors

  1. new SettingKey()

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: AnyRef): Boolean

    Definition Classes
    AnyRef
  2. final def !=(arg0: Any): Boolean

    Definition Classes
    Any
  3. final def ##(): Int

    Definition Classes
    AnyRef → Any
  4. final def ++=[U](vs: U)(implicit a: Values[T, U]): Def.Setting[T]

    Annotations
    @macroImpl( ... )
  5. final def +=[U](v: U)(implicit a: Append.Value[T, U]): Def.Setting[T]

    Annotations
    @macroImpl( ... )
  6. final def --=[U](vs: U)(implicit r: Values[T, U]): Def.Setting[T]

    Annotations
    @macroImpl( ... )
  7. final def -=[U](v: U)(implicit r: Remove.Value[T, U]): Def.Setting[T]

    Annotations
    @macroImpl( ... )
  8. final def :=(v: T): Def.Setting[T]

    Annotations
    @macroImpl( ... )
  9. final def <++=[V](vs: Def.Initialize[V])(implicit a: Values[T, V]): Def.Setting[T]

    Annotations
    @macroImpl( ... )
  10. final def <+=[V](v: Def.Initialize[V])(implicit a: Append.Value[T, V]): Def.Setting[T]

    Annotations
    @macroImpl( ... )
  11. final def <<=(app: Def.Initialize[T]): Def.Setting[T]

    Binds a single value to this.

    Binds a single value to this. A new [Def.Setting] is defined using the value(s) of app.

    app

    value to bind to this key

    returns

    setting binding this key to the given value.

    Definition Classes
    DefinableSetting
    Annotations
    @macroImpl( ... )
  12. final def ==(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef
  13. final def ==(arg0: Any): Boolean

    Definition Classes
    Any
  14. 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
  15. 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
  16. final def append1[V](v: Def.Initialize[V], source: SourcePosition)(implicit a: Append.Value[T, V]): Def.Setting[T]

  17. final def appendN[V](vs: Def.Initialize[V], source: SourcePosition)(implicit a: Values[T, V]): Def.Setting[T]

  18. final def apply[Z](g: (T) ⇒ Z): Def.Initialize[Z]

    Definition Classes
    KeyedInitialize
  19. final def asInstanceOf[T0]: T0

    Definition Classes
    Any
  20. def clone(): AnyRef

    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  21. final def dependencies: List[Def.ScopedKey[T]]

    Definition Classes
    KeyedInitialize
  22. final def eq(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef
  23. def equals(arg0: Any): Boolean

    Definition Classes
    AnyRef → Any
  24. final def evaluate(ss: Settings[Scope]): T

    Definition Classes
    KeyedInitialize
  25. def finalize(): Unit

    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  26. 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
  27. final def getClass(): Class[_]

    Definition Classes
    AnyRef → Any
  28. def hashCode(): Int

    Definition Classes
    AnyRef → Any
  29. final def in(scope: Scope): SettingKey[T]

    Definition Classes
    SettingKeyScopingSetting
  30. def in(p: ScopeAxis[Reference], c: ScopeAxis[ConfigKey], t: ScopeAxis[AttributeKey[_]]): SettingKey[T]

    Definition Classes
    ScopingSetting
  31. def in(p: Reference, c: ConfigKey, t: Scoped): SettingKey[T]

    Definition Classes
    ScopingSetting
  32. def in(p: Reference, t: Scoped): SettingKey[T]

    Definition Classes
    ScopingSetting
  33. def in(p: Reference, c: ConfigKey): SettingKey[T]

    Definition Classes
    ScopingSetting
  34. def in(c: ConfigKey, t: Scoped): SettingKey[T]

    Definition Classes
    ScopingSetting
  35. def in(c: ConfigKey): SettingKey[T]

    Definition Classes
    ScopingSetting
  36. def in(t: Scoped): SettingKey[T]

    Definition Classes
    ScopingSetting
  37. def in(p: Reference): SettingKey[T]

    Definition Classes
    ScopingSetting
  38. final def isInstanceOf[T0]: Boolean

    Definition Classes
    Any
  39. def make[S](other: Def.Initialize[S], source: SourcePosition)(f: (T, S) ⇒ T): Def.Setting[T]

    Attributes
    protected[this]
  40. final def mapConstant(g: Def.MapConstant): Def.Initialize[T]

    Definition Classes
    KeyedInitialize
  41. final def mapReferenced(g: Def.MapScoped): Def.Initialize[T]

    Definition Classes
    KeyedInitialize
  42. final def ne(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef
  43. final def notify(): Unit

    Definition Classes
    AnyRef
  44. final def notifyAll(): Unit

    Definition Classes
    AnyRef
  45. 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
  46. final def remove1[V](v: Def.Initialize[V], source: SourcePosition)(implicit r: Remove.Value[T, V]): Def.Setting[T]

  47. final def removeN[V](vs: Def.Initialize[V], source: SourcePosition)(implicit r: Values[T, V]): Def.Setting[T]

  48. final def scopedKey: Def.ScopedKey[T]

    Definition Classes
    SettingKeyDefinableSettingKeyed
  49. 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
  50. final def synchronized[T0](arg0: ⇒ T0): T0

    Definition Classes
    AnyRef
  51. def toString(): String

    Definition Classes
    AnyRef → Any
  52. final def toTask: Def.Initialize[Task[T]]

    Definition Classes
    SettingKeyScopedTaskable
  53. final def transform(f: (T) ⇒ T, source: SourcePosition): Def.Setting[T]

  54. final val transform: (T) ⇒ T

    Definition Classes
    KeyedInitializeKeyed
  55. final def wait(): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  56. final def wait(arg0: Long, arg1: Int): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  57. final def wait(arg0: Long): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  58. def zip[S](o: Def.Initialize[S]): Def.Initialize[(T, S)]

    Definition Classes
    Initialize
  59. def zipWith[S, U](o: Def.Initialize[S])(f: (T, S) ⇒ U): Def.Initialize[U]

    Definition Classes
    Initialize
  60. final def ~=(f: (T) ⇒ T): Def.Setting[T]

    Annotations
    @macroImpl( ... )

Deprecated Value Members

  1. def validateReferenced(g: Def.ValidateRef): Def.ValidatedInit[T]

    Definition Classes
    Initialize
    Annotations
    @deprecated
    Deprecated

    (Since version 0.13.2) Will be made private.

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 Scoped

Inherited from AnyRef

Inherited from Any

Ungrouped