org.kuali.common.util
Class PercentCompleteInformer

java.lang.Object
  extended by org.kuali.common.util.PercentCompleteInformer

public class PercentCompleteInformer
extends Object

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


Field Summary
protected  long progress
           
 
Constructor Summary
PercentCompleteInformer()
           
PercentCompleteInformer(long total)
           
 
Method Summary
 String getCompleteToken()
           
 int getPercentageIncrement()
           
 PrintStream getPrintStream()
           
 long getProgress()
          Thread safe method exposing the current progress
 String getProgressToken()
           
 String getStartToken()
           
 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 percentComplete, int percentCompletePrevious, int percentageIncrement)
           
 void setCompleteToken(String completeToken)
           
 void setPercentageIncrement(int percentageIncrement)
           
 void setPrintStream(PrintStream printStream)
           
 void setProgressToken(String progressToken)
           
 void setStartToken(String startToken)
           
 void setTotal(long total)
           
 void start()
          Print the start token
 void stop()
          Print the stop token
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

progress

protected long progress
Constructor Detail

PercentCompleteInformer

public PercentCompleteInformer()

PercentCompleteInformer

public PercentCompleteInformer(long total)
Method Detail

getProgress

public long getProgress()
Thread safe method exposing the current progress


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


isEnoughProgress

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

start

public void start()
Print the start token


stop

public void stop()
Print the stop token


getPrintStream

public PrintStream getPrintStream()

setPrintStream

public void setPrintStream(PrintStream printStream)

getPercentageIncrement

public int getPercentageIncrement()

setPercentageIncrement

public void setPercentageIncrement(int percentageIncrement)

getStartToken

public String getStartToken()

setStartToken

public void setStartToken(String startToken)

getCompleteToken

public String getCompleteToken()

setCompleteToken

public void setCompleteToken(String completeToken)

getProgressToken

public String getProgressToken()

setProgressToken

public void setProgressToken(String progressToken)

getTotal

public long getTotal()

setTotal

public void setTotal(long total)


Copyright © 2010-2013 The Kuali Foundation. All Rights Reserved.