org.pepsoft.util

Class SubProgressReceiver

java.lang.Object

org.pepsoft.util.SubProgressReceiver

All Implemented Interfaces:

ProgressReceiver

public class SubProgressReceiver
extends Object
implements ProgressReceiver

Nested Class Summary

Nested classes/interfaces inherited from interface org.pepsoft.util.ProgressReceiver

ProgressReceiver.OperationCancelled, ProgressReceiver.OperationCancelledByUser

Constructor Summary

Constructors

Constructor and Description
SubProgressReceiver(ProgressReceiver progressReceiver, float offset, float extent)
SubProgressReceiver(ProgressReceiver progressReceiver, String message, float offset, float extent)

Method Summary

Modifier and Type	Method and Description
void	addListener(ProgressReceiver listener) Adds an additional progress receiver, to which the setProgress(float), setMessage(java.lang.String), done() and exceptionThrown(java.lang.Throwable) methods will be forwarded (without remapping the progress).
void	checkForCancellation() Check whether the operation has been canceled.
void	done() Report that the operation has succeeded successfully.
void	exceptionThrown(Throwable exception) Report that the operation has been aborted due to an exception having been thrown.
Throwable	getCreationTrace()
String	getLastMessage()
ProgressReceiver	getParent()
void	removeListener(ProgressReceiver listener)
void	reset() Restart the progress bar.
void	setMessage(String message) Change the message describing the current operation.
void	setProgress(float progress) Set the progress as a value from 0.0f to 1.0f (inclusive).
void	subProgressStarted(SubProgressReceiver subProgressReceiver) Invoked when a subordinate SubProgressReceiver is started, reporting to this progress receiver.

Methods inherited from class java.lang.Object

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

Constructor Detail

SubProgressReceiver

public SubProgressReceiver(ProgressReceiver progressReceiver,
                           float offset,
                           float extent)
                    throws ProgressReceiver.OperationCancelled

Throws:

ProgressReceiver.OperationCancelled

SubProgressReceiver

public SubProgressReceiver(ProgressReceiver progressReceiver,
                           String message,
                           float offset,
                           float extent)
                    throws ProgressReceiver.OperationCancelled

Throws:

ProgressReceiver.OperationCancelled

Method Detail

addListener

public void addListener(ProgressReceiver listener)

Adds an additional progress receiver, to which the setProgress(float), setMessage(java.lang.String), done() and exceptionThrown(java.lang.Throwable) methods will be forwarded (without remapping the progress). Note that recursive invocations of setMessage(), exceptionThrown() and done() are not reported.

removeListener

public void removeListener(ProgressReceiver listener)

getParent

public ProgressReceiver getParent()

getLastMessage

public String getLastMessage()

getCreationTrace

public Throwable getCreationTrace()

setProgress

public void setProgress(float progress)
                 throws ProgressReceiver.OperationCancelled

Description copied from interface: ProgressReceiver

Set the progress as a value from 0.0f to 1.0f (inclusive).

Specified by:

setProgress in interface ProgressReceiver

Parameters:

progress - The progress to report.

Throws:

ProgressReceiver.OperationCancelled - If the operation has been canceled, for instance by the user, or because of an exception on another thread.

exceptionThrown

public void exceptionThrown(Throwable exception)

Description copied from interface: ProgressReceiver

Report that the operation has been aborted due to an exception having been thrown. Any other threads working on the same operation will be canceled.

Specified by:

exceptionThrown in interface ProgressReceiver

Parameters:

exception - The exception which has been thrown.

done

public void done()

Description copied from interface: ProgressReceiver

Report that the operation has succeeded successfully.

Specified by:

done in interface ProgressReceiver

setMessage

public void setMessage(String message)
                throws ProgressReceiver.OperationCancelled

Description copied from interface: ProgressReceiver

Change the message describing the current operation.

Specified by:

setMessage in interface ProgressReceiver

Parameters:

message - A message describing the current operation.

Throws:

ProgressReceiver.OperationCancelled - If the operation has been canceled, for instance by the user, or because of an exception on another thread.

checkForCancellation

public void checkForCancellation()
                          throws ProgressReceiver.OperationCancelled

Description copied from interface: ProgressReceiver

Check whether the operation has been canceled. An OperationCancelled exception will be thrown if it has.

Specified by:

checkForCancellation in interface ProgressReceiver

Throws:

ProgressReceiver.OperationCancelled - If the operation has been canceled, for instance by the user, or because of an exception on another thread.

reset

public void reset()

Description copied from interface: ProgressReceiver

Restart the progress bar. All progress will be wiped out and the next expected progress report will be expected to be as if progress started from 0.0f again.

Specified by:

reset in interface ProgressReceiver

subProgressStarted

public void subProgressStarted(SubProgressReceiver subProgressReceiver)
                        throws ProgressReceiver.OperationCancelled

Description copied from interface: ProgressReceiver

Invoked when a subordinate SubProgressReceiver is started, reporting to this progress receiver.

Specified by:

subProgressStarted in interface ProgressReceiver

Parameters:

subProgressReceiver - The sub progress receiver which has been started.

Throws:

ProgressReceiver.OperationCancelled - If the operation has been canceled, for instance by the user, or because of an exception on another thread.