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
- Alphabetic
- By Inheritance
- OptProgressConfigBuilder
- AnyRef
- Any
- Hide All
- Show All
- Public
- All
Abstract Value Members
-
abstract
def
build(): OptProgressConfig
- returns
a ProgressConfig with the optional progress function
-
abstract
def
optTotal: Option[Int]
The optional total number of operations as set by derived type
-
abstract
def
progress(reporter: TaskEventListener)(implicit ec: ExecutionContext): MDT
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
-
final
def
!=(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
-
final
def
##(): Int
- Definition Classes
- AnyRef → Any
-
final
def
==(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
-
final
def
asInstanceOf[T0]: T0
- Definition Classes
- Any
-
def
clone(): AnyRef
- Attributes
- protected[java.lang]
- Definition Classes
- AnyRef
- Annotations
- @throws( ... )
-
final
def
eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
-
def
equals(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
-
def
finalize(): Unit
- Attributes
- protected[java.lang]
- Definition Classes
- AnyRef
- Annotations
- @throws( classOf[java.lang.Throwable] )
-
final
def
getClass(): Class[_]
- Definition Classes
- AnyRef → Any
-
def
hashCode(): Int
- Definition Classes
- AnyRef → Any
-
final
def
isInstanceOf[T0]: Boolean
- Definition Classes
- Any
-
final
def
ne(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
-
final
def
notify(): Unit
- Definition Classes
- AnyRef
-
final
def
notifyAll(): Unit
- Definition Classes
- AnyRef
-
def
progress(reportInterval: FiniteDuration)(report: (Progress) ⇒ Unit)(implicit executionContext: ExecutionContext, scheduledExecutionContext: ScheduledExecutionContext): MDT
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
-
def
progress(report: (Progress) ⇒ Unit)(implicit ec: ExecutionContext): MDT
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
-
final
def
synchronized[T0](arg0: ⇒ T0): T0
- Definition Classes
- AnyRef
-
def
toString(): String
- Definition Classes
- AnyRef → Any
-
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( ... )