BLProgressEventType.BLProgressUpdateType

All Superinterfaces:: BLProgressEventType

All Known Implementing Classes:: BLProgressUpdate

Enclosing interface:: BLProgressEventType

@Immutable public static interface BLProgressEventType.BLProgressUpdateType extends BLProgressEventType

Progress was made on a particular file.

Nested Class Summary

Nested classes/interfaces inherited from interface com.io7m.brooklime.api.BLProgressEventType
BLProgressEventType.BLProgressFileStartedType, BLProgressEventType.BLProgressUpdateType, BLProgressEventType.Kind
Method Summary

Modifier and Type

Method

Description

int

attemptCurrent()

int

attemptMaximum()

long

bytesMaximum()

long

bytesPerSecond()

long

bytesSent()

int

fileIndexCurrent()

int

fileIndexMaximum()

default BLProgressEventType.Kind

kind()

String

name()

double

progress()

Duration

timeRemaining()

Method Details
- kind
  
  default BLProgressEventType.Kind kind()
  
  Specified by:
  
  kind in interface BLProgressEventType
  
  Returns:
  
  The event kind
- name
  
  String name()
  
  Specified by:
  
  name in interface BLProgressEventType
  
  Returns:
  
  The event name
- fileIndexCurrent
  
  int fileIndexCurrent()
  
  Specified by:
  
  fileIndexCurrent in interface BLProgressEventType
  
  Returns:
  
  The current file index
- fileIndexMaximum
  
  int fileIndexMaximum()
  
  Specified by:
  
  fileIndexMaximum in interface BLProgressEventType
  
  Returns:
  
  The current maximum file index
- attemptCurrent
  
  int attemptCurrent()
  
  Specified by:
  
  attemptCurrent in interface BLProgressEventType
  
  Returns:
  
  The current attempt number
- attemptMaximum
  
  int attemptMaximum()
  
  Specified by:
  
  attemptMaximum in interface BLProgressEventType
  
  Returns:
  
  The maximum number of attempts
- bytesSent
  
  long bytesSent()
  
  Returns:
  
  The number of bytes sent so far
- bytesMaximum
  
  long bytesMaximum()
  
  Returns:
  
  The number of bytes that will be sent
- progress
  
  double progress()
  
  Returns:
  
  The progress as a real value
- bytesPerSecond
  
  long bytesPerSecond()
  
  Returns:
  
  The number of bytes per second
- timeRemaining
  
  Duration timeRemaining()
  
  Returns:
  
  An estimate of the remaining time