Eclipse Platform
Release 3.1

org.eclipse.ui
Class AbstractSourceProvider

java.lang.Object
  extended byorg.eclipse.ui.AbstractSourceProvider
All Implemented Interfaces:
ISourceProvider

public abstract class AbstractSourceProvider
extends Object
implements ISourceProvider

An implementation of ISourceProvider that provides listener support. Subclasses need only call fireSourceChanged whenever appropriate.

Since:
3.1

Constructor Summary
AbstractSourceProvider()
           
 
Method Summary
 void addSourceProviderListener(ISourceProviderListener listener)
          Adds a listener to this source provider.
protected  void fireSourceChanged(int sourcePriority, Map sourceValuesByName)
          Notifies all listeners that multiple sources have changed.
protected  void fireSourceChanged(int sourcePriority, String sourceName, Object sourceValue)
          Notifies all listeners that a single source has changed.
 void removeSourceProviderListener(ISourceProviderListener listener)
          Removes a listener from this source provider.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 
Methods inherited from interface org.eclipse.ui.ISourceProvider
dispose, getCurrentState
 

Constructor Detail

AbstractSourceProvider

public AbstractSourceProvider()
Method Detail

addSourceProviderListener

public final void addSourceProviderListener(ISourceProviderListener listener)
Description copied from interface: ISourceProvider
Adds a listener to this source provider. This listener will be notified whenever the corresponding source changes.

Specified by:
addSourceProviderListener in interface ISourceProvider
Parameters:
listener - The listener to add; must not be null.

fireSourceChanged

protected final void fireSourceChanged(int sourcePriority,
                                       String sourceName,
                                       Object sourceValue)
Notifies all listeners that a single source has changed.

Parameters:
sourcePriority - The source priority that has changed.
sourceName - The name of the source that has changed; must not be null.
sourceValue - The new value for the source; may be null.

fireSourceChanged

protected final void fireSourceChanged(int sourcePriority,
                                       Map sourceValuesByName)
Notifies all listeners that multiple sources have changed.

Parameters:
sourcePriority - The source priority that has changed.
sourceValuesByName - The map of source names (String) to source values (Object) that have changed; must not be null. The names must not be null, but the values may be null.

removeSourceProviderListener

public final void removeSourceProviderListener(ISourceProviderListener listener)
Description copied from interface: ISourceProvider
Removes a listener from this source provider. This listener will be notified whenever the corresponding source changes.

Specified by:
removeSourceProviderListener in interface ISourceProvider
Parameters:
listener - The listener to remove; must not be null.

Eclipse Platform
Release 3.1

Guidelines for using Eclipse APIs.

Copyright (c) IBM Corp. and others 2000, 2005. All rights reserved.