org.eclipse.ptp.rdt.sync.core.services

Interface ISynchronizeService

All Superinterfaces:

ISynchronizeServiceDescriptor

All Known Implementing Classes:

AbstractSynchronizeService

public interface ISynchronizeService
extends ISynchronizeServiceDescriptor

Provides synchronization services.

Since:

4.0

Method Summary

Methods

Modifier and Type	Method and Description
void	checkout(org.eclipse.core.resources.IProject project, org.eclipse.core.runtime.IPath[] paths) Replace the current contents of the given paths with the previous versions in the repository
void	checkoutRemoteCopy(org.eclipse.core.resources.IProject project, org.eclipse.core.runtime.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(org.eclipse.core.resources.IProject project) Close any resources (files, sockets) that were open by the sync provider for the given project.
java.util.Set<org.eclipse.core.runtime.IPath>	getMergeConflictFiles(org.eclipse.core.resources.IProject project) Get the current list of merge-conflicted files for the passed project and build scenario
java.lang.String[]	getMergeConflictParts(org.eclipse.core.resources.IProject project, org.eclipse.core.resources.IFile file) Get the three parts of the merge-conflicted file (left, right, and ancestor, respectively)
AbstractSyncFileFilter	getSyncFileFilter(org.eclipse.core.resources.IProject project) Get SyncFileFilter for given project
void	setMergeAsResolved(org.eclipse.core.resources.IProject project, org.eclipse.core.runtime.IPath[] paths)
void	setSyncFileFilter(org.eclipse.core.resources.IProject project, AbstractSyncFileFilter filter) Set sync file filter for the given project
void	synchronize(org.eclipse.core.resources.IProject project, RemoteLocation remoteLoc, org.eclipse.core.resources.IResourceDelta delta, org.eclipse.core.runtime.IProgressMonitor monitor, java.util.Set<SyncFlag> syncFlags)

Methods inherited from interface org.eclipse.ptp.rdt.sync.core.services.ISynchronizeServiceDescriptor

getId, getName, getService

Method Detail

checkout

void checkout(org.eclipse.core.resources.IProject project,
            org.eclipse.core.runtime.IPath[] paths)
              throws org.eclipse.core.runtime.CoreException

Replace the current contents of the given paths with the previous versions in the repository

Parameters:

project -

path -

Throws:

org.eclipse.core.runtime.CoreException

Since:

4.0

checkoutRemoteCopy

void checkoutRemoteCopy(org.eclipse.core.resources.IProject project,
                      org.eclipse.core.runtime.IPath[] paths)
                        throws org.eclipse.core.runtime.CoreException

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). This is useful in merge-conflict resolution.

Parameters:

project -

path -

Throws:

org.eclipse.core.runtime.CoreException

Since:

4.0

close

void close(org.eclipse.core.resources.IProject project)
           throws org.eclipse.core.runtime.CoreException

Close any resources (files, sockets) that were open by the sync provider for the given project. Resources not open by the provider should not be touched. This is called, for example, when a project is about to be deleted.

Throws:

org.eclipse.core.runtime.CoreException

getMergeConflictFiles

java.util.Set<org.eclipse.core.runtime.IPath> getMergeConflictFiles(org.eclipse.core.resources.IProject project)
                                                                    throws org.eclipse.core.runtime.CoreException

Get the current list of merge-conflicted files for the passed project and build scenario

Parameters:

project -

Returns:

set of files as project-relative IPaths. This may be an empty set but never null.

Throws:

org.eclipse.core.runtime.CoreException - for system-level problems retrieving merge information

Since:

4.0

getMergeConflictParts

java.lang.String[] getMergeConflictParts(org.eclipse.core.resources.IProject project,
                                       org.eclipse.core.resources.IFile file)
                                         throws org.eclipse.core.runtime.CoreException

Get the three parts of the merge-conflicted file (left, right, and ancestor, respectively)

Parameters:

project -

file -

Returns:

the three parts as strings. Either three strings (some may be empty) or null if file is not merge-conflicted.

Throws:

org.eclipse.core.runtime.CoreException - for system-level problems retrieving merge information

Since:

4.0

setMergeAsResolved

void setMergeAsResolved(org.eclipse.core.resources.IProject project,
                      org.eclipse.core.runtime.IPath[] paths)
                        throws org.eclipse.core.runtime.CoreException

Parameters:

project -

path -

Throws:

org.eclipse.core.runtime.CoreException - for system-level problems setting the state

Since:

4.0 Set the given file paths as resolved (merge conflict does not exist), 4.0

synchronize

void synchronize(org.eclipse.core.resources.IProject project,
               RemoteLocation remoteLoc,
               org.eclipse.core.resources.IResourceDelta delta,
               org.eclipse.core.runtime.IProgressMonitor monitor,
               java.util.Set<SyncFlag> syncFlags)
                 throws org.eclipse.core.runtime.CoreException

Parameters:

project - project to sync - cannot be null

remoteLoc - remote sync target - cannot be null. Warning: Recommended that both clients and implementors make a copy to prevent subtle bugs if object is modified

delta - resources requiring synchronization

monitor - progress monitor for monitoring or canceling sync

syncFlags - 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.

Throws:

org.eclipse.core.runtime.CoreException - if synchronization fails

Since:

4.0 Perform synchronization, 4.0

getSyncFileFilter

AbstractSyncFileFilter getSyncFileFilter(org.eclipse.core.resources.IProject project)
                                         throws org.eclipse.core.runtime.CoreException

Get SyncFileFilter for given project

Parameters:

project -

Returns:

file filter

Throws:

org.eclipse.core.runtime.CoreException

setSyncFileFilter

void setSyncFileFilter(org.eclipse.core.resources.IProject project,
                     AbstractSyncFileFilter filter)
                       throws org.eclipse.core.runtime.CoreException

Set sync file filter for the given project

Parameters:

project - - cannot be null

filter - generic file filter - cannot be null

Throws:

org.eclipse.core.runtime.CoreException