public class DummyProgressListener extends Object implements ProgressListener
Constructor and Description |
---|
DummyProgressListener() |
Modifier and Type | Method and 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.
|
String |
getDescription() |
float |
getProgress()
Returns the current progress as a percent completed.
|
InternationalString |
getTask()
Returns the description of the current task being performed, or
null if none. |
boolean |
isCanceled()
Returns
true if this job is cancelled. |
void |
progress(float percent)
Notifies this listener of progress in the lengthly operation.
|
void |
setCanceled(boolean cancel)
Indicates that task should be cancelled.
|
void |
setDescription(String description) |
void |
setTask(InternationalString task)
Sets the description of the current task being performed.
|
void |
started()
Notifies this listener that the operation begins.
|
void |
warningOccurred(String source,
String location,
String warning)
Reports a warning.
|
public void complete()
ProgressListener
complete
in interface ProgressListener
public void dispose()
ProgressListener
dispose
in interface ProgressListener
public void exceptionOccurred(Throwable exception)
ProgressListener
exceptionOccurred
in interface ProgressListener
exception
- The exception to report.public String getDescription()
public float getProgress()
ProgressListener
getProgress
in interface ProgressListener
public InternationalString getTask()
ProgressListener
null
if none. It is
assumed that if the task is null
applications may simply report that the process is
"in progress" or "working" as represented in the current locale.getTask
in interface ProgressListener
null
if none.public boolean isCanceled()
ProgressListener
true
if this job is cancelled.isCanceled
in interface ProgressListener
true
if this job is cancelled.public void progress(float percent)
ProgressListener
progress
in interface ProgressListener
percent
- The progress as a value between 0 and 100 inclusive.public void setCanceled(boolean cancel)
ProgressListener
setCanceled
in interface ProgressListener
cancel
- true
for cancelling the task.public void setDescription(String description)
public void setTask(InternationalString task)
ProgressListener
setTask
in interface ProgressListener
task
- Description of the task being performed, or null
if none.public void started()
ProgressListener
started
in interface ProgressListener
public void warningOccurred(String source, String location, String warning)
ProgressListener
warningOccurred
in interface ProgressListener
source
- Name of the warning source, or null
if none. This is typically the
filename in process of being parsed or the URL of the data being processedlocation
- Text to write on the left side of the warning message, or null
if
none. This is typically the line number where the error occured in the source
file or the feature ID of the feature that produced the messagewarning
- The warning message.Copyright © 1996–2023 Geotools. All rights reserved.