Package me.tongfei.progressbar

Class ProgressBarBuilder

java.lang.Object

me.tongfei.progressbar.ProgressBarBuilder

public class ProgressBarBuilder
extends java.lang.Object

Builder class for ProgressBars.

Since:

0.7.0

Field Summary

Fields

Modifier and Type	Field	Description
private boolean	clearDisplayOnFinish
private ProgressBarConsumer	consumer
private boolean	continuousUpdate
private java.time.Duration	elapsed
private java.util.function.Function<ProgressState,java.util.Optional<java.time.Duration>>	eta
private boolean	hideEta
private long	initialMax
private int	maxRenderedLength
private long	processed
private boolean	showSpeed
private java.text.DecimalFormat	speedFormat
private java.time.temporal.ChronoUnit	speedUnit
private ProgressBarStyle	style
private java.lang.String	task
private java.lang.String	unitName
private long	unitSize
private int	updateIntervalMillis

Constructor Summary

Constructors

Constructor	Description
ProgressBarBuilder()

Method Summary

Modifier and Type	Method	Description
ProgressBar	build()
ProgressBarBuilder	clearDisplayOnFinish()
ProgressBarBuilder	continuousUpdate()
ProgressBarBuilder	hideEta()
(package private) boolean	initialMaxIsSet()
ProgressBarBuilder	setConsumer(ProgressBarConsumer consumer)
ProgressBarBuilder	setEtaFunction(java.util.function.Function<ProgressState,java.util.Optional<java.time.Duration>> eta)
ProgressBarBuilder	setInitialMax(long initialMax)
ProgressBarBuilder	setMaxRenderedLength(int maxRenderedLength)
ProgressBarBuilder	setSpeedUnit(java.time.temporal.ChronoUnit speedUnit)
ProgressBarBuilder	setStyle(ProgressBarStyle style)
ProgressBarBuilder	setTaskName(java.lang.String task)
ProgressBarBuilder	setUnit(java.lang.String unitName, long unitSize)
ProgressBarBuilder	setUpdateIntervalMillis(int updateIntervalMillis)
ProgressBarBuilder	showSpeed()
ProgressBarBuilder	showSpeed(java.text.DecimalFormat speedFormat)
ProgressBarBuilder	startsFrom(long processed, java.time.Duration elapsed)	Sets elapsedBeforeStart duration and number of processed units.

Methods inherited from class java.lang.Object

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

Field Detail

task

private java.lang.String task

initialMax

private long initialMax

updateIntervalMillis

private int updateIntervalMillis

continuousUpdate

private boolean continuousUpdate

style

private ProgressBarStyle style

consumer

private ProgressBarConsumer consumer

clearDisplayOnFinish

private boolean clearDisplayOnFinish

unitName

private java.lang.String unitName

unitSize

private long unitSize

showSpeed

private boolean showSpeed

hideEta

private boolean hideEta

eta

private java.util.function.Function<ProgressState,java.util.Optional<java.time.Duration>> eta

speedFormat

private java.text.DecimalFormat speedFormat

speedUnit

private java.time.temporal.ChronoUnit speedUnit

processed

private long processed

elapsed

private java.time.Duration elapsed

maxRenderedLength

private int maxRenderedLength

Constructor Detail

ProgressBarBuilder

public ProgressBarBuilder()

Method Detail

setTaskName

public ProgressBarBuilder setTaskName(java.lang.String task)

initialMaxIsSet

boolean initialMaxIsSet()

setInitialMax

public ProgressBarBuilder setInitialMax(long initialMax)

setStyle

public ProgressBarBuilder setStyle(ProgressBarStyle style)

setUpdateIntervalMillis

public ProgressBarBuilder setUpdateIntervalMillis(int updateIntervalMillis)

continuousUpdate

public ProgressBarBuilder continuousUpdate()

setConsumer

public ProgressBarBuilder setConsumer(ProgressBarConsumer consumer)

clearDisplayOnFinish

public ProgressBarBuilder clearDisplayOnFinish()

setUnit

public ProgressBarBuilder setUnit(java.lang.String unitName,
                                  long unitSize)

setMaxRenderedLength

public ProgressBarBuilder setMaxRenderedLength(int maxRenderedLength)

showSpeed

public ProgressBarBuilder showSpeed()

showSpeed

public ProgressBarBuilder showSpeed(java.text.DecimalFormat speedFormat)

hideEta

public ProgressBarBuilder hideEta()

setEtaFunction

public ProgressBarBuilder setEtaFunction(java.util.function.Function<ProgressState,java.util.Optional<java.time.Duration>> eta)

setSpeedUnit

public ProgressBarBuilder setSpeedUnit(java.time.temporal.ChronoUnit speedUnit)

startsFrom

public ProgressBarBuilder startsFrom(long processed,
                                     java.time.Duration elapsed)

Sets elapsedBeforeStart duration and number of processed units.

Parameters:

processed - amount of processed units

elapsed - duration of

build

public ProgressBar build()