public interface ISynchronizeService extends ISynchronizeServiceDescriptor
Modifier and Type | Method and Description |
---|---|
void |
checkout(IProject project,
SyncConfig syncConfig,
IPath[] paths)
Replace the current contents of the given paths with the previous versions in the repository
|
void |
checkoutRemoteCopy(IProject project,
SyncConfig syncConfig,
IPath[] paths)
Replace the current contents of the given paths with the current local copies of the remote (not necessarily the same as what
is on the remote site).
|
void |
close(IProject project)
Close any resources (files, sockets) that were open by the sync provider for the given project.
|
String |
getLocation()
Get the remote directory that will be used for synchronization
|
Set<IPath> |
getMergeConflictFiles(IProject project,
SyncConfig syncConfig)
Get the current list of merge-conflicted files for the passed project and build scenario
|
String[] |
getMergeConflictParts(IProject project,
SyncConfig syncConfig,
IFile file)
Get the three parts of the merge-conflicted file (left, right, and ancestor, respectively)
|
IRemoteConnection |
getRemoteConnection()
Get the remote connection used by this sync service provider.
|
AbstractSyncFileFilter |
getSyncFileFilter(IProject project)
Get SyncFileFilter.
|
void |
setLocation(String location)
Set the remote directory that will be used for synchronization
|
void |
setMergeAsResolved(IProject project,
SyncConfig syncConfig,
IPath[] paths)
Set the given file paths as resolved (merge conflict does not exist)
|
void |
setRemoteConnection(IRemoteConnection conn)
set the remote connection used for synchronization
|
void |
setSyncFileFilter(IProject project,
AbstractSyncFileFilter filter)
Set sync file filter for the given project
|
void |
synchronize(IProject project,
SyncConfig syncConfig,
IResourceDelta delta,
IProgressMonitor monitor,
EnumSet<SyncFlag> syncFlags)
Perform synchronization
|
getId, getName, getService
void checkout(IProject project, SyncConfig syncConfig, IPath[] paths) throws CoreException
project
- syncConfig
- path
- CoreException
void checkoutRemoteCopy(IProject project, SyncConfig syncConfig, IPath[] paths) throws CoreException
project
- syncConfig
- path
- CoreException
void close(IProject project)
String getLocation()
Set<IPath> getMergeConflictFiles(IProject project, SyncConfig syncConfig) throws CoreException
project
- syncConfig
- CoreException
- for system-level problems retrieving merge informationString[] getMergeConflictParts(IProject project, SyncConfig syncConfig, IFile file) throws CoreException
project
- syncConfig
- file
- CoreException
- for system-level problems retrieving merge informationIRemoteConnection getRemoteConnection()
void setLocation(String location)
location
- directory pathRuntimeException
- if already set. Changing these local parameters is not currently supported but should be possible.void setMergeAsResolved(IProject project, SyncConfig syncConfig, IPath[] paths) throws CoreException
project
- syncConfig
- path
- CoreException
- for system-level problems setting the statevoid setRemoteConnection(IRemoteConnection conn)
conn
- remote connectionRuntimeException
- if already set. Changing these local parameters is not currently supported but should be possible.void synchronize(IProject project, SyncConfig syncConfig, IResourceDelta delta, IProgressMonitor monitor, EnumSet<SyncFlag> syncFlags) throws CoreException
project
- project to syncdelta
- resources requiring synchronizationmonitor
- progress monitor for monitoring or canceling syncsyncFlags
- Various flags for the sync call. For example, the sync can be
forced, either to local (from remote) or to remote (from
local). If forced, it is guaranteed to happen before
returning. Otherwise, it may happen at any time.CoreException
- if synchronization failsAbstractSyncFileFilter getSyncFileFilter(IProject project)
project
- RemoteSyncException
void setSyncFileFilter(IProject project, AbstractSyncFileFilter filter)
project
- - cannot be nullfilter
- generic file filter - cannot be nullCopyright (c) 2011 IBM Corporation and others. All Rights Reserved.