luke
/
sbt
mirror of https://github.com/sbt/sbt.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Initial scaladoc Initialize/Keyed/KeyedInitialize

This commit is contained in:
Dale Wijnand 2017-10-12 15:11:26 +01:00
parent 10397926aa
commit 86be5359e7
No known key found for this signature in database
GPG Key ID: 4F256E3D151DF5EF
1 changed files with 15 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

15
internal/util-collection/src/main/scala/sbt/internal/util/Settings.scala
View File

@ -534,6 +534,14 @@ trait Init[Scope] {
}
}
/** Abstractly defines a value of type `T`.
*
* Specifically it defines a node in a task graph,
* where the `dependencies` represents dependent nodes,
* and `evaluate` represents the calculation based on the existing body of knowledge.
*
* @tparam T the type of the value this defines.
*/
sealed trait Initialize[T] {
def dependencies: Seq[ScopedKey[_]]
def apply[S](g: T => S): Initialize[S]
@ -698,6 +706,10 @@ trait Init[Scope] {
private[this] def deps(ls: Seq[Initialize[_]]): Seq[ScopedKey[_]] = ls.flatMap(_.dependencies)
/** An `Initialize[T]` associated with a `ScopedKey[S]`.
* @tparam S the type of the associated `ScopedKey`
* @tparam T the type of the value this `Initialize` defines.
*/
sealed trait Keyed[S, T] extends Initialize[T] {
def scopedKey: ScopedKey[S]
def transform: S => T
@ -724,6 +736,9 @@ trait Init[Scope] {
private[this] final class GetValue[S, T](val scopedKey: ScopedKey[S], val transform: S => T)
extends Keyed[S, T]
/** A `Keyed` where the type of the value and the associated `ScopedKey` are the same.
* @tparam T the type of both the value this `Initialize` defines and the type of the associated `ScopedKey`.
*/
trait KeyedInitialize[T] extends Keyed[T, T] {
final val transform = idFun[T]
}