Packages

c

com.github.pshirshov.izumi.distage.planning

AssignableFromAutoSetHook

class AssignableFromAutoSetHook[INSTANCE, BINDING] extends PlanningHook

A hook that will collect all implementations with types that are

_ <: T

into a Set[T] set binding available for summoning

Usage:

val collectCloseables = new AssignableFromAutoSetHook[AutoCloseable, AutoCloseable](identity)

val injector = Injector(new BootstrapModuleDef {
  many[PlanningHook]
    .add(collectCloseables)
})

Then, in any class created from injector:

class App(allCloseables: Set[AutoCloseable]) {
  ...
}

These Auto-Sets can be used to implement custom lifetimes:

val locator = injector.produce(modules)

val closeables = locator.get[Set[AutoCloseable]]
try { locator.get[App].runMain() } finally {
  // reverse closeables list, Auto-Sets preserve order, in the order of *initialization*
  // Therefore resources should closed in the *opposite order*
  // e.g. if C depends on B depends on A, create: A -> B -> C, close: C -> B -> A
  closeables.reverse.foreach(_.close())
}

Auto-Sets are NOT subject to Garbage Collection, they are assembled *after* garbage collection is done, as such they can't contain garbage by construction.

_ <: T }}} available for summoning

Usage:

val collectCloseables = new AssignableFromAutoSetHook[AutoCloseable, AutoCloseable](identity)

val injector = Injector(new BootstrapModuleDef {
  many[PlanningHook]
    .add(collectCloseables)
})

Then, in any class created from injector:

class App(allCloseables: Set[AutoCloseable]) {
  ...
}

These Auto-Sets can be used to implement custom lifetimes:

val locator = injector.produce(modules)

val closeables = locator.get[Set[AutoCloseable]]
try { locator.get[App].runMain() } finally {
  // reverse closeables list, Auto-Sets preserve order, in the order of *initialization*
  // Therefore resources should closed in the *opposite order*
  // e.g. if C depends on B depends on A, create: A -> B -> C, close: C -> B -> A
  closeables.reverse.foreach(_.close())
}

Auto-Sets are NOT subject to Garbage Collection, they are assembled *after* garbage collection is done, as such they can't contain garbage by construction.

Linear Supertypes
PlanningHook, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. AssignableFromAutoSetHook
  2. PlanningHook
  3. AnyRef
  4. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

  1. new AssignableFromAutoSetHook(wrap: (INSTANCE) => BINDING)(implicit arg0: model.reflection.universe.RuntimeDIUniverse.Tag[INSTANCE], arg1: model.reflection.universe.RuntimeDIUniverse.Tag[BINDING])

Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  4. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  5. def clone(): AnyRef
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @native()
  6. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  7. def equals(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef → Any
  8. def finalize(): Unit
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.Throwable])
  9. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  10. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  11. def hookDefinition(defn: ModuleBase): ModuleBase
    Definition Classes
    PlanningHook
  12. def hookWiring(binding: ImplBinding, wiring: model.reflection.universe.RuntimeDIUniverse.Wiring): model.reflection.universe.RuntimeDIUniverse.Wiring
    Definition Classes
    PlanningHook
  13. val instanceType: model.reflection.universe.RuntimeDIUniverse.SafeType
    Attributes
    protected
  14. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  15. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  16. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  17. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  18. def phase00PostCompletion(plan: DodgyPlan): DodgyPlan
    Definition Classes
    PlanningHook
  19. def phase10PostGC(plan: SemiPlan): SemiPlan
    Definition Classes
    PlanningHook
  20. def phase20Customization(plan: SemiPlan): SemiPlan
    Definition Classes
    PlanningHook
  21. def phase45PreForwardingCleanup(plan: SemiPlan): SemiPlan
    Definition Classes
    AssignableFromAutoSetHook → PlanningHook
  22. def phase50PreForwarding(plan: SemiPlan): SemiPlan
    Definition Classes
    AssignableFromAutoSetHook → PlanningHook
  23. def phase90AfterForwarding(plan: OrderedPlan): OrderedPlan
    Definition Classes
    AssignableFromAutoSetHook → PlanningHook
  24. val setElemetType: model.reflection.universe.RuntimeDIUniverse.SafeType
    Attributes
    protected
  25. val setKey: model.reflection.universe.RuntimeDIUniverse.DIKey
    Attributes
    protected
  26. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  27. def toString(): String
    Definition Classes
    AnyRef → Any
  28. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  29. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  30. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()

Inherited from PlanningHook

Inherited from AnyRef

Inherited from Any

Ungrouped