Package de.dytanic.cloudnet.console.animation.progressbar

Class ConsoleProgressBarAnimation

java.lang.Object

de.dytanic.cloudnet.console.animation.AbstractConsoleAnimation

de.dytanic.cloudnet.console.animation.progressbar.ConsoleProgressBarAnimation

All Implemented Interfaces:

java.lang.Runnable

Direct Known Subclasses:

ConsoleDownloadProgressBarAnimation

public class ConsoleProgressBarAnimation
extends AbstractConsoleAnimation

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

Constructor Summary

Constructors

Constructor	Description
ConsoleProgressBarAnimation(long fullLength, int startValue, char progressChar, char lastProgressChar, char emptyChar, java.lang.String prefix, java.lang.String suffix)	Creates a new ConsoleProgressBarAnimation

Method Summary

Modifier and Type	Method	Description
void	finish()
protected java.lang.String	format(java.lang.String input, double percent)
protected java.lang.String	formatCurrentValue(long currentValue)
protected java.lang.String	formatLength(long length)
protected java.lang.String	formatTime(long millis)
protected java.lang.String	formatValue(long value)
long	getCurrentValue()
long	getLength()
protected boolean	handleTick()
void	setCurrentValue(long currentValue)
void	setLength(int length)

Methods inherited from class de.dytanic.cloudnet.console.animation.AbstractConsoleAnimation

addFinishHandler, addToCursor, eraseLastLine, getConsole, getName, getStartTime, getTimeElapsed, getUpdateInterval, isStaticCursor, print, run, setConsole, setCursor, setStaticCursor, setUpdateInterval

Methods inherited from class java.lang.Object

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

Constructor Detail

ConsoleProgressBarAnimation

public ConsoleProgressBarAnimation(long fullLength,
                                   int startValue,
                                   char progressChar,
                                   char lastProgressChar,
                                   char emptyChar,
                                   java.lang.String prefix,
                                   java.lang.String suffix)

Creates a new ConsoleProgressBarAnimation

Parameters:

fullLength - the maximum of the animation

startValue - the initial value for this animation

progressChar - the Character for each percent in the animation

lastProgressChar - the Character which is at the last position of the animation

prefix - the prefix for this animation

suffix - the suffix for this animation

Method Detail

getLength

public long getLength()

setLength

public void setLength(int length)

getCurrentValue

public long getCurrentValue()

setCurrentValue

public void setCurrentValue(long currentValue)

finish

public void finish()

handleTick

protected boolean handleTick()

Specified by:

handleTick in class AbstractConsoleAnimation

Returns:

if the animation is finished and should be cancelled

formatCurrentValue

protected java.lang.String formatCurrentValue(long currentValue)

formatLength

protected java.lang.String formatLength(long length)

formatValue

protected java.lang.String formatValue(long value)

formatTime

protected java.lang.String formatTime(long millis)

format

protected java.lang.String format(java.lang.String input,
                                  double percent)