Class Overview
Takes the "virtual progress" made and scales it into an "actual progress" for the contained sink. For example,
this can take the progress range from virtual range [0, 100] and map it to the actual range [23, 47] on the
contained sink.
Summary
Public Methods |
void
|
makeProgress(long taskProgress, String currentSubTask, String message)
This method can be called to indicate that progress is being made by a task.
|
Public Constructors
public
ScalingTaskProgessSink
(long actualStart, long actualEnd, long virtualStart, long virtualEnd, TaskProgressSink delegateSink)
Create the sink with the specified virtual and actual progress ranges.
Parameters
actualStart
| the start of the actual range inclusive. |
actualEnd
| the end of the actual range inclusive. |
virtualStart
| the start of the virtual range inclusive. |
virtualEnd
| the end of the virtual range inclusive. |
delegateSink
| the sink to actually report progress on.
|
public
ScalingTaskProgessSink
(long actualStart, long actualEnd, TaskProgressSink delegateSink)
Create the sink with the specified actual range. The virtual range will be set to [0, 100].
Parameters
actualStart
| the start of the actual range inclusive. |
actualEnd
| the end of the actual range inclusive. |
delegateSink
| the sink to actually report progress on.
|
Public Methods
public
void
makeProgress
(long taskProgress, String currentSubTask, String message)
This method can be called to indicate that progress is being made by a task.
Parameters
taskProgress
| the current "virtual progress" for the task. |
currentSubTask
| the name of the current sub task or null if there isnt one |
message
| an optional message about the progress or null
|