Clique 4.0.3 · io.github.kusoroadeolu.clique.components.ProgressBar

Modifier and Type	Field and Description
pack-priv final ProgressBarConfiguration	configuration
pack-priv final long	creationTime
pack-priv int	currentTick
pack-priv boolean	isDone
pack-priv final int	total

Access	Constructor and Description
private	ProgressBar(int currentTick, int total, boolean isDone, long creationTime, ProgressBarConfiguration configuration)
public	ProgressBar(int total, ProgressBarConfiguration configuration)
public	ProgressBar(int total)

Method Summary

Modifier and Type	Method and Description
private String	alignRight(String text, int size)
private String	barText()
public ProgressBar	Returns: this instance complete() Advances the progress bar to completion and re-renders it to `System#out`.
public ProgressBar	Returns: this instance complete(boolean if the progress bar should be re-rendered to `System#out` render) Advances the progress bar to completion.
private void	easeTick(int amount, EasingConfiguration easingConfig)
private long	elapsedTime()
public boolean	equals(Object o) Overrides java.lang.Object.equals. Indicates whether some other object is "equal to" this one.
public String	Returns: the rendered progress bar string; never `null` get() Implements io.github.kusoroadeolu.clique.components.Component.get. Returns the current rendered string representation of the progress bar, with all format tokens resolved.
public int	hashCode() Overrides java.lang.Object.hashCode. Returns a hash code value for this object.
private String	interval(Long milliseconds)
public boolean	Returns: `true` if `currentTick >= total`; `false` otherwise isDone() Returns whether the progress bar has reached its total.
private int	percent()
private Long	remainingTime()
public void	render(PrintStream the stream to render to; must not be `null` printStream) Overrides default io.github.kusoroadeolu.clique.components.Component.render. Renders the progress bar to the given `PrintStream` in place, using a carriage return (`\r`) to overwrite the current line.
public ProgressBar	Returns: this instance tick() Advances the progress bar by `1` tick and re-renders it to `System#out`.
public ProgressBar	Returns: this instance tick(int the number of ticks to advance; must be `>= 1` amount) Advances the progress bar by the given number of ticks and re-renders it to `System#out`.
public ProgressBar	Returns: this instance tick(boolean if the progress bar should be re-rendered to `System#out` Equivalent to `tick(1)`. render) Advances the progress bar by `1` tick.
public ProgressBar	Returns: this instance tick(int the number of ticks to advance; must be `>= 1` amount, boolean if the progress bar should be re-rendered to `System#out` render) Advances the progress bar by the given number of ticks.
public ProgressBar	Returns: this instance tickAnimated(int the number of ticks to advance; must be `>= 1` amount) Advances the progress bar by the given amount, applying easing if configured.
public String	toString() Overrides java.lang.Object.toString. Returns a string representation of the object.

Inherited from java.lang.Object:: clone finalize getClass notify notifyAll wait wait wait

configuration	back to summary
pack-priv final ProgressBarConfiguration configuration

creationTime	back to summary
pack-priv final long creationTime

currentTick	back to summary
pack-priv int currentTick

isDone	back to summary
pack-priv boolean isDone

total	back to summary
pack-priv final int total

ProgressBar	back to summary
private ProgressBar(int currentTick, int total, boolean isDone, long creationTime, ProgressBarConfiguration configuration)

ProgressBar	back to summary
public ProgressBar(int total, ProgressBarConfiguration configuration)

ProgressBar	back to summary
public ProgressBar(int total)

Method Detail

alignRight	back to summary
private String alignRight(String text, int size)

barText	back to summary
private String barText()

complete back to summary

complete	back to summary
public ProgressBar complete() Advances the progress bar to completion and re-renders it to `System#out`. Equivalent to ticking by `total - currentTick`. If the bar is already complete, this method does not throw Returns:ProgressBar this instance

public ProgressBar complete()

Advances the progress bar to completion and re-renders it to System#out.

Equivalent to ticking by total - currentTick. If the bar is already complete, this method does not throw

Returns:ProgressBar: this instance

complete back to summary

complete	back to summary
public ProgressBar complete(boolean render) Advances the progress bar to completion. Equivalent to ticking by `total - currentTick`. If the bar is already complete, this method does not throw Parameters render:boolean if the progress bar should be re-rendered to `System#out` Returns:ProgressBar this instance

public ProgressBar complete(boolean render)

Advances the progress bar to completion.

Equivalent to ticking by total - currentTick. If the bar is already complete, this method does not throw

Parameters

render:boolean: if the progress bar should be re-rendered to System#out

Returns:ProgressBar

this instance

easeTick	back to summary
private void easeTick(int amount, EasingConfiguration easingConfig)

elapsedTime	back to summary
private long elapsedTime()

equals back to summary

