Class ConsoleProgressAnimation

java.lang.Object

eu.cloudnetservice.node.impl.console.animation.AbstractConsoleAnimation

eu.cloudnetservice.node.impl.console.animation.progressbar.ConsoleProgressAnimation

All Implemented Interfaces:

Runnable

public class ConsoleProgressAnimation
extends AbstractConsoleAnimation

Represents a progress bar animation in the console that by default is updated all 10 milliseconds

Field Summary

Fields

Modifier and Type	Field	Description
private final char	blockChar
private long	current
private final String	fractions
private final char	leftBracket
private long	maximum
private final String	prefix
private final char	rightBracket
private final char	spaceChar
private final String	suffix
private final DecimalFormat	unitFormat
private final String	unitName
private final long	unitSize

Fields inherited from class AbstractConsoleAnimation

console, cursorUp, finishHandler, LOGGER, startInstant, staticCursor, updateInterval

Constructor Summary

Constructors

Constructor	Description
ConsoleProgressAnimation(char blockChar, char spaceChar, @NonNull String fractions, char leftBracket, char rightBracket, @NonNull String prefix, @NonNull String suffix, long unitSize, @NonNull String unitName, @NonNull DecimalFormat unitFormat, long maximum)

Method Summary

Modifier and Type	Method	Description
static @NonNull ConsoleProgressAnimation	createDefault(@NonNull String task, @NonNull String unitName, int unitSize, long maximum)
long	current()
protected @NonNull String	formatElapsedTime(@NonNull Duration duration)
protected @NonNull String	formatEta(@NonNull Duration elapsed)
protected @NonNull String	formatPercentage()
protected @NonNull String	formatRatio()
protected @NonNull String	formatSpeed(@NonNull Duration elapsed)
protected int	fraction(int length)
protected boolean	handleTick()
long	maximum()
@Range(from=0L,to=1L) double	normalizeProgress()
protected @NonNull String	render()
protected @NonNull String	replacePlaceholders(@NonNull String input, @NonNull Duration elapsed)
void	step()
void	stepBy(long length)
void	stepTo(long length)
void	stepToEnd()

Methods inherited from class AbstractConsoleAnimation

addFinishHandler, addToCursor, console, console, eraseLastLine, handleDone, print, resetConsole, run, staticCursor, updateInterval

Methods inherited from class Object

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

Field Details

blockChar

private final char blockChar

spaceChar

private final char spaceChar

fractions

private final String fractions

leftBracket

private final char leftBracket

rightBracket

private final char rightBracket

prefix

private final String prefix

suffix

private final String suffix

unitSize

private final long unitSize

unitName

private final String unitName

unitFormat

private final DecimalFormat unitFormat

current

private long current

maximum

private long maximum

Constructor Details

ConsoleProgressAnimation

public ConsoleProgressAnimation(char blockChar,
 char spaceChar,
 @NonNull
 @NonNull String fractions,
 char leftBracket,
 char rightBracket,
 @NonNull
 @NonNull String prefix,
 @NonNull
 @NonNull String suffix,
 long unitSize,
 @NonNull
 @NonNull String unitName,
 @NonNull
 @NonNull DecimalFormat unitFormat,
 long maximum)

Method Details

createDefault

@NonNull
public static @NonNull ConsoleProgressAnimation createDefault(@NonNull
 @NonNull String task,
 @NonNull
 @NonNull String unitName,
 int unitSize,
 long maximum)

handleTick

protected boolean handleTick()

Specified by:

handleTick in class AbstractConsoleAnimation

Returns:

if the animation is finished and should be cancelled

step

public void step()

stepBy

public void stepBy(long length)

stepToEnd

public void stepToEnd()

stepTo

public void stepTo(long length)

normalizeProgress

public @Range(from=0L,to=1L) double normalizeProgress()

render

@NonNull
protected @NonNull String render()

formatPercentage

@NonNull
protected @NonNull String formatPercentage()

formatSpeed

@NonNull
protected @NonNull String formatSpeed(@NonNull
 @NonNull Duration elapsed)

formatRatio

@NonNull
protected @NonNull String formatRatio()

formatElapsedTime

@NonNull
protected @NonNull String formatElapsedTime(@NonNull
 @NonNull Duration duration)

formatEta

@NonNull
protected @NonNull String formatEta(@NonNull
 @NonNull Duration elapsed)

fraction

protected int fraction(int length)

replacePlaceholders

@NonNull
protected @NonNull String replacePlaceholders(@NonNull
 @NonNull String input,
 @NonNull
 @NonNull Duration elapsed)

current

public long current()

maximum

public long maximum()