com.xceptance.xlt.util.ProgressBar Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of xlt Show documentation
XLT (Xceptance LoadTest) is an extensive load and performance test tool developed and maintained by Xceptance.
There is a newer version: 8.1.0
package com.xceptance.xlt.util;

/**
 * Simple one way console progress bar.

 * 

 * Example:
 * 
 *  * int total = 10;
 * ProgressBar progressBar = new ProgressBar(total);
 * progressBar.start();
 * for (int i = 0; i < total; i++)
 * {
 *     progressBar.increaseCount();
 * }
 * ;
 * 
 * 
 * Example Output:
 * 
 *  * 0% ... 10% ... 20% ... 30% ... 40% ... 50% ... 60% ... 70% ... 80% ... 90% ... 100%
 * 
 * 
 * @author Matthias Ullrich (Xceptance Software Technologies GmbH)
 */
public class ProgressBar
{
    private final int total;

    private int nextStep = 0;

    private int currentCount = 0;

    private final boolean isStarted = false;

    /**
     * @param total
     *            expected total (greater than or equals 0)
     */
    public ProgressBar(final int total)
    {
        if (total < 0)
        {
            throw new IllegalArgumentException("Given total must be 0 or higher but was : " + total);
        }

        this.total = total;
    }

    /**
     * Start progress bar.

     * If not started
     */
    public synchronized void start()
    {
        if (!isStarted)
        {
            setCount(0);
        }
    }

    /**
     * Increases the current progress counter.

     * Either work with 'percentage' or with 'count'. Both in combination will not work properly.
     */
    public synchronized void increaseCount()
    {
        setCount(++currentCount);
    }

    /**
     * Increases the current progress counter by given amount.

     * Either work with 'percentage' or with 'count'. Both in combination will not work properly.
     */
    public synchronized void increaseCount(final int add)
    {
        if (add < 0)
        {
            throw new IllegalArgumentException(String.format("Added value must be positive but was '%d'", add));
        }
        setCount(currentCount + add);
    }

    /**
     * Sets the progress totaly.

     * Either work with 'percentage' or with 'count'. Both in combination will not work properly.
     * 
     * @param count
     *            count
     */
    public synchronized void setCount(final int count)
    {
        if (count < 0 || count > total)
        {
            throw new IllegalArgumentException(String.format("Count must be one of [0 .. %d] but was '%d'", total, count));
        }

        currentCount = count;

        final int percent = count * 100 / total;
        setPercent(percent);
    }

    /**
     * @return set progress bar to 'completed'
     */
    public synchronized void setCompleted()
    {
        setCount(total);
    }

    /**
     * @return the expected total count
     */
    public synchronized int getTotal()
    {
        return total;
    }

    /**
     * @return the current count
     */
    public synchronized int getCurrentCount()
    {
        return currentCount;
    }

    /**
     * Sets the progress in percent.

     * Either work with 'percentage' or with 'count'. Both in combination will not work properly.
     * 
     * @param percent
     *            percentage
     */
    public synchronized void setPercent(final int percent)
    {
        if (percent < 0 || percent > 100)
        {
            throw new IllegalArgumentException(String.format("Percent must be one of [0 .. 100] but was '%d'", percent));
        }

        if (percent >= nextStep)
        {
            final boolean isStart = (nextStep == 0);

            while (percent >= nextStep)
            {
                nextStep += 10;
            }

            final int currentStep = isStart ? 0 : nextStep - 10;

            final String keepOn = percent < 100 ? "... " : "";
            final String step = String.format("%d%s %s", currentStep, "%", keepOn);

            System.out.print(step);
        }
    }
}