Class/Object

de.sebbraun.lifecycle.simple

ComponentSpec

Related Docs: object ComponentSpec | package simple

Permalink

class ComponentSpec[Starter <: State, Stopper <: State] extends AnyRef

A specification of the relevant information to guide component creation.

Starter

A phantom type parameter to mark whether the start action has been specified.

Stopper

A phantom type parameter to mark whether the stop action has been specified.

See also

LifecycleManager.component

Linear Supertypes
AnyRef, Any
Ordering
  1. Grouped
  2. Alphabetic
  3. By Inheritance
Inherited
  1. ComponentSpec
  2. AnyRef
  3. Any
Implicitly
  1. by ComponentFactoryStopperSpec
  2. by ComponentFactoryStarterSpec
  3. by any2stringadd
  4. by StringFormat
  5. by Ensuring
  6. by ArrowAssoc
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

  1. new ComponentSpec()

    Permalink

Value Members

  1. final def !=(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any

  2. final def ##(): Int

    Permalink
    Definition Classes
    AnyRef → Any

  3. def +(other: String): String

    Permalink
    Implicit information
    This member is added by an implicit conversion from ComponentSpec[Starter, Stopper] to any2stringadd[ComponentSpec[Starter, Stopper]] performed by method any2stringadd in scala.Predef.
    Definition Classes
    any2stringadd

  4. def ->[B](y: B): (ComponentSpec[Starter, Stopper], B)

    Permalink
    Implicit information
    This member is added by an implicit conversion from ComponentSpec[Starter, Stopper] to ArrowAssoc[ComponentSpec[Starter, Stopper]] performed by method ArrowAssoc in scala.Predef. This conversion will take place only if Starter is Unspecified (Starter =:= Unspecified) and at the same time Stopper is Unspecified (Stopper =:= Unspecified).
    Definition Classes
    ArrowAssoc
    Annotations
    @inline()

  5. final def ==(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any

  6. final def asInstanceOf[T0]: T0

    Permalink
    Definition Classes
    Any

  7. def clone(): AnyRef

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  8. def depend(deps: Dependency*): ComponentSpec.this.type

    Permalink

    Define a dependency to be satisfied before the component can start.

    Define a dependency to be satisfied before the component can start.

    deps

    The dependencies to wait for before start. Note that there is an implicit conversion from LifecycleComponent. To disable keep-alive behaviour, use <COMPONENT>.noKeepAlive.

    returns

    this instance

    See also

    LifecycleComponent.Component2DependencyOps.keepAlive, LifecycleComponent.Component2DependencyOps.noKeepAlive

  9. def ensuring(cond: (ComponentSpec[Starter, Stopper]) ⇒ Boolean, msg: ⇒ Any): ComponentSpec[Starter, Stopper]

    Permalink
    Implicit information
    This member is added by an implicit conversion from ComponentSpec[Starter, Stopper] to Ensuring[ComponentSpec[Starter, Stopper]] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring

  10. def ensuring(cond: (ComponentSpec[Starter, Stopper]) ⇒ Boolean): ComponentSpec[Starter, Stopper]

    Permalink
    Implicit information
    This member is added by an implicit conversion from ComponentSpec[Starter, Stopper] to Ensuring[ComponentSpec[Starter, Stopper]] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring

  11. def ensuring(cond: Boolean, msg: ⇒ Any): ComponentSpec[Starter, Stopper]

    Permalink
    Implicit information
    This member is added by an implicit conversion from ComponentSpec[Starter, Stopper] to Ensuring[ComponentSpec[Starter, Stopper]] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring

  12. def ensuring(cond: Boolean): ComponentSpec[Starter, Stopper]

    Permalink
    Implicit information
    This member is added by an implicit conversion from ComponentSpec[Starter, Stopper] to Ensuring[ComponentSpec[Starter, Stopper]] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring

  13. final def eq(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef

  14. def equals(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any

  15. def finalize(): Unit

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )

  16. def formatted(fmtstr: String): String

    Permalink
    Implicit information
    This member is added by an implicit conversion from ComponentSpec[Starter, Stopper] to StringFormat[ComponentSpec[Starter, Stopper]] performed by method StringFormat in scala.Predef.
    Definition Classes
    StringFormat
    Annotations
    @inline()

  17. final def getClass(): Class[_]

    Permalink
    Definition Classes
    AnyRef → Any

  18. def hashCode(): Int

    Permalink
    Definition Classes
    AnyRef → Any

  19. final def isInstanceOf[T0]: Boolean

    Permalink
    Definition Classes
    Any

  20. final def ne(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef

  21. final def notify(): Unit

    Permalink
    Definition Classes
    AnyRef

  22. final def notifyAll(): Unit

    Permalink
    Definition Classes
    AnyRef

  23. final def synchronized[T0](arg0: ⇒ T0): T0

    Permalink
    Definition Classes
    AnyRef

  24. def toStart(simple: (ExecutionContext) ⇒ Unit): ComponentSpec[Specified, Stopper]

    Permalink

    Specify a synchronous action to invoke to start the component.

    Specify a synchronous action to invoke to start the component. The action will provide the appropriate scala.concurrent.ExecutionContext to invoke further asynchronous actions.

    simple

    A synchronous action to be invoked to start the component.

    returns

    The ComponentSpec

    Implicit information
    This member is added by an implicit conversion from ComponentSpec[Starter, Stopper] to ComponentFactoryStarterSpec[Stopper] performed by method ComponentFactoryStarterSpec in de.sebbraun.lifecycle.simple.ComponentSpec. This conversion will take place only if Starter is Unspecified (Starter =:= Unspecified) and at the same time Stopper is a subclass of State (Stopper <: State).
    Definition Classes
    ComponentFactoryStarterSpec

  25. def toStart(simple: ⇒ Unit): ComponentSpec[Specified, Stopper]

    Permalink

    Specify a synchronous action to invoke to start the component.

    Specify a synchronous action to invoke to start the component.

    simple

    A synchronous action to be invoked to start the component.

    returns

    The ComponentSpec

    Implicit information
    This member is added by an implicit conversion from ComponentSpec[Starter, Stopper] to ComponentFactoryStarterSpec[Stopper] performed by method ComponentFactoryStarterSpec in de.sebbraun.lifecycle.simple.ComponentSpec. This conversion will take place only if Starter is Unspecified (Starter =:= Unspecified) and at the same time Stopper is a subclass of State (Stopper <: State).
    Definition Classes
    ComponentFactoryStarterSpec

  26. def toStartAsync(async: (ExecutionContext) ⇒ Future[Unit]): ComponentSpec[Specified, Stopper]

    Permalink

    Specify an asynchronous action to invoke to start the component.

    Specify an asynchronous action to invoke to start the component. The action will be provided the appropriate scala.concurrent.ExecutionContext to invoke further asynchronous actions.

    async

    An asynchronous action to be invoked to start the component.

    returns

    The ComponentSpec

    Implicit information
    This member is added by an implicit conversion from ComponentSpec[Starter, Stopper] to ComponentFactoryStarterSpec[Stopper] performed by method ComponentFactoryStarterSpec in de.sebbraun.lifecycle.simple.ComponentSpec. This conversion will take place only if Starter is Unspecified (Starter =:= Unspecified) and at the same time Stopper is a subclass of State (Stopper <: State).
    Definition Classes
    ComponentFactoryStarterSpec

  27. def toStop(simple: (ExecutionContext) ⇒ Unit): ComponentSpec[Starter, Specified]

    Permalink

    Specify a synchronous action to invoke to stop the component.

    Specify a synchronous action to invoke to stop the component. The action will be provided the appropriate scala.concurrent.ExecutionContext to invoke further asynchronous actions.

    simple

    A synchronous action to be invoked to stop the component.

    returns

    The ComponentSpec

    Implicit information
    This member is added by an implicit conversion from ComponentSpec[Starter, Stopper] to ComponentFactoryStopperSpec[Starter] performed by method ComponentFactoryStopperSpec in de.sebbraun.lifecycle.simple.ComponentSpec. This conversion will take place only if Starter is a subclass of State (Starter <: State) and at the same time Stopper is Unspecified (Stopper =:= Unspecified).
    Definition Classes
    ComponentFactoryStopperSpec

  28. def toStop(simple: ⇒ Unit): ComponentSpec[Starter, Specified]

    Permalink

    Specify a synchronous action to invoke to stop the component.

    Specify a synchronous action to invoke to stop the component.

    simple

    A synchronous action to be invoked to stop the component.

    returns

    The ComponentSpec

    Implicit information
    This member is added by an implicit conversion from ComponentSpec[Starter, Stopper] to ComponentFactoryStopperSpec[Starter] performed by method ComponentFactoryStopperSpec in de.sebbraun.lifecycle.simple.ComponentSpec. This conversion will take place only if Starter is a subclass of State (Starter <: State) and at the same time Stopper is Unspecified (Stopper =:= Unspecified).
    Definition Classes
    ComponentFactoryStopperSpec

  29. def toStopAsync(async: (ExecutionContext) ⇒ Future[Unit]): ComponentSpec[Starter, Specified]

    Permalink

    Specify an asynchronous action to invoke to stop the component.

    Specify an asynchronous action to invoke to stop the component.

    async

    An asynchronous action to be invoked to stop the component.

    returns

    The ComponentSpec

    Implicit information
    This member is added by an implicit conversion from ComponentSpec[Starter, Stopper] to ComponentFactoryStopperSpec[Starter] performed by method ComponentFactoryStopperSpec in de.sebbraun.lifecycle.simple.ComponentSpec. This conversion will take place only if Starter is a subclass of State (Starter <: State) and at the same time Stopper is Unspecified (Stopper =:= Unspecified).
    Definition Classes
    ComponentFactoryStopperSpec

  30. def toString(): String

    Permalink
    Definition Classes
    AnyRef → Any

  31. final def wait(): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  32. final def wait(arg0: Long, arg1: Int): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  33. final def wait(arg0: Long): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  34. def →[B](y: B): (ComponentSpec[Starter, Stopper], B)

    Permalink
    Implicit information
    This member is added by an implicit conversion from ComponentSpec[Starter, Stopper] to ArrowAssoc[ComponentSpec[Starter, Stopper]] performed by method ArrowAssoc in scala.Predef. This conversion will take place only if Starter is Unspecified (Starter =:= Unspecified) and at the same time Stopper is Unspecified (Stopper =:= Unspecified).
    Definition Classes
    ArrowAssoc

Inherited from AnyRef

Inherited from Any

Inherited by implicit conversion ComponentFactoryStopperSpec from ComponentSpec[Starter, Stopper] to ComponentFactoryStopperSpec[Starter]

Inherited by implicit conversion ComponentFactoryStarterSpec from ComponentSpec[Starter, Stopper] to ComponentFactoryStarterSpec[Stopper]

Inherited by implicit conversion any2stringadd from ComponentSpec[Starter, Stopper] to any2stringadd[ComponentSpec[Starter, Stopper]]

Inherited by implicit conversion StringFormat from ComponentSpec[Starter, Stopper] to StringFormat[ComponentSpec[Starter, Stopper]]

Inherited by implicit conversion Ensuring from ComponentSpec[Starter, Stopper] to Ensuring[ComponentSpec[Starter, Stopper]]

Inherited by implicit conversion ArrowAssoc from ComponentSpec[Starter, Stopper] to ArrowAssoc[ComponentSpec[Starter, Stopper]]

Specification of dependencies

Specification of start actions

Specification of stop actions

Ungrouped