com.github.born2snipe.cli.CountUpToTotalPrinter Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of cli-progress Show documentation

This is a simple Java API for printing progress for CLI apps

The newest version!

/**
 *
 * Copyright to the original author or authors.
 *
 * Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in
 * compliance with the License. You may obtain a copy of the License at:
 *
 * http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software distributed under the License is
 * distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and limitations under the License.
 */
package com.github.born2snipe.cli;

import java.io.PrintStream;

public class CountUpToTotalPrinter extends ProgressPrinter {
    private String messageFormat = "{count} of {total}";

    public CountUpToTotalPrinter(int total) {
        this(total, System.out);
    }

    public CountUpToTotalPrinter(int total, PrintStream printStream) {
        super(total, new Printer(printStream));
    }

    public CountUpToTotalPrinter(int total, Printer printer) {
        super(total, printer);
    }

    @Override
    protected void processStep(int currentStep) {
        String message = messageFormat.replace("{count}", String.valueOf(currentStep));
        message = message.replace("{total}", String.valueOf(total));
        printer.print(message);
    }

    public void setMessageFormat(String messageFormat) {
        this.messageFormat = messageFormat;
    }
}