public interface ISynchronizeManager
Participants added to the manager will benefit from the manager's lifecycle
support. The participants will automatically have their init
method and dispose
called when the manager starts and is shutdown and if persistable will
be allowed to save their state on shutdown.
Clients are not intended to implement this interface.
ISynchronizeParticipant
,
TeamUI.getSynchronizeManager()
Modifier and Type | Field and Description |
---|---|
static Object |
FAMILY_SYNCHRONIZE_OPERATION
Constant identifying the job family identifier for a background job that affects the
synchronization state of resources.
|
Modifier and Type | Method and Description |
---|---|
void |
addSynchronizeParticipantListener(ISynchronizeParticipantListener listener)
Registers the given listener for participant notifications.
|
void |
addSynchronizeParticipants(ISynchronizeParticipant[] participants)
Adds the given participants to the synchronize manager.
|
ISynchronizeParticipantReference[] |
get(String id)
Returns the registered synchronize participants with the given type id.
|
ISynchronizeParticipantReference |
get(String id,
String secondaryId)
Returns the registered synchronize participants with the given type id and instance id.
|
ISynchronizeParticipantDescriptor |
getParticipantDescriptor(String id)
Returns the participant descriptor for the given participant type id or
null if a descriptor is not found for that id. |
ISynchronizeParticipantReference[] |
getSynchronizeParticipants()
Returns a collection of synchronize participant references registered with the synchronize manager.
|
void |
removeSynchronizeParticipantListener(ISynchronizeParticipantListener listener)
Removes the given listener for participant notifications.
|
void |
removeSynchronizeParticipants(ISynchronizeParticipant[] participants)
Removes the given participants from the synchronize manager.
|
ISynchronizeView |
showSynchronizeViewInActivePage()
Opens the synchronize view in the perspective defined by the user in the team synchronize
preferences.
|
static final Object FAMILY_SYNCHRONIZE_OPERATION
belongsTo
.Job.belongsTo(java.lang.Object)
void addSynchronizeParticipantListener(ISynchronizeParticipantListener listener)
listener
- listener to registervoid removeSynchronizeParticipantListener(ISynchronizeParticipantListener listener)
listener
- listener to removevoid addSynchronizeParticipants(ISynchronizeParticipant[] participants)
participants
- participants to addvoid removeSynchronizeParticipants(ISynchronizeParticipant[] participants)
participants
- participants to removeISynchronizeParticipantReference[] getSynchronizeParticipants()
ISynchronizeParticipantReference[] get(String id)
id
- the type identifier for the participantISynchronizeParticipantReference get(String id, String secondaryId)
id
- the type identifier for the participantsecondaryId
- the instance identifier for this participant type or null
if this participant doesn't support multiple instances.null
if none with that id is not registered.ISynchronizeView showSynchronizeViewInActivePage()
null
if it can't be opened.ISynchronizeParticipantDescriptor getParticipantDescriptor(String id)
null
if a descriptor is not found for that id.id
- the participant idnull
if a descriptor is not found for that id.
Copyright (c) 2000, 2014 Eclipse Contributors and others. All rights reserved.Guidelines for using Eclipse APIs.