2.17.2: 2011-06-17

net.sf.basedb.core
Class SimpleAbsoluteProgressReporter

java.lang.Object
  extended by net.sf.basedb.core.SimpleProgressReporter
      extended by net.sf.basedb.core.SimpleAbsoluteProgressReporter
All Implemented Interfaces:
AbsoluteProgressReporter, ProgressReporter

public class SimpleAbsoluteProgressReporter
extends SimpleProgressReporter
implements AbsoluteProgressReporter

This is a simple implementation of the AbsoluteProgressReporter interface, which simply remembers that last values.

Version:
2.0
Author:
nicklas
See Also:
SimpleProgressReporter
Last modified
$Date: 2010-08-03 11:21:30 +0200 (Tue, 03 Aug 2010) $

Field Summary
private  long baseCompleted
           
private  long completed
           
private  String message
           
private  long total
           
 
Constructor Summary
SimpleAbsoluteProgressReporter(ProgressReporter progress, long total)
          Create a new absolute progress reporter.
 
Method Summary
 void displayAbsolute(long completed, String message)
          Display a progress message.
 long getCompleted()
          Get completed number of ticks of the task.
 long getTotal()
          Get the end point of the task.
 void setAbsolute(long completed, String message)
          Set a basic progress level.
 
Methods inherited from class net.sf.basedb.core.SimpleProgressReporter
append, display, getMessage, getPercent
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 
Methods inherited from interface net.sf.basedb.core.ProgressReporter
append, display
 

Field Detail

total

private final long total

completed

private long completed

baseCompleted

private long baseCompleted

message

private String message
Constructor Detail

SimpleAbsoluteProgressReporter

public SimpleAbsoluteProgressReporter(ProgressReporter progress,
                                      long total)
Create a new absolute progress reporter. If the total is set to -1 (unknown size), all percentages are forwarded to the parent as -1.

Parameters:
progress - An optional progress which is also notified about the progress
total - The end point of task, or -1 if not known
Method Detail

displayAbsolute

public void displayAbsolute(long completed,
                            String message)
Description copied from interface: AbsoluteProgressReporter
Display a progress message.

Specified by:
displayAbsolute in interface AbsoluteProgressReporter
Parameters:
completed - The progress of the task
message - A message, or null

getTotal

public long getTotal()
Get the end point of the task.


getCompleted

public long getCompleted()
Get completed number of ticks of the task.


setAbsolute

public void setAbsolute(long completed,
                        String message)
Set a basic progress level. Subsequent calls to displayAbsolute(long, String) are based on the completed value and message set here.

Parameters:
completed - The basic completed progress
message - A default message
Since:
2.16

2.17.2: 2011-06-17