genius.core.misc

Class Progress

java.lang.Object

genius.core.misc.Progress

public class Progress
extends java.lang.Object

Contains the progress of something. This can be anything as long as it can be counted with an integer and has a known integer end. For example we can count the progress in a tournament if we know that we doe n negotiations in that tournament.

Field Summary

Fields

Modifier and Type	Field and Description
static int	ALL Flag for including all of the above in report
static int	CHAR Flag for including a spinner in report
static int	CURRENT_TOTAL Flag for including current/total in the reporting (example: 5/20)
static int	ETA Flag for including estimate time ahead (ETA) in report (example: ETA: 5 minutes)
static int	PERCENTAGE Flag for including percentage in the reporting (example: (25%))

Constructor Summary

Constructors

Constructor and Description
Progress(int total) Initializes a new instant of the Progress object.

Method Summary

Modifier and Type	Method and Description
double	getEta() Gets the estimated time remaining based on the time we used so fare
long	getNowNano() Gets the nano time passed since start of progress.
java.lang.String	getNowPretty(boolean includeSeconds) Gets the time passed as an human readable string.
double	getProgress() Gets the progress as a fraction
java.lang.String	getProgressString(int options) Gets the progress string.
int	getTotal() Get the final number for this progress
void	increment() Increases the progress by 1, but never beyond the total progress
void	increment(int n) Increases the progress by n, but never beyond the total progress
boolean	isDone() Returns true if this progress is at last state.
void	printProgressToConsole(int options) Erases previously printed line and prints the progress string.
void	start() Mark now as the starting point in negotiation

Methods inherited from class java.lang.Object

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

Field Detail

CURRENT_TOTAL

public static int CURRENT_TOTAL

Flag for including current/total in the reporting (example: 5/20)

PERCENTAGE

public static int PERCENTAGE

Flag for including percentage in the reporting (example: (25%))

ETA

public static int ETA

Flag for including estimate time ahead (ETA) in report (example: ETA: 5 minutes)

CHAR

public static int CHAR

Flag for including a spinner in report

ALL

public static int ALL

Flag for including all of the above in report

Constructor Detail

Progress

public Progress(int total)

Initializes a new instant of the Progress object. To use timing (ETA), you additionally should call the .start() function as closely to the function to be timed as possible.

Parameters:

total - The total amount of progress that can be made

Method Detail

increment

public void increment()

Increases the progress by 1, but never beyond the total progress

increment

public void increment(int n)

Increases the progress by n, but never beyond the total progress

Parameters:

n - the value to be added

isDone

public boolean isDone()

Returns true if this progress is at last state.

Returns:

True if current ≥ total, false otherwise

start

public void start()

Mark now as the starting point in negotiation

getNowNano

public long getNowNano()

Gets the nano time passed since start of progress.

Returns:

amount of nanoseconds since .start() was called

getNowPretty

public java.lang.String getNowPretty(boolean includeSeconds)

Gets the time passed as an human readable string.

Parameters:

includeSeconds - if true, will print up to seconds. if false, will print up to minutes.

Returns:

Time passed since .start() as a string (example: 2 hours, 5 minutes)

getTotal

public int getTotal()

Get the final number for this progress

Returns:

The number up to which to progress

getProgress

public double getProgress()

Gets the progress as a fraction

Returns:

value between 0.0 (not started yet) and 1.0 (done)

getProgressString

public java.lang.String getProgressString(int options)

Gets the progress string. Will return depending on the used options. use the constant values in this class to generate the options. for example: getProgressString(Progress.ETA | Progress.CURRENT_TOTAL)

Progress.ETA: Report estimated time ahead Progress.CURRENT_TOTAL: Report current/total Progress.PERCENTAGE: Report percentage done Progress.CHAR: Show spinner char Progress.ALL: All of the above

Parameters:

options - See description

Returns:

String with the current progress

printProgressToConsole

public void printProgressToConsole(int options)

Erases previously printed line and prints the progress string. Will print depending on the used options. use the constant values in this class to generate the options. for example: getProgressString(Progress.ETA | Progress.CURRENT_TOTAL)

Progress.ETA: Report estimated time ahead Progress.CURRENT_TOTAL: Report current/total Progress.PERCENTAGE: Report percentage done Progress.CHAR: Show spinner char Progress.ALL: All of the above

Parameters:

options - See description

getEta

public double getEta()

Gets the estimated time remaining based on the time we used so fare

Returns:

estimated time remaining in nano seconds.