org.eclipse.jgit.transport

Class ProgressSpinner

java.lang.Object

org.eclipse.jgit.transport.ProgressSpinner

public class ProgressSpinner
extends java.lang.Object

A simple spinner connected to an OutputStream.

This is class is not thread-safe. The update method may only be used from a single thread. Updates are sent only as frequently as update() is invoked by the caller, and are capped at no more than 2 times per second by requiring at least 500 milliseconds between updates.

Since:

4.2

Field Summary

Fields

Modifier and Type	Field and Description
private static long	MIN_REFRESH_MILLIS
private java.lang.String	msg
private long	nextUpdateMillis
private java.io.OutputStream	out
private boolean	shown
private int	state
private static char[]	STATES
private boolean	write

Constructor Summary

Constructors

Constructor and Description
ProgressSpinner(java.io.OutputStream out) Initialize a new spinner.

Method Summary

Modifier and Type	Method and Description
void	beginTask(java.lang.String title, long delay, java.util.concurrent.TimeUnit delayUnits) Begin a time consuming task.
void	endTask(java.lang.String result) Denote the current task completed.
private void	send(long now)
void	update() Update the spinner if it is showing.
private void	write(java.lang.String s)

Methods inherited from class java.lang.Object

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

Field Detail

MIN_REFRESH_MILLIS

private static final long MIN_REFRESH_MILLIS

See Also:

Constant Field Values

STATES

private static final char[] STATES

out

private final java.io.OutputStream out

msg

private java.lang.String msg

state

private int state

write

private boolean write

shown

private boolean shown

nextUpdateMillis

private long nextUpdateMillis

Constructor Detail

ProgressSpinner

public ProgressSpinner(java.io.OutputStream out)

Initialize a new spinner.

Parameters:

out - where to send output to.

Method Detail

beginTask

public void beginTask(java.lang.String title,
                      long delay,
                      java.util.concurrent.TimeUnit delayUnits)

Begin a time consuming task.

Parameters:

title - description of the task, suitable for human viewing.

delay - delay to wait before displaying anything at all.

delayUnits - unit for delay.

update

public void update()

Update the spinner if it is showing.

send

private void send(long now)

endTask

public void endTask(java.lang.String result)

Denote the current task completed.

Parameters:

result - text to print after the task's title "$title ... $result".

write

private void write(java.lang.String s)