net.thevpc.nuts.runtime.standalone.io.progress

Class CProgressBar

java.lang.Object

net.thevpc.nuts.runtime.standalone.io.progress.CProgressBar

public class CProgressBar
extends Object

inspired by https://github.com/Changaco/unicode-progress-bars/blob/master/generator.html

Author:

thevpc

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	CProgressBar.DefaultIndeterminatePosition
static interface	CProgressBar.Formatter
static interface	CProgressBar.IndeterminatePosition
static class	CProgressBar.SimpleFormatter

Field Summary

Fields

Modifier and Type	Field and Description
static CProgressBar.Formatter	CIRCLES
static CProgressBar.Formatter	CIRCLES2
static CProgressBar.Formatter	DEFAULT
static CProgressBar.Formatter	DOTS1
static CProgressBar.Formatter	DOTS2
static CProgressBar.Formatter	PARALLELOGRAM
static CProgressBar.Formatter	RECTANGLES
static CProgressBar.Formatter	RECTANGLES2
static CProgressBar.Formatter	RECTANGLES3
static CProgressBar.Formatter	RECTANGLES4
static CProgressBar.Formatter	SIMPLE

Constructor Summary

Constructors

Constructor and Description
CProgressBar(net.thevpc.nuts.NutsSession session)
CProgressBar(net.thevpc.nuts.NutsSession session, int size)

Method Summary

Modifier and Type	Method and Description
int	getColumns()
CProgressBar.Formatter	getFormatter()
CProgressBar.IndeterminatePosition	getIndeterminatePosition()
float	getIndeterminateSize()
long	getMinPeriod()
int	getSize()
boolean	isNoMoveLineStart()
boolean	isPrefixMoveLineStart()
boolean	isSuffixMoveLineStart()
void	printProgress(int percent, String msg, net.thevpc.nuts.NutsPrintStream out)
String	progress(int percent)
String	progress(int percent, String msg)
String	progressWithoutSession(int percent)
String	progressWithSession(int percent)
String	progressWithSessionNew(int percent)
String	progressWithSessionOld(int percent)
CProgressBar	setColumns(int columns)
CProgressBar	setFormatter(CProgressBar.Formatter formatter)
CProgressBar	setIndeterminatePosition(CProgressBar.IndeterminatePosition indeterminatePosition)
CProgressBar	setIndeterminateSize(float indeterminateSize)
void	setMinPeriod(long minPeriod)
CProgressBar	setPrefixMoveLineStart(boolean v)
CProgressBar	setSession(net.thevpc.nuts.NutsSession session)
CProgressBar	setSize(int size)
CProgressBar	setSuffixMoveLineStart(boolean v)

Methods inherited from class java.lang.Object

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

Field Detail

RECTANGLES

public static final CProgressBar.Formatter RECTANGLES

CIRCLES

public static final CProgressBar.Formatter CIRCLES

PARALLELOGRAM

public static final CProgressBar.Formatter PARALLELOGRAM

SIMPLE

public static final CProgressBar.Formatter SIMPLE

RECTANGLES2

public static final CProgressBar.Formatter RECTANGLES2

RECTANGLES3

public static final CProgressBar.Formatter RECTANGLES3

RECTANGLES4

public static final CProgressBar.Formatter RECTANGLES4

DOTS1

public static final CProgressBar.Formatter DOTS1

DOTS2

public static final CProgressBar.Formatter DOTS2

CIRCLES2

public static final CProgressBar.Formatter CIRCLES2

DEFAULT

public static final CProgressBar.Formatter DEFAULT

Constructor Detail

CProgressBar

public CProgressBar(net.thevpc.nuts.NutsSession session)

CProgressBar

public CProgressBar(net.thevpc.nuts.NutsSession session,
                    int size)

Method Detail

getMinPeriod

public long getMinPeriod()

setMinPeriod

public void setMinPeriod(long minPeriod)

getFormatter

public CProgressBar.Formatter getFormatter()

setFormatter

public CProgressBar setFormatter(CProgressBar.Formatter formatter)

getIndeterminatePosition

public CProgressBar.IndeterminatePosition getIndeterminatePosition()

setIndeterminatePosition

public CProgressBar setIndeterminatePosition(CProgressBar.IndeterminatePosition indeterminatePosition)

getSize

public int getSize()

setSize

public CProgressBar setSize(int size)

getColumns

public int getColumns()

setColumns

public CProgressBar setColumns(int columns)

isSuffixMoveLineStart

public boolean isSuffixMoveLineStart()

isPrefixMoveLineStart

public boolean isPrefixMoveLineStart()

isNoMoveLineStart

public boolean isNoMoveLineStart()

setSuffixMoveLineStart

public CProgressBar setSuffixMoveLineStart(boolean v)

setPrefixMoveLineStart

public CProgressBar setPrefixMoveLineStart(boolean v)

setSession

public CProgressBar setSession(net.thevpc.nuts.NutsSession session)

progress

public String progress(int percent)

progressWithoutSession

public String progressWithoutSession(int percent)

progressWithSession

public String progressWithSession(int percent)

progressWithSessionOld

public String progressWithSessionOld(int percent)

progressWithSessionNew

public String progressWithSessionNew(int percent)

printProgress

public void printProgress(int percent,
                          String msg,
                          net.thevpc.nuts.NutsPrintStream out)

progress

public String progress(int percent,
                       String msg)

getIndeterminateSize

public float getIndeterminateSize()

setIndeterminateSize

public CProgressBar setIndeterminateSize(float indeterminateSize)