public interface

IProgressCallback

com.pnfsoftware.jeb.util.base.IProgressCallback
Known Indirect Subclasses

Class Overview

Progress callback object. Methods involving lengthy operations (referred to as 'provider') sometimes accept such objects and use them to provide progress information to the caller (referred to as 'client').

Summary

Public Methods
abstract long getCurrent()
abstract long getTotal()
abstract long increment()
abstract boolean isInitialized()
Determine whether this object is initialized.
abstract void message(String msg)
This method is used by the provider to send a transient message to its client.
abstract void setCurrent(long current)
This method is called by a provider to update the current computation count.
abstract void setTotal(long total)
This method called by a provider (generally once) to set an initial (possibly estimate) computation count.

Public Methods

public abstract long getCurrent ()

public abstract long getTotal ()

public abstract long increment ()

Returns
  • the incremented value

public abstract boolean isInitialized ()

Determine whether this object is initialized.

public abstract void message (String msg)

This method is used by the provider to send a transient message to its client.

public abstract void setCurrent (long current)

This method is called by a provider to update the current computation count. Together with the total count, a client may compute an estimated completion ratio.

public abstract void setTotal (long total)

This method called by a provider (generally once) to set an initial (possibly estimate) computation count. The number in itself is arbitrary.