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.
- Alphabetic
- By Inheritance
- SettingKey
- DefinableSetting
- ScopingSetting
- KeyedInitialize
- Keyed
- Initialize
- ScopedTaskable
- Taskable
- Scoped
- Equals
- AnyRef
- Any
- Hide All
- Show All
- Public
- All
Abstract Value Members
-
abstract
val
key: AttributeKey[T]
- Definition Classes
- SettingKey → Scoped
-
abstract
def
scope: Scope
- Definition Classes
- Scoped
Concrete Value Members
-
final
def
!=(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
-
final
def
##(): Int
- Definition Classes
- AnyRef → Any
- final macro def ++=[U](vs: U)(implicit a: Values[T, U]): Def.Setting[T]
- final macro def +=[U](v: U)(implicit a: Append.Value[T, U]): Def.Setting[T]
- final macro def --=[U](vs: U)(implicit r: Values[T, U]): Def.Setting[T]
- final macro def -=[U](v: U)(implicit r: Remove.Value[T, U]): Def.Setting[T]
- final macro def :=(v: T): Def.Setting[T]
- final macro def <++=[V](vs: Def.Initialize[V])(implicit a: Values[T, V]): Def.Setting[T]
- final macro def <+=[V](v: Def.Initialize[V])(implicit a: Append.Value[T, V]): Def.Setting[T]
-
final macro
def
<<=(app: Def.Initialize[T]): Def.Setting[T]
- Definition Classes
- DefinableSetting
-
final
def
==(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
-
final
def
?: Def.Initialize[Option[T]]
Creates an Def.Initialize with value
scala.None
if there was no previous definition of this key, andscala.Some(value)
if a definition exists.Creates an Def.Initialize with value
scala.None
if there was no previous definition of this key, andscala.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]]
, orInitialize[None]
if unbound.
- Definition Classes
- DefinableSetting
-
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
- final def append1[V](v: Def.Initialize[V], source: SourcePosition)(implicit a: Append.Value[T, V]): Def.Setting[T]
- final def appendN[V](vs: Def.Initialize[V], source: SourcePosition)(implicit a: Values[T, V]): Def.Setting[T]
-
final
def
apply[Z](g: (T) ⇒ Z): Def.Initialize[Z]
- Definition Classes
- Keyed → Initialize
-
final
def
asInstanceOf[T0]: T0
- Definition Classes
- Any
-
def
canEqual(that: Any): Boolean
- Definition Classes
- SettingKey → Equals
-
def
clone(): AnyRef
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws( ... ) @native()
-
final
def
dependencies: List[Def.ScopedKey[T]]
- Definition Classes
- Keyed → Initialize
-
final
def
eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
-
def
equals(that: Any): Boolean
- Definition Classes
- Scoped → Equals → AnyRef → Any
-
final
def
evaluate(ss: Settings[Scope]): T
- Definition Classes
- Keyed → Initialize
-
def
finalize(): Unit
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws( classOf[java.lang.Throwable] )
-
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
-
final
def
getClass(): Class[_]
- Definition Classes
- AnyRef → Any
- Annotations
- @native()
-
def
hashCode(): Int
- Definition Classes
- Scoped → AnyRef → Any
-
final
def
in(scope: Scope): SettingKey[T]
- Definition Classes
- SettingKey → ScopingSetting
-
final
def
isInstanceOf[T0]: Boolean
- Definition Classes
- Any
-
def
make[S](other: Def.Initialize[S], source: SourcePosition)(f: (T, S) ⇒ T): Def.Setting[T]
- Attributes
- protected[this]
-
final
def
mapConstant(g: Def.MapConstant): Def.Initialize[T]
- Definition Classes
- Keyed → Initialize
-
final
def
mapReferenced(g: Def.MapScoped): Def.Initialize[T]
- Definition Classes
- Keyed → Initialize
-
final
def
ne(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
-
final
def
notify(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native()
-
final
def
notifyAll(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native()
-
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
- final def remove1[V](v: Def.Initialize[V], source: SourcePosition)(implicit r: Remove.Value[T, V]): Def.Setting[T]
- final def removeN[V](vs: Def.Initialize[V], source: SourcePosition)(implicit r: Values[T, V]): Def.Setting[T]
-
final
def
scopedKey: Def.ScopedKey[T]
- Definition Classes
- SettingKey → DefinableSetting → Keyed
-
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
-
final
def
synchronized[T0](arg0: ⇒ T0): T0
- Definition Classes
- AnyRef
-
def
toString(): String
- Definition Classes
- SettingKey → AnyRef → Any
-
final
def
toTask: Def.Initialize[Task[T]]
- Definition Classes
- SettingKey → Taskable
- final def transform(f: (T) ⇒ T, source: SourcePosition): Def.Setting[T]
-
final
val
transform: (T) ⇒ T
- Definition Classes
- KeyedInitialize → Keyed
-
final
def
wait(): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws( ... )
-
final
def
wait(arg0: Long, arg1: Int): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws( ... )
-
final
def
wait(arg0: Long): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws( ... ) @native()
- final def withRank(rank: Int): SettingKey[T]
-
def
zip[S](o: Def.Initialize[S]): Def.Initialize[(T, S)]
- Definition Classes
- Initialize
-
def
zipWith[S, U](o: Def.Initialize[S])(f: (T, S) ⇒ U): Def.Initialize[U]
- Definition Classes
- Initialize
- final macro def ~=(f: (T) ⇒ T): Def.Setting[T]
Deprecated Value Members
-
def
in(p: ScopeAxis[Reference], c: ScopeAxis[ConfigKey], t: ScopeAxis[AttributeKey[_]]): SettingKey[T]
- Definition Classes
- ScopingSetting
- Annotations
- @deprecated
- Deprecated
(Since version 1.5.0)
-
def
in(p: Reference, c: ConfigKey, t: Scoped): SettingKey[T]
- Definition Classes
- ScopingSetting
- Annotations
- @deprecated
- Deprecated
(Since version 1.5.0)
-
def
in(p: Reference, t: Scoped): SettingKey[T]
- Definition Classes
- ScopingSetting
- Annotations
- @deprecated
- Deprecated
(Since version 1.5.0)
-
def
in(p: Reference, c: ConfigKey): SettingKey[T]
- Definition Classes
- ScopingSetting
- Annotations
- @deprecated
- Deprecated
(Since version 1.5.0)
-
def
in(c: ConfigKey, t: Scoped): SettingKey[T]
- Definition Classes
- ScopingSetting
- Annotations
- @deprecated
- Deprecated
(Since version 1.5.0)
-
def
in(c: ConfigKey): SettingKey[T]
- Definition Classes
- ScopingSetting
- Annotations
- @deprecated
- Deprecated
(Since version 1.5.0)
-
def
in(t: Scoped): SettingKey[T]
- Definition Classes
- ScopingSetting
- Annotations
- @deprecated
- Deprecated
(Since version 1.5.0)
-
def
in(p: Reference): SettingKey[T]
- Definition Classes
- ScopingSetting
- Annotations
- @deprecated
- Deprecated
(Since version 1.5.0)