Trait

s_mach.concurrent.config

OptProgressConfigBuilder

Related Doc: package config

Permalink

trait OptProgressConfigBuilder[MDT <: OptProgressConfigBuilder[MDT]] extends AnyRef

A trait for an immutable builder of OptProgressConfig. Callers may set the optional progress reporter by calling one of the progress methods. If no progress reporting method is ever called then the optional progress function is left unset.

MDT

most derived type

Linear Supertypes
AnyRef, Any
Known Subclasses
AbstractAsyncConfigBuilder, AbstractCollectionAsyncTaskRunner, AsyncConfigBuilder, CollectionAsyncTaskRunner, ParCollectionAsyncTaskRunner
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. OptProgressConfigBuilder
  2. AnyRef
  3. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Abstract Value Members

  1. abstract def build(): OptProgressConfig

    Permalink

    returns

    a ProgressConfig with the optional progress function

  2. abstract def optTotal: Option[Int]

    Permalink

    The optional total number of operations as set by derived type

  3. abstract def progress(reporter: TaskEventListener)(implicit ec: ExecutionContext): MDT

    Permalink

    Set the optional progress reporting function.

    Set the optional progress reporting function.

    reporter

    a function that accepts the number of completed operations (typically this is 1) as they occur

    returns

    a copy of the builder with the new setting

Concrete Value Members

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

    Permalink
    Definition Classes
    AnyRef → Any

  2. final def ##(): Int

    Permalink
    Definition Classes
    AnyRef → Any

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

    Permalink
    Definition Classes
    AnyRef → Any

  4. final def asInstanceOf[T0]: T0

    Permalink
    Definition Classes
    Any

  5. def clone(): AnyRef

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

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

    Permalink
    Definition Classes
    AnyRef

  7. def equals(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any

  8. def finalize(): Unit

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

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

    Permalink
    Definition Classes
    AnyRef → Any

  10. def hashCode(): Int

    Permalink
    Definition Classes
    AnyRef → Any

  11. final def isInstanceOf[T0]: Boolean

    Permalink
    Definition Classes
    Any

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

    Permalink
    Definition Classes
    AnyRef

  13. final def notify(): Unit

    Permalink
    Definition Classes
    AnyRef

  14. final def notifyAll(): Unit

    Permalink
    Definition Classes
    AnyRef

  15. def progress(reportInterval: FiniteDuration)(report: (Progress) ⇒ Unit)(implicit executionContext: ExecutionContext, scheduledExecutionContext: ScheduledExecutionContext): MDT

    Permalink

    Set the progress reporting function to periodically report progress

    Set the progress reporting function to periodically report progress

    reportInterval

    the interval to report progress

    report

    a function that accepts the number of operations completed and the total number of operations (or 0 if the total is unknown)

    returns

    a copy of the builder with the new setting

  16. def progress(report: (Progress) ⇒ Unit)(implicit ec: ExecutionContext): MDT

    Permalink

    Set the progress reporting function

    Set the progress reporting function

    report

    a function that accepts the number of operations completed and the total number of operations (or 0 if the total is unknown)

    returns

    a copy of the builder with the new setting

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

    Permalink
    Definition Classes
    AnyRef

  18. def toString(): String

    Permalink
    Definition Classes
    AnyRef → Any

  19. final def wait(): Unit

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

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

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

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

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

Inherited from AnyRef

Inherited from Any

Ungrouped