public interface ISourceProvider
A provider of notifications for when a change has occurred to a particular type of source. These providers can be given to the appropriate service, and this service will then re-evaluate the appropriate pieces of its internal state in response to these changes.
It is recommended that clients subclass AbstractSourceProvider
instead, as this provides some common support for listeners.
IHandlerService
,
ISources
Modifier and Type | Method and Description |
---|---|
void |
addSourceProviderListener(ISourceProviderListener listener)
Adds a listener to this source provider.
|
void |
dispose()
Allows the source provider an opportunity to clean up resources (e.g.,
listeners) before being released.
|
Map |
getCurrentState()
Returns the current state of the sources tracked by this provider.
|
String[] |
getProvidedSourceNames()
Returns the names of those sources provided by this class.
|
void |
removeSourceProviderListener(ISourceProviderListener listener)
Removes a listener from this source provider.
|
void addSourceProviderListener(ISourceProviderListener listener)
listener
- The listener to add; must not be null
.void dispose()
Map getCurrentState()
For use with core expressions, this map should contain IEvaluationContext#UNDEFINED_VARIABLE for properties which are only sometimes available.
String
) to variable
values (Object
). This may be empty, and may be
null
.String[] getProvidedSourceNames()
null
or empty.void removeSourceProviderListener(ISourceProviderListener listener)
listener
- The listener to remove; must not be null
.
Copyright (c) 2000, 2015 Eclipse Contributors and others. All rights reserved.Guidelines for using Eclipse APIs.