Package org.geotools.data.util
Class DefaultProgressListener
- Object
-
- NullProgressListener
-
- DefaultProgressListener
-
- All Implemented Interfaces:
ProgressListener
public class DefaultProgressListener extends NullProgressListener implements ProgressListener
Default Implementation ofProgressListener
that does retain exceptions.We do not put particular attention on the management of canceled, started, completed, this is a default implementation.
- Since:
- 2.8
- Author:
- Simone Giannecchini, GeoSolutions SAS
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static class
DefaultProgressListener.Warning
Collector class for warnings.
-
Constructor Summary
Constructors Constructor Description DefaultProgressListener()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description void
complete()
Notifies this listener that the operation has finished.void
dispose()
Releases any resources used by this listener.void
exceptionOccurred(Throwable exception)
Reports an exception.Queue<Throwable>
getExceptions()
Return a copy of theQueue
of exceptions that had happened.float
getProgress()
Returns the current progress as a percent completed.InternationalString
getTask()
Returns the description of the current task being performed, ornull
if none.Queue<DefaultProgressListener.Warning>
getWarnings()
Retrieves a copy of the warnings occurred.boolean
hasExceptions()
It tells us if we have exceptions or not.boolean
isCompleted()
Is the task we are listening is completed.boolean
isStarted()
Is the task we are listening for started.void
progress(float percent)
Notifies this listener of progress in the lengthly operation.void
setTask(InternationalString task)
Sets the description of the current task being performed.void
started()
Notifies this listener that the operation begins.String
toString()
void
warningOccurred(String source, String margin, String warning)
Reports a warning.-
Methods inherited from class NullProgressListener
getDescription, isCanceled, setCanceled, setDescription
-
Methods inherited from class Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
-
Methods inherited from interface ProgressListener
isCanceled, setCanceled
-
-
-
-
Method Detail
-
complete
public void complete()
Description copied from interface:ProgressListener
Notifies this listener that the operation has finished. The progress indicator will shows 100% or disappears, at implementor choice. If warning messages were pending, they will be displayed now.- Specified by:
complete
in interfaceProgressListener
- Overrides:
complete
in classNullProgressListener
-
dispose
public void dispose()
Description copied from interface:ProgressListener
Releases any resources used by this listener. If the progress were reported in a window, this window may be disposed.- Specified by:
dispose
in interfaceProgressListener
- Overrides:
dispose
in classNullProgressListener
-
exceptionOccurred
public void exceptionOccurred(Throwable exception)
Description copied from interface:ProgressListener
Reports an exception. This method may prints the stack trace to the standard error stream or display it in a dialog box, at implementor choice.- Specified by:
exceptionOccurred
in interfaceProgressListener
- Overrides:
exceptionOccurred
in classNullProgressListener
- Parameters:
exception
- The exception to report.
-
progress
public void progress(float percent)
Description copied from interface:ProgressListener
Notifies this listener of progress in the lengthly operation. Progress are reported as a value between 0 and 100 inclusive. Values out of bounds will be clamped.- Specified by:
progress
in interfaceProgressListener
- Overrides:
progress
in classNullProgressListener
- Parameters:
percent
- The progress as a value between 0 and 100 inclusive.
-
started
public void started()
Description copied from interface:ProgressListener
Notifies this listener that the operation begins.- Specified by:
started
in interfaceProgressListener
- Overrides:
started
in classNullProgressListener
-
warningOccurred
public void warningOccurred(String source, String margin, String warning)
Description copied from interface:ProgressListener
Reports a warning. This warning may be logged, printed to the standard error stream, appears in a windows or be ignored, at implementor choice.- Specified by:
warningOccurred
in interfaceProgressListener
- Overrides:
warningOccurred
in classNullProgressListener
- Parameters:
source
- Name of the warning source, ornull
if none. This is typically the filename in process of being parsed or the URL of the data being processedmargin
- Text to write on the left side of the warning message, ornull
if none. This is typically the line number where the error occured in thesource
file or the feature ID of the feature that produced the messagewarning
- The warning message.
-
getProgress
public float getProgress()
Description copied from interface:ProgressListener
Returns the current progress as a percent completed.- Specified by:
getProgress
in interfaceProgressListener
- Overrides:
getProgress
in classNullProgressListener
- Returns:
- Percent completed between 0 and 100 inclusive.
-
getTask
public InternationalString getTask()
Description copied from interface:ProgressListener
Returns the description of the current task being performed, ornull
if none. It is assumed that if the task isnull
applications may simply report that the process is "in progress" or "working" as represented in the current locale.- Specified by:
getTask
in interfaceProgressListener
- Overrides:
getTask
in classNullProgressListener
- Returns:
- Description of the task being performed, or
null
if none.
-
setTask
public void setTask(InternationalString task)
Description copied from interface:ProgressListener
Sets the description of the current task being performed. This method is usually invoked before any progress begins. However, it is legal to invoke this method at any time during the operation, in which case the description display is updated without any change to the percentage accomplished.- Specified by:
setTask
in interfaceProgressListener
- Overrides:
setTask
in classNullProgressListener
- Parameters:
task
- Description of the task being performed, ornull
if none.
-
isCompleted
public boolean isCompleted()
Is the task we are listening is completed.- Returns:
true
if the task is completed,false
if it is not.
-
getExceptions
public Queue<Throwable> getExceptions()
Return a copy of theQueue
of exceptions that had happened.- Returns:
- a copy of the
Queue
of exceptions that had happened.
-
hasExceptions
public boolean hasExceptions()
It tells us if we have exceptions or not.- Returns:
true
if there are exceptions,false
otherwise.
-
isStarted
public boolean isStarted()
Is the task we are listening for started.- Returns:
true
if the task is started,false
if it is not.
-
getWarnings
public Queue<DefaultProgressListener.Warning> getWarnings()
Retrieves a copy of the warnings occurred.- Returns:
- a copy of the warnings occurred.
-
-