org.kuali.common.util.inform

Class PercentCompleteInformer

java.lang.Object

org.kuali.common.util.inform.PercentCompleteInformer

public final class PercentCompleteInformer
extends Object

Print a dot to the console each time we make at least 1% progress towards a total

Field Summary

Fields

Modifier and Type	Field and Description
static int	DEFAULT_PERCENTAGE_INCREMENT
static int	UNINITIALIZED_PERCENT_COMPLETE_INDICATOR
static long	UNINITIALIZED_PROGRESS_INDICATOR

Constructor Summary

Constructors

Constructor and Description
PercentCompleteInformer(long total)
PercentCompleteInformer(long total, int percentageIncrement)
PercentCompleteInformer(long total, int percentageIncrement, Inform inform)

Method Summary

Methods

Modifier and Type	Method and Description
Inform	getInform()
StartStopInformer	getInformer()
int	getPercentageIncrement()
int	getPercentComplete() Indicates how far along we are as a percentage
long	getProgress() Indicates how far along we are
long	getTotal()
void	incrementProgress() Thread safe method for incrementing progress by one
void	incrementProgress(long amount) Thread safe method for incrementing progress by amount
protected boolean	isEnoughProgress(int newPercentCompleted, int percentComplete, int percentageIncrement)
boolean	isStarted() Indicates if we are in the "started" state or not
void	start() Thread safe method to indicate progress has begun
void	stop() Thread safe method to indicate progress has stopped

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_PERCENTAGE_INCREMENT

public static final int DEFAULT_PERCENTAGE_INCREMENT

See Also:

Constant Field Values

UNINITIALIZED_PROGRESS_INDICATOR

public static final long UNINITIALIZED_PROGRESS_INDICATOR

See Also:

Constant Field Values

UNINITIALIZED_PERCENT_COMPLETE_INDICATOR

public static final int UNINITIALIZED_PERCENT_COMPLETE_INDICATOR

See Also:

Constant Field Values

Constructor Detail

PercentCompleteInformer

public PercentCompleteInformer(long total)

PercentCompleteInformer

public PercentCompleteInformer(long total,
                       int percentageIncrement)

PercentCompleteInformer

public PercentCompleteInformer(long total,
                       int percentageIncrement,
                       Inform inform)

Method Detail

isStarted

public boolean isStarted()

Indicates if we are in the "started" state or not

getProgress

public long getProgress()

Indicates how far along we are

getPercentComplete

public int getPercentComplete()

Indicates how far along we are as a percentage

start

public void start()

Thread safe method to indicate progress has begun

incrementProgress

public void incrementProgress()

Thread safe method for incrementing progress by one

incrementProgress

public void incrementProgress(long amount)

Thread safe method for incrementing progress by amount

stop

public void stop()

Thread safe method to indicate progress has stopped

isEnoughProgress

protected boolean isEnoughProgress(int newPercentCompleted,
                       int percentComplete,
                       int percentageIncrement)

getPercentageIncrement

public int getPercentageIncrement()

getTotal

public long getTotal()

getInform

public Inform getInform()

getInformer

public StartStopInformer getInformer()