Package org.reldb.toolbox.progress

Class EmptyProgressIndicator

java.lang.Object

org.reldb.toolbox.progress.EmptyProgressIndicator

All Implemented Interfaces:

ProgressIndicator

public class EmptyProgressIndicator
extends Object
implements ProgressIndicator

A silent ProgressIndicator, for where a ProgressIndicator is required but you don't want to know.

Constructor Summary

Constructors

Constructor	Description
EmptyProgressIndicator()

Method Summary

Modifier and Type	Method	Description
String	getLastMessage()	Get the most recent non-null additional information.
int	getPosition()	Get the current indicator position.
int	getSteps()	Get the number of steps.
void	initialise(int steps)	Initialise the indicator with the number of steps.
void	move(int step, String additionalInformation)	Move the indicator to the given 0-based step.

Methods inherited from class java.lang.Object

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

Constructor Details

EmptyProgressIndicator

public EmptyProgressIndicator()

Method Details

initialise

public void initialise(int steps)

Description copied from interface: ProgressIndicator

Initialise the indicator with the number of steps.

Specified by:

initialise in interface ProgressIndicator

Parameters:

steps - Number of steps or -1 if unknown. Should be non-zero.

getSteps

public int getSteps()

Description copied from interface: ProgressIndicator

Get the number of steps. Set via initialise(...)

Specified by:

getSteps in interface ProgressIndicator

Returns:

The total number of steps; -1 if unknown.

move

public void move(int step,
 String additionalInformation)

Description copied from interface: ProgressIndicator

Move the indicator to the given 0-based step. additionalInformation supplies additional progress text; null if not needed.

Specified by:

move in interface ProgressIndicator

Parameters:

step - Move the indicator to this step number.

additionalInformation - Provide optional additional information about this step.

getPosition

public int getPosition()

Description copied from interface: ProgressIndicator

Get the current indicator position.

Specified by:

getPosition in interface ProgressIndicator

Returns:

Current indicator position.

getLastMessage

public String getLastMessage()

Description copied from interface: ProgressIndicator

Get the most recent non-null additional information.

Specified by:

getLastMessage in interface ProgressIndicator

Returns:

Most recent non-null additional information string.