me.tongfei.progressbar

Class DefaultProgressBarRenderer

java.lang.Object

me.tongfei.progressbar.DefaultProgressBarRenderer

All Implemented Interfaces:

ProgressBarRenderer

public class DefaultProgressBarRenderer
extends Object
implements ProgressBarRenderer

Default progress bar renderer (see ProgressBarRenderer).

Since:

0.8.0

Author:

Tongfei Chen, Muhammet Sakarya

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	DefaultProgressBarRenderer(ProgressBarStyle style, String unitName, long unitSize, boolean isSpeedShown, DecimalFormat speedFormat, ChronoUnit speedUnit)

Method Summary

Modifier and Type	Method and Description
protected String	eta(me.tongfei.progressbar.ProgressState progress, Duration elapsed)
protected String	percentage(me.tongfei.progressbar.ProgressState progress)
protected int	progressFractionalPart(me.tongfei.progressbar.ProgressState progress, int length)
protected int	progressIntegralPart(me.tongfei.progressbar.ProgressState progress, int length)
protected String	ratio(me.tongfei.progressbar.ProgressState progress)
String	render(me.tongfei.progressbar.ProgressState progress, int maxLength) Renders the current progress bar state as a string to be shown by a consumer.
protected String	speed(me.tongfei.progressbar.ProgressState progress, Duration elapsed)

Methods inherited from class java.lang.Object

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

Constructor Detail

DefaultProgressBarRenderer

protected DefaultProgressBarRenderer(ProgressBarStyle style,
                                     String unitName,
                                     long unitSize,
                                     boolean isSpeedShown,
                                     DecimalFormat speedFormat,
                                     ChronoUnit speedUnit)

Method Detail

progressIntegralPart

protected int progressIntegralPart(me.tongfei.progressbar.ProgressState progress,
                                   int length)

progressFractionalPart

protected int progressFractionalPart(me.tongfei.progressbar.ProgressState progress,
                                     int length)

eta

protected String eta(me.tongfei.progressbar.ProgressState progress,
                     Duration elapsed)

percentage

protected String percentage(me.tongfei.progressbar.ProgressState progress)

ratio

protected String ratio(me.tongfei.progressbar.ProgressState progress)

speed

protected String speed(me.tongfei.progressbar.ProgressState progress,
                       Duration elapsed)

render

public String render(me.tongfei.progressbar.ProgressState progress,
                     int maxLength)

Description copied from interface: ProgressBarRenderer

Renders the current progress bar state as a string to be shown by a consumer.

Specified by:

render in interface ProgressBarRenderer

Parameters:

progress - The current progress bar state

maxLength - The maximum length as dictated by the consumer

Returns:

Rendered string to be consumed by the consumer