2.17.2: 2011-06-17

net.sf.basedb.core
Class SimpleProgressReporter

java.lang.Object
  extended by net.sf.basedb.core.SimpleProgressReporter
All Implemented Interfaces:
ProgressReporter
Direct Known Subclasses:
SimpleAbsoluteProgressReporter, SimpleSignalProgressReporter

public class SimpleProgressReporter
extends Object
implements ProgressReporter

This is a simple implementation of the ProgressReporter interface, which simply remembers that last values. An application may use the getMessage() and getPercent() method to get information about the progress. This implementation also supports forwarding the progress information to another progress reporter.

Version:
2.0
Author:
nicklas
Last modified
$Date: 2008-09-11 22:11:02 +0200 (Thu, 11 Sep 2008) $

Field Summary
private  String message
           
private  int percent
           
private  ProgressReporter progress
           
 
Constructor Summary
SimpleProgressReporter(ProgressReporter progress)
          Create a new simple progress reporter.
 
Method Summary
 void append(String message)
          Append a message to the previous one.
 void display(int percent, String message)
          Display a progress message.
 String getMessage()
          Get the last progress message this progress reporter should display.
 int getPercent()
          Get the last percentage completed of the task.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

progress

private final ProgressReporter progress

message

private String message

percent

private int percent
Constructor Detail

SimpleProgressReporter

public SimpleProgressReporter(ProgressReporter progress)
Create a new simple progress reporter.

Parameters:
progress - An optional progress which is also notified about the progress
Method Detail

display

public void display(int percent,
                    String message)
Description copied from interface: ProgressReporter
Display a progress message.

Specified by:
display in interface ProgressReporter
Parameters:
percent - How many percent of the task that is completed or -1 if not known
message - A message, or null

append

public void append(String message)
Description copied from interface: ProgressReporter
Append a message to the previous one.

Specified by:
append in interface ProgressReporter
Parameters:
message - The message

getMessage

public String getMessage()
Get the last progress message this progress reporter should display.


getPercent

public int getPercent()
Get the last percentage completed of the task.


2.17.2: 2011-06-17