Package net.sf.basedb.core

Class SimpleProgressReporter

java.lang.Object

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: 2015-03-24 11:27:59 +0100 (ti, 24 mar 2015) $

Field Summary

Fields

Modifier and Type	Field	Description
private Throwable	error
private String	message
private int	percent
private final ProgressReporter	progress

Constructor Summary

Constructors

Constructor	Description
SimpleProgressReporter(ProgressReporter progress)	Create a new simple progress reporter.

Method Summary

Modifier and Type	Method	Description
void	append(String message)	Append a message to the previous one.
void	display(int percent, String message)	Display a progress message.
Throwable	getError()	Get error that happened while processing some action that was reported via this progress reporter.
String	getMessage()	Get the last progress message this progress reporter should display.
int	getPercent()	Get the last percentage completed of the task.
void	setError(Throwable error)	Set an error that happened while processing some action that was reported via this progress reporter.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

progress

private final ProgressReporter progress

message

private String message

percent

private int percent

error

private Throwable error

Constructor Details

SimpleProgressReporter

public SimpleProgressReporter(ProgressReporter progress)

Create a new simple progress reporter.

Parameters:

progress - An optional progress which is also notified about the progress

Method Details

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.

setError

public void setError(Throwable error)

Set an error that happened while processing some action that was reported via this progress reporter.

Since:

3.5

getError

public Throwable getError()

Get error that happened while processing some action that was reported via this progress reporter.

Since:

3.5