|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.geotools.util.NullProgressListener
public class NullProgressListener
A default progress listener implementation suitable for subclassing.
This implementation supports cancelation and getting/setting the description. The default implementations of the other methods do nothing.
Constructor Summary | |
---|---|
NullProgressListener()
Creates a null progress listener with no description. |
Method Summary | |
---|---|
void |
complete()
Notifies this listener that the operation has finished. |
void |
dispose()
Release any resources used by this listener. |
void |
exceptionOccurred(java.lang.Throwable exception)
Reports an exception. |
java.lang.String |
getDescription()
Returns the description for the lengthly operation to be reported, or null if none. |
float |
getProgress()
|
org.opengis.util.InternationalString |
getTask()
|
boolean |
isCanceled()
Is this job canceled? |
void |
progress(float percent)
Notifies this listener of progress in the lengthly operation. |
void |
setCanceled(boolean cancel)
Indicate that progress should is canceled. |
void |
setDescription(java.lang.String description)
Set the description for the lenghtly operation to be reported. |
void |
setTask(org.opengis.util.InternationalString task)
|
void |
started()
Notifies this listener that the operation begins. |
void |
warningOccurred(java.lang.String source,
java.lang.String location,
java.lang.String warning)
Reports a warning. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public NullProgressListener()
Method Detail |
---|
public java.lang.String getDescription()
ProgressListener
null
if none.
getDescription
in interface org.opengis.util.ProgressListener
public void setDescription(java.lang.String description)
ProgressListener
setDescription
in interface org.opengis.util.ProgressListener
description
- The new description, or null
if none.public void started()
ProgressListener
started
in interface org.opengis.util.ProgressListener
public void progress(float percent)
ProgressListener
progress
in interface org.opengis.util.ProgressListener
public float getProgress()
getProgress
in interface org.opengis.util.ProgressListener
public void complete()
ProgressListener
complete
in interface org.opengis.util.ProgressListener
public void dispose()
ProgressListener
dispose
in interface org.opengis.util.ProgressListener
public void setCanceled(boolean cancel)
ProgressListener
setCanceled
in interface org.opengis.util.ProgressListener
public boolean isCanceled()
ProgressListener
isCanceled
in interface org.opengis.util.ProgressListener
public void warningOccurred(java.lang.String source, java.lang.String location, java.lang.String warning)
ProgressListener
warningOccurred
in interface org.opengis.util.ProgressListener
source
- The source of the warning, or null
if none. This is typically the
filename in process of being parsed.location
- 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.warning
- The warning message.public void exceptionOccurred(java.lang.Throwable exception)
ProgressListener
exceptionOccurred
in interface org.opengis.util.ProgressListener
public org.opengis.util.InternationalString getTask()
getTask
in interface org.opengis.util.ProgressListener
public void setTask(org.opengis.util.InternationalString task)
setTask
in interface org.opengis.util.ProgressListener
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |