org.geotoolkit.image.io
Class IIOListeners

Object
  extended by IIOListeners
All Implemented Interfaces:
Serializable

@ThreadSafe
public class IIOListeners
extends Object
implements Serializable

A container of image I/O listeners. This class provides a set of addFooListener(...) and removeFooListener(...) methods for adding and removing various listeners, and a addListenersTo(...) method for copying listeners to the an image reader. This class is convenient when ImageReader.addFooListener(...) can't be invoked directly because the ImageReader instance is not yet know or available.

Since:
2.1
Version:
3.10
Author:
Martin Desruisseaux (IRD, Geomatys)
See Also:
Serialized Form
Module:
coverage/geotk-coverage (download)    View source code for this class

Constructor Summary
IIOListeners()
          Creates a new instance of IIOListeners.
 
Method Summary
 void addIIOReadProgressListener(IIOReadProgressListener listener)
          Adds an IIOReadProgressListener to the list of registered progress listeners.
 void addIIOReadUpdateListener(IIOReadUpdateListener listener)
          Adds an IIOReadUpdateListener to the list of registered update listeners.
 void addIIOReadWarningListener(IIOReadWarningListener listener)
          Adds an IIOReadWarningListener to the list of registered warning listeners.
 void addIIOWriteProgressListener(IIOWriteProgressListener listener)
          Adds an IIOWriteProgressListener to the list of registered progress listeners.
 void addIIOWriteWarningListener(IIOWriteWarningListener listener)
          Adds an IIOWriteWarningListener to the list of registered warning listeners.
 void addListenersTo(ImageReader reader)
          Adds all listeners registered in this object to the specified image reader.
 void addListenersTo(ImageWriter writer)
          Adds all listeners registered in this object to the specified image writer.
 EventListener[] getReadListeners()
          Returns all read progress, read update and read warning listeners.
 EventListener[] getWriteListeners()
          Returns all write progress and write warning listeners.
 void removeIIOReadProgressListener(IIOReadProgressListener listener)
          Removes an IIOReadProgressListener from the list of registered progress listeners.
 void removeIIOReadUpdateListener(IIOReadUpdateListener listener)
          Removes an IIOReadUpdateListener from the list of registered update listeners.
 void removeIIOReadWarningListener(IIOReadWarningListener listener)
          Removes an IIOReadWarningListener from the list of registered warning listeners.
 void removeIIOWriteProgressListener(IIOWriteProgressListener listener)
          Removes an IIOWriteProgressListener from the list of registered progress listeners.
 void removeIIOWriteWarningListener(IIOWriteWarningListener listener)
          Removes an IIOWriteWarningListener from the list of registered warning listeners.
 void removeListenersFrom(ImageReader reader)
          Removes all listeners registered in this object from the specified image reader.
 void removeListenersFrom(ImageWriter writer)
          Removes all listeners registered in this object from the specified image writer.
 void setListeners(IIOListeners other)
          Sets the list of listeners in this object to the same listeners than the given object.
 
Methods inherited from class Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

IIOListeners

public IIOListeners()
Creates a new instance of IIOListeners.

Method Detail

setListeners

public void setListeners(IIOListeners other)
Sets the list of listeners in this object to the same listeners than the given object. Any listeners previously hold by this IIOListeners are discarded.

Parameters:
other - The other object from which to copy the list of listeners.
Since:
3.10

addIIOReadProgressListener

public void addIIOReadProgressListener(IIOReadProgressListener listener)
Adds an IIOReadProgressListener to the list of registered progress listeners.

Parameters:
listener - The listener to add.

removeIIOReadProgressListener

public void removeIIOReadProgressListener(IIOReadProgressListener listener)
Removes an IIOReadProgressListener from the list of registered progress listeners.

Parameters:
listener - The listener to remove.

addIIOReadUpdateListener

public void addIIOReadUpdateListener(IIOReadUpdateListener listener)
Adds an IIOReadUpdateListener to the list of registered update listeners.

Parameters:
listener - The listener to add.
Since:
3.02

removeIIOReadUpdateListener

public void removeIIOReadUpdateListener(IIOReadUpdateListener listener)
Removes an IIOReadUpdateListener from the list of registered update listeners.

Parameters:
listener - The listener to remove.
Since:
3.02

addIIOReadWarningListener

public void addIIOReadWarningListener(IIOReadWarningListener listener)
Adds an IIOReadWarningListener to the list of registered warning listeners.

Parameters:
listener - The listener to add.

removeIIOReadWarningListener

public void removeIIOReadWarningListener(IIOReadWarningListener listener)
Removes an IIOReadWarningListener from the list of registered warning listeners.

Parameters:
listener - The listener to remove.

addIIOWriteProgressListener

public void addIIOWriteProgressListener(IIOWriteProgressListener listener)
Adds an IIOWriteProgressListener to the list of registered progress listeners.

Parameters:
listener - The listener to add.
Since:
3.02

removeIIOWriteProgressListener

public void removeIIOWriteProgressListener(IIOWriteProgressListener listener)
Removes an IIOWriteProgressListener from the list of registered progress listeners.

Parameters:
listener - The listener to remove.
Since:
3.02

addIIOWriteWarningListener

public void addIIOWriteWarningListener(IIOWriteWarningListener listener)
Adds an IIOWriteWarningListener to the list of registered warning listeners.

Parameters:
listener - The listener to add.
Since:
3.02

removeIIOWriteWarningListener

public void removeIIOWriteWarningListener(IIOWriteWarningListener listener)
Removes an IIOWriteWarningListener from the list of registered warning listeners.

Parameters:
listener - The listener to remove.
Since:
3.02

getReadListeners

public EventListener[] getReadListeners()
Returns all read progress, read update and read warning listeners.

Returns:
All read listeners.

getWriteListeners

public EventListener[] getWriteListeners()
Returns all write progress and write warning listeners.

Returns:
All read listeners.
Since:
3.02

addListenersTo

public void addListenersTo(ImageReader reader)
Adds all listeners registered in this object to the specified image reader.

Parameters:
reader - The reader on which to register the listeners.

addListenersTo

public void addListenersTo(ImageWriter writer)
Adds all listeners registered in this object to the specified image writer.

Parameters:
writer - The writer on which to register the listeners.
Since:
3.02

removeListenersFrom

public void removeListenersFrom(ImageReader reader)
Removes all listeners registered in this object from the specified image reader.

Parameters:
reader - The reader from which to unregister the listeners.
Since:
3.07

removeListenersFrom

public void removeListenersFrom(ImageWriter writer)
Removes all listeners registered in this object from the specified image writer.

Parameters:
writer - The writer from which to unregister the listeners.
Since:
3.07


Copyright © 2009-2012 Geotoolkit.org. All Rights Reserved.