net.neoforged.cliutils.progress

Class ProgressReporter

java.lang.Object

net.neoforged.cliutils.progress.ProgressReporter

All Implemented Interfaces:

ProgressManager

public class ProgressReporter
extends java.lang.Object
implements ProgressManager

A ProgressManager that forwards all changes to a print stream that writes the changes with an ANSI modifier "progressmanager".
The ANSI modifier takes the form "\033[progressmanager;action value".

The default reporter will only be enabled if the "net.neoforged.progressmanager.enabled" system property is set to true, and will output to System.err.

See Also:

for the actions

Field Summary

Fields

Modifier and Type	Field and Description
protected boolean	enabled
static java.lang.String	ENABLED_PROPERTY
static java.lang.String	MODIFIER_KEY
protected java.io.PrintStream	output

Constructor Summary

Constructors

Constructor and Description
ProgressReporter(boolean enabled, java.io.PrintStream output)

Method Summary

Modifier and Type	Method and Description
static ProgressReporter	getDefault()
void	setIndeterminate(boolean indeterminate) Sets whether the max progress is known or not.
void	setMaxProgress(int maxProgress) Sets the max progress of the manager.
void	setPercentageProgress(double progress) Sets progress of the manager, based on a fractional value.
void	setProgress(int progress) Sets the current progress of the manager.
void	setStep(java.lang.String name) Sets the current step to be shown to the user.
java.io.InputStream	wrapDownload(java.io.InputStream in)
java.io.InputStream	wrapDownload(java.net.URLConnection connection)
protected void	write(ProgressActionType type, java.lang.String value)

Methods inherited from class java.lang.Object

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

Field Detail

MODIFIER_KEY

public static final java.lang.String MODIFIER_KEY

See Also:

Constant Field Values

ENABLED_PROPERTY

public static final java.lang.String ENABLED_PROPERTY

See Also:

Constant Field Values

enabled

protected final boolean enabled

output

protected final java.io.PrintStream output

Constructor Detail

ProgressReporter

public ProgressReporter(boolean enabled,
                        java.io.PrintStream output)

Method Detail

getDefault

public static ProgressReporter getDefault()

setMaxProgress

public void setMaxProgress(int maxProgress)

Description copied from interface: ProgressManager

Sets the max progress of the manager.

Specified by:

setMaxProgress in interface ProgressManager

setProgress

public void setProgress(int progress)

Description copied from interface: ProgressManager

Sets the current progress of the manager.

Specified by:

setProgress in interface ProgressManager

setPercentageProgress

public void setPercentageProgress(double progress)

Description copied from interface: ProgressManager

Sets progress of the manager, based on a fractional value.
Note: this also sets the ProgressManager.setMaxProgress(int) to 100.

Specified by:

setPercentageProgress in interface ProgressManager

setStep

public void setStep(java.lang.String name)

Description copied from interface: ProgressManager

Sets the current step to be shown to the user.

Specified by:

setStep in interface ProgressManager

setIndeterminate

public void setIndeterminate(boolean indeterminate)

Description copied from interface: ProgressManager

Sets whether the max progress is known or not. If not, the loading bar will load 'forever'.

Specified by:

setIndeterminate in interface ProgressManager

write

protected void write(ProgressActionType type,
                     java.lang.String value)

wrapDownload

public java.io.InputStream wrapDownload(java.net.URLConnection connection)
                                 throws java.io.IOException

Throws:

java.io.IOException

wrapDownload

public java.io.InputStream wrapDownload(java.io.InputStream in)