Package org.xblackcat.sjpu.cli.progress

Class PercentProgressPublisher

java.lang.Object

org.xblackcat.sjpu.cli.progress.AProgressPublisher

org.xblackcat.sjpu.cli.progress.PercentProgressPublisher

All Implemented Interfaces:

IProgressPublisher

public class PercentProgressPublisher
extends AProgressPublisher

Field Summary

Fields inherited from class org.xblackcat.sjpu.cli.progress.AProgressPublisher

output

Fields inherited from interface org.xblackcat.sjpu.cli.progress.IProgressPublisher

NO_RENDERER

Constructor Summary

Constructors

Constructor	Description
PercentProgressPublisher(Consumer<String> output, long total)
PercentProgressPublisher(Consumer<String> output, long total, String formatString)	Build Percent progress builder with custom progress string

Method Summary

Modifier and Type	Method	Description
boolean	publish(long current)	Publish and render a new value for progress

Methods inherited from class org.xblackcat.sjpu.cli.progress.AProgressPublisher

done, isDone

Methods inherited from class java.lang.Object

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

Constructor Details

PercentProgressPublisher

public PercentProgressPublisher(Consumer<String> output,
 long total)

PercentProgressPublisher

public PercentProgressPublisher(Consumer<String> output,
 long total,
 String formatString)

Build Percent progress builder with custom progress string

Parameters:

output -

total -

formatString - formatted progress string. Can accept two arguments: 1. double(percentage value) and 2. long (total elements amount). See FORMAT fpr details

Method Details

publish

public boolean publish(long current)

Description copied from interface: IProgressPublisher

Publish and render a new value for progress

Parameters:

current - new progress value

Returns:

true if progress string has changed