equals	back to summary
public boolean equals(Object o) Overrides java.lang.Object.equals. Doc from java.lang.Object.equals. Indicates whether some other object is "equal to" this one. The `equals` method implements an equivalence relation on non-null object references: It is reflexive: for any non-null reference value `x`, `x.equals(x)` should return `true`. It is symmetric: for any non-null reference values `x` and `y`, `x.equals(y)` should return `true` if and only if `y.equals(x)` returns `true`. It is transitive: for any non-null reference values `x`, `y`, and `z`, if `x.equals(y)` returns `true` and `y.equals(z)` returns `true`, then `x.equals(z)` should return `true`. It is consistent: for any non-null reference values `x` and `y`, multiple invocations of `x.equals(y)` consistently return `true` or consistently return `false`, provided no information used in `equals` comparisons on the objects is modified. For any non-null reference value `x`, `x.equals(null)` should return `false`. An equivalence relation partitions the elements it operates on into equivalence classes; all the members of an equivalence class are equal to each other. Members of an equivalence class are substitutable for each other, at least for some purposes. Annotations @Override

public boolean equals(Object o)

Overrides java.lang.Object.equals.

Doc from java.lang.Object.equals.

Indicates whether some other object is "equal to" this one.

The equals method implements an equivalence relation on non-null object references:

It is reflexive: for any non-null reference value x, x.equals(x) should return true.
It is symmetric: for any non-null reference values x and y, x.equals(y) should return true if and only if y.equals(x) returns true.
It is transitive: for any non-null reference values x, y, and z, if x.equals(y) returns true and y.equals(z) returns true, then x.equals(z) should return true.
It is consistent: for any non-null reference values x and y, multiple invocations of x.equals(y) consistently return true or consistently return false, provided no information used in equals comparisons on the objects is modified.
For any non-null reference value x, x.equals(null) should return false.

An equivalence relation partitions the elements it operates on into equivalence classes; all the members of an equivalence class are equal to each other. Members of an equivalence class are substitutable for each other, at least for some purposes.

Annotations

@Override

get back to summary

get	back to summary
public String get() Implements io.github.kusoroadeolu.clique.components.Component.get. Returns the current rendered string representation of the progress bar, with all format tokens resolved. The format string is sourced from `ProgressBarConfiguration#getFormatForPercent(int)` based on the current completion percentage. Markup tags in the resolved string are parsed if a parser is configured. Returns:String the rendered progress bar string; never `null`

public String get()

Implements io.github.kusoroadeolu.clique.components.Component.get.

Returns the current rendered string representation of the progress bar, with all format tokens resolved.

The format string is sourced from ProgressBarConfiguration#getFormatForPercent(int) based on the current completion percentage. Markup tags in the resolved string are parsed if a parser is configured.

Returns:String: the rendered progress bar string; never null

hashCode back to summary

hashCode	back to summary
public int hashCode() Overrides java.lang.Object.hashCode. Doc from java.lang.Object.hashCode. Returns a hash code value for this object. This method is supported for the benefit of hash tables such as those provided by `java.util.HashMap`. The general contract of `hashCode` is: Whenever it is invoked on the same object more than once during an execution of a Java application, the `hashCode` method must consistently return the same integer, provided no information used in `equals` comparisons on the object is modified. This integer need not remain consistent from one execution of an application to another execution of the same application. If two objects are equal according to the `equals` method, then calling the `hashCode` method on each of the two objects must produce the same integer result. It is not required that if two objects are unequal according to the `equals` method, then calling the `hashCode` method on each of the two objects must produce distinct integer results. However, the programmer should be aware that producing distinct integer results for unequal objects may improve the performance of hash tables. Annotations @Override

public int hashCode()

Overrides java.lang.Object.hashCode.

Doc from java.lang.Object.hashCode.

Returns a hash code value for this object. This method is supported for the benefit of hash tables such as those provided by java.util.HashMap.

The general contract of hashCode is:

Whenever it is invoked on the same object more than once during an execution of a Java application, the hashCode method must consistently return the same integer, provided no information used in equals comparisons on the object is modified. This integer need not remain consistent from one execution of an application to another execution of the same application.
If two objects are equal according to the equals method, then calling the hashCode method on each of the two objects must produce the same integer result.
It is not required that if two objects are unequal according to the equals method, then calling the hashCode method on each of the two objects must produce distinct integer results. However, the programmer should be aware that producing distinct integer results for unequal objects may improve the performance of hash tables.

Annotations

@Override

interval	back to summary
private String interval(Long milliseconds)

isDone back to summary

isDone	back to summary
public boolean isDone() Returns whether the progress bar has reached its total. Returns:boolean `true` if `currentTick >= total`; `false` otherwise

public boolean isDone()

Returns whether the progress bar has reached its total.

Returns:boolean: true if currentTick >= total; false otherwise

percent	back to summary
private int percent()

remainingTime	back to summary
private Long remainingTime()

render back to summary

