Package me.tongfei.progressbar

Class ProgressState

java.lang.Object

me.tongfei.progressbar.ProgressState

public class ProgressState
extends java.lang.Object

Encapsulates the internal states of a progress bar.

Since:

0.5.0

Field Summary

Fields

Modifier and Type	Field	Description
(package private) boolean	alive
(package private) long	current
(package private) java.time.Duration	elapsedBeforeStart
(package private) java.lang.String	extraMessage
(package private) boolean	indefinite
(package private) long	max
(package private) boolean	paused
(package private) long	start
(package private) java.time.Instant	startInstant
(package private) java.lang.String	taskName

Constructor Summary

Constructors

Constructor	Description
ProgressState(java.lang.String taskName, long initialMax, long startFrom, java.time.Duration elapsedBeforeStart)

Method Summary

Modifier and Type	Method	Description
long	getCurrent()
java.time.Duration	getElapsedAfterStart()
java.time.Duration	getElapsedBeforeStart()
java.lang.String	getExtraMessage()
long	getMax()
double	getNormalizedProgress()
long	getStart()
java.time.Instant	getStartInstant()
java.lang.String	getTaskName()
java.time.Duration	getTotalElapsed()
boolean	isAlive()
boolean	isIndefinite()
boolean	isPaused()
(package private) void	kill()
(package private) void	maxHint(long n)
(package private) void	pause()
(package private) void	reset()
(package private) void	resume()
(package private) void	setAsDefinite()
(package private) void	setAsIndefinite()
(package private) void	setExtraMessage(java.lang.String msg)
(package private) void	stepBy(long n)
(package private) void	stepTo(long n)

Methods inherited from class java.lang.Object

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

Field Detail

taskName

java.lang.String taskName

extraMessage

java.lang.String extraMessage

indefinite

boolean indefinite

start

long start

current

long current

max

long max

startInstant

java.time.Instant startInstant

elapsedBeforeStart

java.time.Duration elapsedBeforeStart

alive

volatile boolean alive

paused

volatile boolean paused

Constructor Detail

ProgressState

ProgressState(java.lang.String taskName,
              long initialMax,
              long startFrom,
              java.time.Duration elapsedBeforeStart)

Method Detail

getTaskName

public java.lang.String getTaskName()

getExtraMessage

public java.lang.String getExtraMessage()

getStart

public long getStart()

getCurrent

public long getCurrent()

getMax

public long getMax()

getNormalizedProgress

public double getNormalizedProgress()

getStartInstant

public java.time.Instant getStartInstant()

getElapsedBeforeStart

public java.time.Duration getElapsedBeforeStart()

getElapsedAfterStart

public java.time.Duration getElapsedAfterStart()

getTotalElapsed

public java.time.Duration getTotalElapsed()

isIndefinite

public boolean isIndefinite()

isAlive

public boolean isAlive()

isPaused

public boolean isPaused()

setAsDefinite

void setAsDefinite()

setAsIndefinite

void setAsIndefinite()

maxHint

void maxHint(long n)

stepBy

void stepBy(long n)

stepTo

void stepTo(long n)

setExtraMessage

void setExtraMessage(java.lang.String msg)

pause

void pause()

resume

void resume()

reset

void reset()

kill

void kill()