org.geotools.util
Class NullProgressListener

java.lang.Object
  org.geotools.util.NullProgressListener

All Implemented Interfaces:

ProgressListener

public class NullProgressListener

extends java.lang.Object

implements ProgressListener

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.

Since:

2.2

Version:

$Id: NullProgressListener.java 17701 2006-01-23 00:00:51Z desruisseaux $

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 if none.
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	started() Notifies this listener that the operation begins.
void	warningOccurred(java.lang.String source, java.lang.String margin, 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

NullProgressListener

public NullProgressListener()

Creates a null progress listener with no description.

Method Detail

getDescription

public java.lang.String getDescription()

Description copied from interface: ProgressListener

Returns the description for the lengthly operation to be reported, or if none.

Specified by:

getDescription in interface ProgressListener

setDescription

public void setDescription(java.lang.String description)

Description copied from interface: ProgressListener

Set the description for the lenghtly operation to be reported. 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:

setDescription in interface ProgressListener

Parameters:

description - The new description, or if none.

started

public void started()

Description copied from interface: ProgressListener

Notifies this listener that the operation begins.

Specified by:

started in interface ProgressListener

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 interface ProgressListener

complete

public void complete()

Description copied from interface: ProgressListener

Notifies this listener that the operation has finished. The progress indicator will shows 100% or disaspears, at implementor choice. If warning messages were pending, they will be displayed now.

Specified by:

complete in interface ProgressListener

dispose

public void dispose()

Description copied from interface: ProgressListener

Release any resources used by this listener. If the progress were reported in a window, this window may be disposed.

Specified by:

dispose in interface ProgressListener

setCanceled

public void setCanceled(boolean cancel)

Description copied from interface: ProgressListener

Indicate that progress should is canceled.

Specified by:

setCanceled in interface ProgressListener

isCanceled

public boolean isCanceled()

Description copied from interface: ProgressListener

Is this job canceled?

Specified by:

isCanceled in interface ProgressListener

warningOccurred

public void warningOccurred(java.lang.String source,
                            java.lang.String margin,
                            java.lang.String warning)

Description copied from interface: ProgressListener

Reports a warning. This warning may be printed to the standard error stream, appears in a windows or be ignored, at implementor choice.

Specified by:

warningOccurred in interface ProgressListener

Parameters:

source - The source of the warning, or if none. This is typically the filename in process of being parsed.

margin - Text to write on the left side of the warning message, or if none. This is typically the line number where the error occured in the file.

warning - The warning message.

exceptionOccurred

public void exceptionOccurred(java.lang.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 interface ProgressListener