render	back to summary
public void render(PrintStream printStream) Overrides default io.github.kusoroadeolu.clique.components.Component.render. Renders the progress bar to the given `PrintStream` in place, using a carriage return (`\r`) to overwrite the current line. When `isDone()` is `true`, a newline is appended after the final render to advance the cursor past the completed bar. Parameters printStream:PrintStream the stream to render to; must not be `null` Annotations @Override

public void render(PrintStream printStream)

Overrides default io.github.kusoroadeolu.clique.components.Component.render.

Renders the progress bar to the given PrintStream in place, using a carriage return (\r) to overwrite the current line.

When isDone() is true, a newline is appended after the final render to advance the cursor past the completed bar.

Parameters

printStream:PrintStream: the stream to render to; must not be null

Annotations

@Override

tick back to summary

tick	back to summary
public ProgressBar tick() Advances the progress bar by `1` tick and re-renders it to `System#out`. Equivalent to `tick(1)`. Returns:ProgressBar this instance

public ProgressBar tick()

Advances the progress bar by 1 tick and re-renders it to System#out.

Equivalent to tick(1).

Returns:ProgressBar: this instance

tick back to summary

tick	back to summary
public ProgressBar tick(int amount) Advances the progress bar by the given number of ticks and re-renders it to `System#out`. The current tick is clamped to `[0, total]`. If this call causes `currentTick >= total`, `isDone()` will return `true` and a newline is emitted on the next render. Parameters amount:int the number of ticks to advance; must be `>= 1` Returns:ProgressBar this instance Exceptions IllegalArgumentException: if `amount` is less than `1`

public ProgressBar tick(int amount)

Advances the progress bar by the given number of ticks and re-renders it to System#out.

The current tick is clamped to [0, total]. If this call causes currentTick >= total, isDone() will return true and a newline is emitted on the next render.

Parameters

amount:int: the number of ticks to advance; must be >= 1

Returns:ProgressBar

this instance

Exceptions

IllegalArgumentException:: if amount is less than 1

tick back to summary

tick	back to summary
public ProgressBar tick(boolean render) Advances the progress bar by `1` tick. Parameters render:boolean if the progress bar should be re-rendered to `System#out` Equivalent to `tick(1)`. Returns:ProgressBar this instance

public ProgressBar tick(boolean render)

Advances the progress bar by 1 tick.

Parameters

render:boolean

if the progress bar should be re-rendered to System#out

Equivalent to tick(1).

Returns:ProgressBar

this instance

tick back to summary

tick	back to summary
public ProgressBar tick(int amount, boolean render) Advances the progress bar by the given number of ticks. The current tick is clamped to `[0, total]`. If this call causes `currentTick >= total`, `isDone()` will return `true` and a newline is emitted on the next render. Parameters amount:int the number of ticks to advance; must be `>= 1` render:boolean if the progress bar should be re-rendered to `System#out` Returns:ProgressBar this instance Exceptions IllegalArgumentException: if `amount` is less than `1`

public ProgressBar tick(int amount, boolean render)

Advances the progress bar by the given number of ticks.

The current tick is clamped to [0, total]. If this call causes currentTick >= total, isDone() will return true and a newline is emitted on the next render.

Parameters

amount:int: the number of ticks to advance; must be >= 1
render:boolean: if the progress bar should be re-rendered to System#out

Returns:ProgressBar

this instance

Exceptions

IllegalArgumentException:: if amount is less than 1

tickAnimated back to summary

tickAnimated	back to summary
public ProgressBar tickAnimated(int amount) Advances the progress bar by the given amount, applying easing if configured. If the active `ProgressBarConfiguration` has an `EasingConfiguration` whose `shouldEase(amount)` returns `true`, the tick is interpolated across multiple frames using the configured easing function and frame delay. Otherwise, delegates directly to `tick(int)`. This method blocks the calling thread for the duration of the animation when easing is applied. Parameters amount:int the number of ticks to advance; must be `>= 1` Returns:ProgressBar this instance

public ProgressBar tickAnimated(int amount)

Advances the progress bar by the given amount, applying easing if configured.

If the active ProgressBarConfiguration has an EasingConfiguration whose shouldEase(amount) returns true, the tick is interpolated across multiple frames using the configured easing function and frame delay. Otherwise, delegates directly to tick(int).

This method blocks the calling thread for the duration of the animation when easing is applied.

Parameters

amount:int: the number of ticks to advance; must be >= 1

Returns:ProgressBar

this instance

toString back to summary

toString	back to summary
public String toString() Overrides java.lang.Object.toString. Doc from java.lang.Object.toString. Returns a string representation of the object. Satisfying this method's contract implies a non-`null` result must be returned. Annotations @Override

public String toString()

Overrides java.lang.Object.toString.

Doc from java.lang.Object.toString.

Returns a string representation of the object. Satisfying this method's contract implies a non-null result must be returned.

Annotations

@Override

public Class ProgressBar

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail