Module org.autogui

Package org.autogui.base.log

Class GuiLogEntryProgress

java.lang.Object

org.autogui.base.log.GuiLogEntryProgress

All Implemented Interfaces:

Closeable, AutoCloseable, GuiLogEntry

Direct Known Subclasses:

GuiSwingLogEntryProgress

public class GuiLogEntryProgress
extends Object
implements GuiLogEntry, Closeable

a log-entry for progress:

     [time] minimum|=========value - - - - |maximum : valueP %, message
     or
     [time] |- - - indeterminate - - - | message
     =>
     [time] message
     [endTime] 100%
 

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	GuiLogEntryProgress.GuiLogEntryProgressInterruptedException	an exception thrown by checking-interruption

Field Summary

Fields

Modifier and Type	Field	Description
protected Instant	endTime
protected boolean	indeterminate
protected List<Consumer<GuiLogEntryProgress>>	listeners
protected int	maximum
protected String	message
protected int	minimum
protected Thread	thread
protected Instant	time
protected int	value

Constructor Summary

Constructors

Constructor	Description
GuiLogEntryProgress()

Method Summary

Modifier and Type	Method	Description
GuiLogEntryProgress	addListener(Consumer<GuiLogEntryProgress> listener)
GuiLogEntryProgress	addValue(int n)	it might cause GuiLogEntryProgress.GuiLogEntryProgressInterruptedException
GuiLogEntryProgress	addValueP(double p)	it might cause GuiLogEntryProgress.GuiLogEntryProgressInterruptedException
void	checkInterruption()	if the current thread is equal to the thread of the progress, and the thread is interrupted, it causes GuiLogEntryProgress.GuiLogEntryProgressInterruptedException.
void	close()
void	finish()	it might cause GuiLogEntryProgress.GuiLogEntryProgressInterruptedException.
void	fireChange()	notifies to listeners.
Instant	getEndTime()
List<Consumer<GuiLogEntryProgress>>	getListeners()
int	getMaximum()
String	getMessage()
int	getMinimum()
Thread	getThread()
Instant	getTime()
int	getValue()
double	getValueP()
boolean	isActive()
boolean	isFinished()
boolean	isIndeterminate()
GuiLogEntryProgress	removeListener(Consumer<GuiLogEntryProgress> listener)
GuiLogEntryProgress	setEndTime(Instant endTime)
GuiLogEntryProgress	setIndeterminate(boolean indeterminate)	it might cause GuiLogEntryProgress.GuiLogEntryProgressInterruptedException.
GuiLogEntryProgress	setMaximum(int maximum)	it might cause GuiLogEntryProgress.GuiLogEntryProgressInterruptedException.
GuiLogEntryProgress	setMessage(String message)	it might cause GuiLogEntryProgress.GuiLogEntryProgressInterruptedException.
GuiLogEntryProgress	setMinimum(int minimum)	it might cause GuiLogEntryProgress.GuiLogEntryProgressInterruptedException.
void	setState(GuiLogEntryProgress p)	copy fields of p.
GuiLogEntryProgress	setThread(Thread thread)
GuiLogEntryProgress	setTime(Instant time)
GuiLogEntryProgress	setValue(int n)	it might cause GuiLogEntryProgress.GuiLogEntryProgressInterruptedException if the value is actually changed, it causes a notification to listeners
GuiLogEntryProgress	setValueP(double p)	it might cause GuiLogEntryProgress.GuiLogEntryProgressInterruptedException
String	toString()

Methods inherited from class java.lang.Object

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

Field Details

minimum

protected int minimum

maximum

protected int maximum

value

protected int value

indeterminate

protected boolean indeterminate

message

protected String message

time

protected Instant time

endTime

protected Instant endTime

thread

protected Thread thread

listeners

protected List<Consumer<GuiLogEntryProgress>> listeners

Constructor Details

GuiLogEntryProgress

public GuiLogEntryProgress()

Method Details

setState

public void setState(GuiLogEntryProgress p)

copy fields of p. p can be null

