Class

eu.shiftforward.apso

ProgressBar

Related Doc: package apso

Permalink

case class ProgressBar(total: Long = 100, width: Int = 80, throughputUnit: String = "ops", throughputTransformer: (Double) ⇒ Double = identity) extends Product with Serializable

A widget for printing a dynamic progress bar in a console.

total

the number representing the full progress bar

width

the line width of the progress bar

throughputUnit

the throughput unit that is being measured

throughputTransformer

a function to transform the measured throughput value, before displaying it

Linear Supertypes
Serializable, Serializable, Product, Equals, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. ProgressBar
  2. Serializable
  3. Serializable
  4. Product
  5. Equals
  6. AnyRef
  7. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

  1. new ProgressBar(total: Long = 100, width: Int = 80, throughputUnit: String = "ops", throughputTransformer: (Double) ⇒ Double = identity)

    Permalink

    total

    the number representing the full progress bar

    width

    the line width of the progress bar

    throughputUnit

    the throughput unit that is being measured

    throughputTransformer

    a function to transform the measured throughput value, before displaying it

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 finalize(): Unit

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

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

    Permalink
    Definition Classes
    AnyRef → Any

  9. def isFinished: Boolean

    Permalink

    Returns true if this progress bar is full.

    Returns true if this progress bar is full.

    returns

    true if this progress bar is full, false otherwise.

  10. final def isInstanceOf[T0]: Boolean

    Permalink
    Definition Classes
    Any

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

    Permalink
    Definition Classes
    AnyRef

  12. final def notify(): Unit

    Permalink
    Definition Classes
    AnyRef

  13. final def notifyAll(): Unit

    Permalink
    Definition Classes
    AnyRef

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

    Permalink
    Definition Classes
    AnyRef

  15. val throughputTransformer: (Double) ⇒ Double

    Permalink

    a function to transform the measured throughput value, before displaying it

  16. val throughputUnit: String

    Permalink

    the throughput unit that is being measured

  17. def tick(inc: Long): Unit

    Permalink

    Increase the progress by the given number of units.

    Increase the progress by the given number of units.

    inc

    the number of progress units to increase

  18. def tick(): Unit

    Permalink

    Increase the progress by one.

  19. val total: Long

    Permalink

    the number representing the full progress bar

  20. final def wait(): Unit

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

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

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

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

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

  23. val width: Int

    Permalink

    the line width of the progress bar

Inherited from Serializable

Inherited from Serializable

Inherited from Product

Inherited from Equals

Inherited from AnyRef

Inherited from Any

Ungrouped