StderrProgressMonitor.java

package net.slightlymagic.braids.util.progress_monitor;

public class StderrProgressMonitor extends BaseProgressMonitor {

	/**
	 * @see BaseProgressMonitor(int,long)
	 */
    public StderrProgressMonitor(int numPhases, long totalUnitsFirstPhase) {
    	this(numPhases, totalUnitsFirstPhase, 2.0f, null);
    }
    
	/**
	 * @see BaseProgressMonitor(int,long,float)
	 */
    public StderrProgressMonitor(int numPhases, long totalUnitsFirstPhase, 
            float minUpdateIntervalSec) 
	{
		this(numPhases, totalUnitsFirstPhase, minUpdateIntervalSec, null);
	}
    
	/**
	 * @see BaseProgressMonitor(int,long,float,float[])
	 */
    public StderrProgressMonitor(int numPhases, long totalUnitsFirstPhase, 
                 float minUpdateIntervalSec, float[] phaseWeights) 
    {
        super(numPhases, totalUnitsFirstPhase, minUpdateIntervalSec, phaseWeights);
    }
    
    @Override
	/**
	 * @see BaseProgressMonitor#incrementUnitsCompletedThisPhase(long)
	 */
    public void incrementUnitsCompletedThisPhase(long numUnits) {
        super.incrementUnitsCompletedThisPhase(numUnits);

        if (shouldUpdateUI()) {

        	if ((getNumPhases() > 1)) {
                printUpdate(
                 "Phase " + getCurrentPhase() + ": " + 
                 getUnitsCompletedSoFarThisPhase() + " units processed. " + 
                 "Overall: " + getTotalPercentCompleteAsString() + "% complete, " +
                 "ETA in " + getRelativeETAAsString() + "."
                 );
            }
            else {
                printUpdate(
                 "Overall: " + 
                 getUnitsCompletedSoFarThisPhase() + " units processed " +
                 "(" + getTotalPercentCompleteAsString() + "%); " +
                 "ETA in " + getRelativeETAAsString() + "."
                 );
            }
        }
     }

    /**
     * Displays a message to stderr, overwriting the current estimate; calls
     * from outside this class should provide a newline character at the 
     * end of the messsage.
     * 
     * @param message  the message to display
     */
    public void printUpdate(String message) {
    	
    	while (message.length() < 79) {
    		message += ' ';
    	}
    	
        System.err.print("\r");
        System.err.print(message);

        if (message.length() > 79) {
        	System.err.print("\n");
        }

        justUpdatedUI();

    }
}