Class Index | File Index

Classes


Class orion.ServiceTracker

Simplifies the use of services within a service registry.
Defined in: </shared/eclipse/e4/orion/I201206221139/plugins/org.eclipse.orion.client.core/web/orion/serviceTracker.js>.

Class Summary
Constructor Attributes Constructor Name and Description
 
orion.ServiceTracker(serviceRegistry, serviceName)
A ServiceTracker tracks matching services in the given service registry.
Method Summary
Method Attributes Method Name and Description
 
addingService(serviceRef)
Called when a service is being added to this ServiceTracker.
 
Stops tracking services.
 
Returns service references to the services that are being tracked.
 
open()
Begins tracking services.
 
removedService(serviceRef, service)
Called when a service has been removed from this ServiceTracker.
Class Detail
orion.ServiceTracker(serviceRegistry, serviceName)
A ServiceTracker tracks matching services in the given service registry. Matching services are those whose service name matches the given serviceName. The #addingService and #removedService methods can be overridden to customize the service objects being tracked.
Parameters:
{orion.serviceregistry.ServiceRegistry} serviceRegistry
The service registry to track services of.
{String} serviceName
The service name of services to be tracked.
Method Detail
{Object} addingService(serviceRef)
Called when a service is being added to this ServiceTracker. Subclasses may override this method. The default implementation returns the result of calling orion.serviceregistry.ServiceRegistry#getService passing the service reference.
Parameters:
{orion.serviceregistry.ServiceReference} serviceRef
The reference to the service being added.
Returns:
{Object} The service object to be tracked for the given service reference. If null is returned, the service reference will not be tracked.

close()
Stops tracking services.

{orion.serviceregistry.ServiceReference[]} getServiceReferences()
Returns service references to the services that are being tracked.
Returns:
{orion.serviceregistry.ServiceReference[]} References to all services that are being tracked by this ServiceTracker.

open()
Begins tracking services.

removedService(serviceRef, service)
Called when a service has been removed from this ServiceTracker. Subclasses may override this method. The default implementation does nothing.
Parameters:
{orion.serviceregistry.ServiceReference} serviceRef
The reference to the removed service.
{orion.serviceregistry.Service} service
The service object for the removed service.

Documentation generated by JsDoc Toolkit 2.4.0 on Fri Jun 22 2012 11:43:40 GMT-0400 (EDT)