Parameters:

p - copied state

addListener

public GuiLogEntryProgress addListener(Consumer<GuiLogEntryProgress> listener)

Parameters:

listener - the listener will receive the progress when its valueP is updated

Returns:

this

removeListener

public GuiLogEntryProgress removeListener(Consumer<GuiLogEntryProgress> listener)

getListeners

public List<Consumer<GuiLogEntryProgress>> getListeners()

fireChange

public void fireChange()

notifies to listeners. this is automatically called from setter methods

setMinimum

public GuiLogEntryProgress setMinimum(int minimum)

it might cause GuiLogEntryProgress.GuiLogEntryProgressInterruptedException. it also causes a notification to listeners when the minimum value is actually changed.

Parameters:

minimum - the minimum value of the progress to be set: if the value is smaller than the maximum, then the intermediate flag becomes false

Returns:

this

setMaximum

public GuiLogEntryProgress setMaximum(int maximum)

it might cause GuiLogEntryProgress.GuiLogEntryProgressInterruptedException. it also causes a notification to listeners when the maximum value is actually changed.

Parameters:

maximum - the maximum value of the progress to be set: if the value is larger than the minimum then the intermediate flag becomes false

Returns:

this

setValueP

public GuiLogEntryProgress setValueP(double p)

it might cause GuiLogEntryProgress.GuiLogEntryProgressInterruptedException

Parameters:

p - 0 to 1.0

Returns:

this

See Also:

• setValue(int)

setValue

public GuiLogEntryProgress setValue(int n)

it might cause GuiLogEntryProgress.GuiLogEntryProgressInterruptedException if the value is actually changed, it causes a notification to listeners

Parameters:

n - the progress value

Returns:

this

addValueP

public GuiLogEntryProgress addValueP(double p)

it might cause GuiLogEntryProgress.GuiLogEntryProgressInterruptedException

Parameters:

p - 0 to 1.0

Returns:

this

See Also:

• addValue(int)

addValue

public GuiLogEntryProgress addValue(int n)

it might cause GuiLogEntryProgress.GuiLogEntryProgressInterruptedException

Parameters:

n - added value to the progress

Returns:

this

See Also:

• setValue(int)

setIndeterminate

public GuiLogEntryProgress setIndeterminate(boolean indeterminate)

it might cause GuiLogEntryProgress.GuiLogEntryProgressInterruptedException. if the flag is actually changed, it causes a notification to listeners

Parameters:

indeterminate - the intermediate flag to be set

Returns:

this

setMessage

public GuiLogEntryProgress setMessage(String message)

it might cause GuiLogEntryProgress.GuiLogEntryProgressInterruptedException. the method will never cause a notification

Parameters:

message - the new message

Returns:

this

setEndTime

public GuiLogEntryProgress setEndTime(Instant endTime)

setTime

public GuiLogEntryProgress setTime(Instant time)

isIndeterminate

public boolean isIndeterminate()

getMaximum

public int getMaximum()

getMinimum

public int getMinimum()

getValue

public int getValue()

getValueP

public double getValueP()

getTime

public Instant getTime()

getMessage

public String getMessage()

isFinished

public boolean isFinished()

Returns:

true if endTime is set

close

public void close()

Specified by:

close in interface AutoCloseable

Specified by:

close in interface Closeable

finish

public void finish()

it might cause GuiLogEntryProgress.GuiLogEntryProgressInterruptedException. endTime will be set. value becomes maximum

getEndTime

public Instant getEndTime()

setThread

public GuiLogEntryProgress setThread(Thread thread)

getThread

public Thread getThread()

Returns:

by default, the current thread of constructor sender

checkInterruption

public void checkInterruption()

if the current thread is equal to the thread of the progress, and the thread is interrupted, it causes GuiLogEntryProgress.GuiLogEntryProgressInterruptedException.

isActive

public boolean isActive()

Specified by:

isActive in interface GuiLogEntry

Returns:

true if the record is running and updating

toString

public String toString()

Overrides:

toString in class Object