Skip to main content
aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
Diffstat (limited to 'bundles/org.eclipse.team.core/src/org/eclipse')
-rw-r--r--bundles/org.eclipse.team.core/src/org/eclipse/team/core/IProjectSetSerializer.java4
-rw-r--r--bundles/org.eclipse.team.core/src/org/eclipse/team/core/ProjectSetCapability.java2
-rw-r--r--bundles/org.eclipse.team.core/src/org/eclipse/team/core/ProjectSetSerializationContext.java2
-rw-r--r--bundles/org.eclipse.team.core/src/org/eclipse/team/core/RepositoryProvider.java2
-rw-r--r--bundles/org.eclipse.team.core/src/org/eclipse/team/core/mapping/ChangeTracker.java5
-rw-r--r--bundles/org.eclipse.team.core/src/org/eclipse/team/core/mapping/DelegatingStorageMerger.java2
-rw-r--r--bundles/org.eclipse.team.core/src/org/eclipse/team/core/mapping/IMergeContext.java4
-rw-r--r--bundles/org.eclipse.team.core/src/org/eclipse/team/core/mapping/ISynchronizationScopeManager.java4
-rw-r--r--bundles/org.eclipse.team.core/src/org/eclipse/team/core/mapping/provider/MergeContext.java4
-rw-r--r--bundles/org.eclipse.team.core/src/org/eclipse/team/core/mapping/provider/SynchronizationScopeManager.java2
-rw-r--r--bundles/org.eclipse.team.core/src/org/eclipse/team/core/subscribers/Subscriber.java12
-rw-r--r--bundles/org.eclipse.team.core/src/org/eclipse/team/core/subscribers/SubscriberMergeContext.java2
-rw-r--r--bundles/org.eclipse.team.core/src/org/eclipse/team/core/subscribers/SubscriberResourceMappingContext.java5
-rw-r--r--bundles/org.eclipse.team.core/src/org/eclipse/team/core/variants/AbstractResourceVariantTree.java8
-rw-r--r--bundles/org.eclipse.team.core/src/org/eclipse/team/core/variants/CachedResourceVariant.java4
-rw-r--r--bundles/org.eclipse.team.core/src/org/eclipse/team/core/variants/IResourceVariant.java2
-rw-r--r--bundles/org.eclipse.team.core/src/org/eclipse/team/core/variants/IResourceVariantTree.java10
-rw-r--r--bundles/org.eclipse.team.core/src/org/eclipse/team/core/variants/PersistantResourceVariantByteStore.java16
-rw-r--r--bundles/org.eclipse.team.core/src/org/eclipse/team/core/variants/ResourceVariantByteStore.java6
-rw-r--r--bundles/org.eclipse.team.core/src/org/eclipse/team/core/variants/ThreeWaySubscriber.java2
-rw-r--r--bundles/org.eclipse.team.core/src/org/eclipse/team/core/variants/ThreeWaySynchronizer.java24
21 files changed, 66 insertions, 56 deletions
diff --git a/bundles/org.eclipse.team.core/src/org/eclipse/team/core/IProjectSetSerializer.java b/bundles/org.eclipse.team.core/src/org/eclipse/team/core/IProjectSetSerializer.java
index e9f1f0a3f..f1c3aeb84 100644
--- a/bundles/org.eclipse.team.core/src/org/eclipse/team/core/IProjectSetSerializer.java
+++ b/bundles/org.eclipse.team.core/src/org/eclipse/team/core/IProjectSetSerializer.java
@@ -47,7 +47,7 @@ public interface IProjectSetSerializer {
* com.ibm.swt.widgets.Shell or it will be null.
* @param monitor a progress monitor
* @return String[] an array of serialized reference strings uniquely identifying the projects
- * @throws TeamException
+ * @throws TeamException on failures; depends on concrete implementation
*/
public String[] asReference(IProject[] providerProjects, Object context, IProgressMonitor monitor) throws TeamException;
@@ -67,7 +67,7 @@ public interface IProjectSetSerializer {
* com.ibm.swt.widgets.Shell or it will be null.
* @param monitor a progress monitor
* @return IProject[] an array of projects that were created
- * @throws TeamException
+ * @throws TeamException on failures; depends on concrete implementation
*/
public IProject[] addToWorkspace(String[] referenceStrings, String filename, Object context, IProgressMonitor monitor) throws TeamException;
}
diff --git a/bundles/org.eclipse.team.core/src/org/eclipse/team/core/ProjectSetCapability.java b/bundles/org.eclipse.team.core/src/org/eclipse/team/core/ProjectSetCapability.java
index 1c3bbcc46..011c4199c 100644
--- a/bundles/org.eclipse.team.core/src/org/eclipse/team/core/ProjectSetCapability.java
+++ b/bundles/org.eclipse.team.core/src/org/eclipse/team/core/ProjectSetCapability.java
@@ -230,7 +230,7 @@ public abstract class ProjectSetCapability {
* @return
* an array of confirmed projects to be loaded
* or <code>null</code> if the operation is to be canceled.
- * @throws TeamException
+ * @throws TeamException on failure
*/
protected IProject[] confirmOverwrite(
ProjectSetSerializationContext context,
diff --git a/bundles/org.eclipse.team.core/src/org/eclipse/team/core/ProjectSetSerializationContext.java b/bundles/org.eclipse.team.core/src/org/eclipse/team/core/ProjectSetSerializationContext.java
index 752f54368..a4e19a392 100644
--- a/bundles/org.eclipse.team.core/src/org/eclipse/team/core/ProjectSetSerializationContext.java
+++ b/bundles/org.eclipse.team.core/src/org/eclipse/team/core/ProjectSetSerializationContext.java
@@ -62,7 +62,7 @@ public class ProjectSetSerializationContext {
* @return
* an array of zero or more projects that should be overwritten
* or <code>null</code> if the operation is to be canceled
- * @throws TeamException
+ * @throws TeamException on failure
*/
public IProject[] confirmOverwrite(IProject[] projects) throws TeamException {
return new IProject[0];
diff --git a/bundles/org.eclipse.team.core/src/org/eclipse/team/core/RepositoryProvider.java b/bundles/org.eclipse.team.core/src/org/eclipse/team/core/RepositoryProvider.java
index 9ce34692a..de380d54f 100644
--- a/bundles/org.eclipse.team.core/src/org/eclipse/team/core/RepositoryProvider.java
+++ b/bundles/org.eclipse.team.core/src/org/eclipse/team/core/RepositoryProvider.java
@@ -271,7 +271,7 @@ public abstract class RepositoryProvider implements IProjectNature, IAdaptable {
}
/**
* Disassociates project with the repository provider its currently mapped to.
- * @param project
+ * @param project project to unmap
* @throws TeamException The project isn't associated with any repository provider.
*/
public static void unmap(IProject project) throws TeamException {
diff --git a/bundles/org.eclipse.team.core/src/org/eclipse/team/core/mapping/ChangeTracker.java b/bundles/org.eclipse.team.core/src/org/eclipse/team/core/mapping/ChangeTracker.java
index dbf9c7b75..d5df9451e 100644
--- a/bundles/org.eclipse.team.core/src/org/eclipse/team/core/mapping/ChangeTracker.java
+++ b/bundles/org.eclipse.team.core/src/org/eclipse/team/core/mapping/ChangeTracker.java
@@ -269,7 +269,7 @@ public abstract class ChangeTracker {
* @param project the project
* @param name the unique name used to identify the change set
* @param files the change files to be grouped
- * @throws CoreException
+ * @throws CoreException if an error occurs
*/
protected void ensureGrouped(IProject project, String name, IFile[] files) throws CoreException {
IChangeGroupingRequestor collector = getCollector(project);
@@ -287,7 +287,8 @@ public abstract class ChangeTracker {
* repository provider associated with the file's project.
* @param file the file
* @return whether the given file is modified
- * @throws CoreException
+ * @throws CoreException if an error occurs while trying to determine the modification state
+ * of the file
*/
protected boolean isModified(IFile file) throws CoreException {
IChangeGroupingRequestor collector = getCollector(file.getProject());
diff --git a/bundles/org.eclipse.team.core/src/org/eclipse/team/core/mapping/DelegatingStorageMerger.java b/bundles/org.eclipse.team.core/src/org/eclipse/team/core/mapping/DelegatingStorageMerger.java
index 6256fecd3..d42d8f331 100644
--- a/bundles/org.eclipse.team.core/src/org/eclipse/team/core/mapping/DelegatingStorageMerger.java
+++ b/bundles/org.eclipse.team.core/src/org/eclipse/team/core/mapping/DelegatingStorageMerger.java
@@ -104,7 +104,7 @@ public class DelegatingStorageMerger implements IStorageMerger {
* to create the merger to which the merge should be delegated.
* @param target the storage that contains the target contents of the merge.
* @return a merger for the given storage or <code>null</code>
- * @throws CoreException
+ * @throws CoreException no merger found
*/
protected IStorageMerger createDelegateMerger(IStorage target) throws CoreException {
IStorageMerger merger = null;
diff --git a/bundles/org.eclipse.team.core/src/org/eclipse/team/core/mapping/IMergeContext.java b/bundles/org.eclipse.team.core/src/org/eclipse/team/core/mapping/IMergeContext.java
index f3040790b..20df86e70 100644
--- a/bundles/org.eclipse.team.core/src/org/eclipse/team/core/mapping/IMergeContext.java
+++ b/bundles/org.eclipse.team.core/src/org/eclipse/team/core/mapping/IMergeContext.java
@@ -306,7 +306,7 @@ public interface IMergeContext extends ISynchronizationContext {
* match the local state.
* @param diff the diff
* @param monitor a progress monitor
- * @throws CoreException
+ * @throws CoreException if an error occurs
*/
public void reject(IDiff diff, IProgressMonitor monitor) throws CoreException;
@@ -316,7 +316,7 @@ public interface IMergeContext extends ISynchronizationContext {
* each diff.
* @param diffs the diffs
* @param monitor a progress monitor
- * @throws CoreException
+ * @throws CoreException if an error occurs
*/
public void reject(IDiff[] diffs, IProgressMonitor monitor) throws CoreException;
diff --git a/bundles/org.eclipse.team.core/src/org/eclipse/team/core/mapping/ISynchronizationScopeManager.java b/bundles/org.eclipse.team.core/src/org/eclipse/team/core/mapping/ISynchronizationScopeManager.java
index b345b5091..ee91d50ae 100644
--- a/bundles/org.eclipse.team.core/src/org/eclipse/team/core/mapping/ISynchronizationScopeManager.java
+++ b/bundles/org.eclipse.team.core/src/org/eclipse/team/core/mapping/ISynchronizationScopeManager.java
@@ -58,7 +58,7 @@ public interface ISynchronizationScopeManager {
* @param monitor a progress monitor
* when building the scope
*
- * @throws CoreException
+ * @throws CoreException if an error occurs
*/
void initialize(IProgressMonitor monitor) throws CoreException;
@@ -72,7 +72,7 @@ public interface ISynchronizationScopeManager {
* @param mappings the mappings to be refreshed
* @param monitor a progress monitor
* @return a set of traversals that cover the given mappings
- * @throws CoreException
+ * @throws CoreException if an error occurs
*/
ResourceTraversal[] refresh(ResourceMapping[] mappings, IProgressMonitor monitor) throws CoreException;
diff --git a/bundles/org.eclipse.team.core/src/org/eclipse/team/core/mapping/provider/MergeContext.java b/bundles/org.eclipse.team.core/src/org/eclipse/team/core/mapping/provider/MergeContext.java
index 41ff492e5..37e15e353 100644
--- a/bundles/org.eclipse.team.core/src/org/eclipse/team/core/mapping/provider/MergeContext.java
+++ b/bundles/org.eclipse.team.core/src/org/eclipse/team/core/mapping/provider/MergeContext.java
@@ -316,7 +316,7 @@ public abstract class MergeContext extends SynchronizationContext implements IMe
* the diff whose local is to be replaced
* @param monitor
* a progress monitor
- * @throws CoreException
+ * @throws CoreException if an error occurs
*/
protected void performReplace(final IDiff diff, IProgressMonitor monitor) throws CoreException {
IResourceDiff d;
@@ -356,7 +356,7 @@ public abstract class MergeContext extends SynchronizationContext implements IMe
* the diff whose local is now in-sync
* @param monitor
* a progress monitor
- * @throws CoreException
+ * @throws CoreException if an error occurs
*/
protected abstract void makeInSync(IDiff diff, IProgressMonitor monitor) throws CoreException;
diff --git a/bundles/org.eclipse.team.core/src/org/eclipse/team/core/mapping/provider/SynchronizationScopeManager.java b/bundles/org.eclipse.team.core/src/org/eclipse/team/core/mapping/provider/SynchronizationScopeManager.java
index 74773943a..9228d7da0 100644
--- a/bundles/org.eclipse.team.core/src/org/eclipse/team/core/mapping/provider/SynchronizationScopeManager.java
+++ b/bundles/org.eclipse.team.core/src/org/eclipse/team/core/mapping/provider/SynchronizationScopeManager.java
@@ -92,7 +92,7 @@ public class SynchronizationScopeManager extends PlatformObject implements ISync
* @param context the resource mapping context
* @param monitor a progress monitor
* @return the resource mappings
- * @throws CoreException
+ * @throws CoreException if an error occurs
*/
public static ResourceMapping[] getMappingsFromProviders(ResourceTraversal[] traversals,
ResourceMappingContext context,
diff --git a/bundles/org.eclipse.team.core/src/org/eclipse/team/core/subscribers/Subscriber.java b/bundles/org.eclipse.team.core/src/org/eclipse/team/core/subscribers/Subscriber.java
index 3a3271f22..fa888f14e 100644
--- a/bundles/org.eclipse.team.core/src/org/eclipse/team/core/subscribers/Subscriber.java
+++ b/bundles/org.eclipse.team.core/src/org/eclipse/team/core/subscribers/Subscriber.java
@@ -99,7 +99,7 @@ abstract public class Subscriber {
* @param resource the resource being tested
* @return <code>true</code> if this resource is supervised, and <code>false</code>
* otherwise
- * @throws TeamException
+ * @throws TeamException if an error occurs
*/
abstract public boolean isSupervised(IResource resource) throws TeamException;
@@ -114,7 +114,7 @@ abstract public class Subscriber {
* </p>
* @param resource the resource
* @return a list of member resources
- * @throws TeamException
+ * @throws TeamException if an error occurs
*/
abstract public IResource[] members(IResource resource) throws TeamException;
@@ -150,7 +150,7 @@ abstract public class Subscriber {
*
* @param resource the resource of interest
* @return sync info
- * @throws TeamException
+ * @throws TeamException if an error occurs
* @see #getDiff(IResource)
*/
abstract public SyncInfo getSyncInfo(IResource resource) throws TeamException;
@@ -372,7 +372,7 @@ abstract public class Subscriber {
*
* @param resource the resource of interest
* @return the diff for the resource or <code>null</code>
- * @throws CoreException
+ * @throws CoreException if an error occurs
* @throws TeamException if errors occur
* @since 3.2
*/
@@ -395,7 +395,7 @@ abstract public class Subscriber {
* </ul>
* @param traversals the traversals to be visited
* @param visitor the visitor
- * @throws CoreException
+ * @throws CoreException if an error occurs
* @throws TeamException if errors occur
* @since 3.2
*/
@@ -495,7 +495,7 @@ abstract public class Subscriber {
* @param stateMask the mask that identifies the state flags of interested
* @param monitor a progress monitor
* @return the synchronization state of the given resource mapping
- * @throws CoreException
+ * @throws CoreException if an error occurs
* @since 3.2
* @see IDiff
* @see IThreeWayDiff
diff --git a/bundles/org.eclipse.team.core/src/org/eclipse/team/core/subscribers/SubscriberMergeContext.java b/bundles/org.eclipse.team.core/src/org/eclipse/team/core/subscribers/SubscriberMergeContext.java
index 6f1399709..e133455e1 100644
--- a/bundles/org.eclipse.team.core/src/org/eclipse/team/core/subscribers/SubscriberMergeContext.java
+++ b/bundles/org.eclipse.team.core/src/org/eclipse/team/core/subscribers/SubscriberMergeContext.java
@@ -109,7 +109,7 @@ public abstract class SubscriberMergeContext extends MergeContext {
* Return the sync info for the given resource.
* @param resource the resource
* @return the sync info for the resource obtained from the subscriber
- * @throws CoreException
+ * @throws CoreException if an error occurs
*/
protected SyncInfo getSyncInfo(IResource resource) throws CoreException {
return handler.getSubscriber().getSyncInfo(resource);
diff --git a/bundles/org.eclipse.team.core/src/org/eclipse/team/core/subscribers/SubscriberResourceMappingContext.java b/bundles/org.eclipse.team.core/src/org/eclipse/team/core/subscribers/SubscriberResourceMappingContext.java
index 695368f5a..baf7b5f0c 100644
--- a/bundles/org.eclipse.team.core/src/org/eclipse/team/core/subscribers/SubscriberResourceMappingContext.java
+++ b/bundles/org.eclipse.team.core/src/org/eclipse/team/core/subscribers/SubscriberResourceMappingContext.java
@@ -162,7 +162,10 @@ public class SubscriberResourceMappingContext extends RemoteResourceMappingConte
* @param depth the depth of the refresh
* @param flags the flags that indicate extra state that should be fetched
* @param monitor a progress monitor
- * @throws TeamException
+ * @throws TeamException if this method fails. Reasons include:
+ * <ul>
+ * <li>The server could not be contacted.</li>
+ * </ul>
*/
protected void refresh(IResource[] resources, int depth, int flags, IProgressMonitor monitor) throws TeamException {
subscriber.refresh(resources, depth, monitor);
diff --git a/bundles/org.eclipse.team.core/src/org/eclipse/team/core/variants/AbstractResourceVariantTree.java b/bundles/org.eclipse.team.core/src/org/eclipse/team/core/variants/AbstractResourceVariantTree.java
index 396edd27f..8bfdabf26 100644
--- a/bundles/org.eclipse.team.core/src/org/eclipse/team/core/variants/AbstractResourceVariantTree.java
+++ b/bundles/org.eclipse.team.core/src/org/eclipse/team/core/variants/AbstractResourceVariantTree.java
@@ -59,7 +59,7 @@ public abstract class AbstractResourceVariantTree implements IResourceVariantTre
* <code>IResource.DEPTH_ONE</code>, or <code>IResource.DEPTH_INFINITE</code>)
* @param monitor a progress monitor
* @return the array of resources whose corresponding variants have changed
- * @throws TeamException
+ * @throws TeamException if an error occurs
*/
@Override
public IResource[] refresh(IResource[] resources, int depth, IProgressMonitor monitor) throws TeamException {
@@ -87,7 +87,7 @@ public abstract class AbstractResourceVariantTree implements IResourceVariantTre
* <code>IResource.DEPTH_ONE</code>, or <code>IResource.DEPTH_INFINITE</code>)
* @param monitor a progress monitor
* @return the resource's whose variants have changed
- * @throws TeamException
+ * @throws TeamException if an error occurs
*/
protected IResource[] refresh(IResource resource, int depth, IProgressMonitor monitor) throws TeamException {
IResource[] changedResources = null;
@@ -121,7 +121,7 @@ public abstract class AbstractResourceVariantTree implements IResourceVariantTre
* <code>IResource.DEPTH_ONE</code>, or <code>IResource.DEPTH_INFINITE</code>)
* @param monitor a progress monitor
* @return the resource's whose variants have changed
- * @throws TeamException
+ * @throws TeamException if an error occurs
*/
protected IResource[] collectChanges(IResource local, IResourceVariant remote, int depth, IProgressMonitor monitor) throws TeamException {
List<IResource> changedResources = new ArrayList<>();
@@ -175,7 +175,7 @@ public abstract class AbstractResourceVariantTree implements IResourceVariantTre
* @param local the local resource
* @param remote the newly fetched resource variant
* @return <code>true</code> if the resource variant changed
- * @throws TeamException
+ * @throws TeamException if an error occurs
*/
protected abstract boolean setVariant(IResource local, IResourceVariant remote) throws TeamException;
diff --git a/bundles/org.eclipse.team.core/src/org/eclipse/team/core/variants/CachedResourceVariant.java b/bundles/org.eclipse.team.core/src/org/eclipse/team/core/variants/CachedResourceVariant.java
index fb17d43e3..b270711ac 100644
--- a/bundles/org.eclipse.team.core/src/org/eclipse/team/core/variants/CachedResourceVariant.java
+++ b/bundles/org.eclipse.team.core/src/org/eclipse/team/core/variants/CachedResourceVariant.java
@@ -148,7 +148,7 @@ public abstract class CachedResourceVariant extends PlatformObject implements IR
* This method is not intended to be overridden by clients.
* @param stream the stream containing the contents of the resource variant
* @param monitor a progress monitor
- * @throws TeamException
+ * @throws TeamException if an error occurs
*/
protected void setContents(InputStream stream, IProgressMonitor monitor) throws TeamException {
// Ensure that there is a cache entry to receive the contents
@@ -186,7 +186,7 @@ public abstract class CachedResourceVariant extends PlatformObject implements IR
* <p>
* This method is not intended to be overridden by clients.
* @return the cached contents or <code>null</code>
- * @throws TeamException
+ * @throws TeamException if an error occurs
*/
protected InputStream getCachedContents() throws TeamException {
if (isContainer() || !isContentsCached()) return null;
diff --git a/bundles/org.eclipse.team.core/src/org/eclipse/team/core/variants/IResourceVariant.java b/bundles/org.eclipse.team.core/src/org/eclipse/team/core/variants/IResourceVariant.java
index bc6705393..46e900f63 100644
--- a/bundles/org.eclipse.team.core/src/org/eclipse/team/core/variants/IResourceVariant.java
+++ b/bundles/org.eclipse.team.core/src/org/eclipse/team/core/variants/IResourceVariant.java
@@ -58,7 +58,7 @@ public interface IResourceVariant {
*
* @return an <code>IStorage</code> that provides access to the contents of
* the remote resource or <code>null</code> if the remote resource is a container.
- * @throws TeamException
+ * @throws TeamException if an error occurs
*/
public IStorage getStorage(IProgressMonitor monitor) throws TeamException;
diff --git a/bundles/org.eclipse.team.core/src/org/eclipse/team/core/variants/IResourceVariantTree.java b/bundles/org.eclipse.team.core/src/org/eclipse/team/core/variants/IResourceVariantTree.java
index dc6c5fbcc..f687e784b 100644
--- a/bundles/org.eclipse.team.core/src/org/eclipse/team/core/variants/IResourceVariantTree.java
+++ b/bundles/org.eclipse.team.core/src/org/eclipse/team/core/variants/IResourceVariantTree.java
@@ -43,7 +43,7 @@ public interface IResourceVariantTree {
* members can be retrieved using <code>getResourceVariant(IResource)</code>.
* @param resource the local resource
* @return the members of the local resource for which this tree contains resource variants
- * @throws TeamException
+ * @throws TeamException if an error occurs
*/
public abstract IResource[] members(IResource resource) throws TeamException;
@@ -52,7 +52,7 @@ public interface IResourceVariantTree {
* <code>null</code> if there is no variant for the resource.
* @param resource the local resource
* @return the resource's variant in this tree
- * @throws TeamException
+ * @throws TeamException if an error occurs
*/
public abstract IResourceVariant getResourceVariant(IResource resource) throws TeamException;
@@ -60,7 +60,7 @@ public interface IResourceVariantTree {
* Return whether the local resource has a variant in this tree.
* @param resource the local resource
* @return <code>true</code> if the tree contains a variant for the resource
- * @throws TeamException
+ * @throws TeamException if an error occurs
*/
public boolean hasResourceVariant(IResource resource) throws TeamException;
@@ -73,7 +73,7 @@ public interface IResourceVariantTree {
* @param monitor a progress monitor
* @return the array of resources whose corresponding variants have changed
* as a result of the refresh
- * @throws TeamException
+ * @throws TeamException if an error occurs
*/
public IResource[] refresh(
IResource[] resources,
@@ -86,7 +86,7 @@ public interface IResourceVariantTree {
* @param resource the resource
* @param depth the flush depth (one of <code>IResource.DEPTH_ZERO</code>,
* <code>IResource.DEPTH_ONE</code>, or <code>IResource.DEPTH_INFINITE</code>)
- * @throws TeamException
+ * @throws TeamException if an error occurs
*/
public void flushVariants(IResource resource, int depth) throws TeamException;
}
diff --git a/bundles/org.eclipse.team.core/src/org/eclipse/team/core/variants/PersistantResourceVariantByteStore.java b/bundles/org.eclipse.team.core/src/org/eclipse/team/core/variants/PersistantResourceVariantByteStore.java
index 3080d9609..a64ed1df7 100644
--- a/bundles/org.eclipse.team.core/src/org/eclipse/team/core/variants/PersistantResourceVariantByteStore.java
+++ b/bundles/org.eclipse.team.core/src/org/eclipse/team/core/variants/PersistantResourceVariantByteStore.java
@@ -105,13 +105,19 @@ public class PersistantResourceVariantByteStore extends ResourceVariantByteStore
}
/**
- * Return whether the resource variant state for this resource is known.
- * This is used to differentiate the case where a resource variant has never been fetched
- * from the case where the resource variant is known to not exist. In the later
- * case, this method returns <code>true</code> while <code>getBytes</code> returns <code>null</code>
+ * Return whether the resource variant state for this resource is known. This is
+ * used to differentiate the case where a resource variant has never been
+ * fetched from the case where the resource variant is known to not exist. In
+ * the later case, this method returns <code>true</code> while
+ * <code>getBytes</code> returns <code>null</code>
+ *
* @param resource the local resource
* @return whether the resource variant state for this resource is known
- * @throws TeamException
+ * @throws TeamException if this operation fails. Reasons include:
+ * <ul>
+ * <li><code>IResourceStatus.PARTNER_NOT_REGISTERED</code>
+ * The sync partner is not registered.</li>
+ * </ul>
*/
public boolean isVariantKnown(IResource resource) throws TeamException {
return internalGetSyncBytes(resource) != null;
diff --git a/bundles/org.eclipse.team.core/src/org/eclipse/team/core/variants/ResourceVariantByteStore.java b/bundles/org.eclipse.team.core/src/org/eclipse/team/core/variants/ResourceVariantByteStore.java
index 275603ab0..2b4deacfb 100644
--- a/bundles/org.eclipse.team.core/src/org/eclipse/team/core/variants/ResourceVariantByteStore.java
+++ b/bundles/org.eclipse.team.core/src/org/eclipse/team/core/variants/ResourceVariantByteStore.java
@@ -51,7 +51,7 @@ public abstract class ResourceVariantByteStore {
* fetched or otherwise determined yet.
* @param resource the local resource
* @return the bytes that represent the resource's variant
- * @throws TeamException
+ * @throws TeamException if an error occurs
*/
public abstract byte[] getBytes(IResource resource) throws TeamException;
@@ -64,7 +64,7 @@ public abstract class ResourceVariantByteStore {
* @param resource the local resource
* @param bytes the bytes that represent the resource's variant
* @return <code>true</code> if the bytes changed
- * @throws TeamException
+ * @throws TeamException if an error occurs
*/
public abstract boolean setBytes(IResource resource, byte[] bytes) throws TeamException;
@@ -77,7 +77,7 @@ public abstract class ResourceVariantByteStore {
* @param depth the depth of the operation (one of <code>IResource.DEPTH_ZERO</code>,
* <code>IResource.DEPTH_ONE</code>, or <code>IResource.DEPTH_INFINITE</code>)
* @return <code>true</code> if there were bytes present which were removed
- * @throws TeamException
+ * @throws TeamException if an error occurs
*/
public abstract boolean flushBytes(IResource resource, int depth) throws TeamException;
diff --git a/bundles/org.eclipse.team.core/src/org/eclipse/team/core/variants/ThreeWaySubscriber.java b/bundles/org.eclipse.team.core/src/org/eclipse/team/core/variants/ThreeWaySubscriber.java
index 297a045d4..89d4f015b 100644
--- a/bundles/org.eclipse.team.core/src/org/eclipse/team/core/variants/ThreeWaySubscriber.java
+++ b/bundles/org.eclipse.team.core/src/org/eclipse/team/core/variants/ThreeWaySubscriber.java
@@ -111,7 +111,7 @@ public abstract class ThreeWaySubscriber extends ResourceVariantTreeSubscriber i
* @param resource the local resource
* @param bytes the bytes that identify a variant of the resource
* @return the resource variant handle recreated from the bytes
- * @throws TeamException
+ * @throws TeamException if an error occurs
*/
public abstract IResourceVariant getResourceVariant(IResource resource, byte[] bytes) throws TeamException;
diff --git a/bundles/org.eclipse.team.core/src/org/eclipse/team/core/variants/ThreeWaySynchronizer.java b/bundles/org.eclipse.team.core/src/org/eclipse/team/core/variants/ThreeWaySynchronizer.java
index 94b4572ae..38a258c58 100644
--- a/bundles/org.eclipse.team.core/src/org/eclipse/team/core/variants/ThreeWaySynchronizer.java
+++ b/bundles/org.eclipse.team.core/src/org/eclipse/team/core/variants/ThreeWaySynchronizer.java
@@ -134,7 +134,7 @@ public class ThreeWaySynchronizer {
*
* @param resource the resource
* @return the base bytes cached with the resource or <code>null</code>
- * @throws TeamException
+ * @throws TeamException if an error occurs
*/
public byte[] getBaseBytes(IResource resource) throws TeamException {
try {
@@ -160,7 +160,7 @@ public class ThreeWaySynchronizer {
*
* @param resource the resource
* @param baseBytes the base bytes that identify the base resource variant
- * @throws TeamException
+ * @throws TeamException if an error occurs
*/
public void setBaseBytes(IResource resource, byte[] baseBytes) throws TeamException {
Assert.isNotNull(baseBytes);
@@ -194,7 +194,7 @@ public class ThreeWaySynchronizer {
* @param resource the resource
* @return <code>true</code> if the resource has been modified since the
* last time the base bytes were set.
- * @throws TeamException
+ * @throws TeamException if an error occurs
*/
public boolean isLocallyModified(IResource resource) throws TeamException {
return ((internalGetSyncBytes(resource) == null && ! isIgnored(resource)) ||
@@ -210,7 +210,7 @@ public class ThreeWaySynchronizer {
*
* @param resource the resource
* @return the remote bytes cached with the resource or <code>null</code>
- * @throws TeamException
+ * @throws TeamException if an error occurs
*/
public byte[] getRemoteBytes(IResource resource) throws TeamException {
try {
@@ -236,7 +236,7 @@ public class ThreeWaySynchronizer {
* @param resource the resource
* @param remoteBytes the base bytes that identify the remote resource variant
* @return <code>true</code> if the remote bytes changed as a result of the set
- * @throws TeamException
+ * @throws TeamException if an error occurs
*/
public boolean setRemoteBytes(IResource resource, byte[] remoteBytes) throws TeamException {
Assert.isNotNull(remoteBytes);
@@ -274,7 +274,7 @@ public class ThreeWaySynchronizer {
* done when the corresponding remote resource variant no longer exists.
* @param resource the resource
* @return <code>true</code> if the remote bytes changed as a result of the removal
- * @throws TeamException
+ * @throws TeamException if an error occurs
*/
public boolean removeRemoteBytes(IResource resource) throws TeamException {
ISchedulingRule rule = null;
@@ -304,7 +304,7 @@ public class ThreeWaySynchronizer {
* Return whether the given resource has sync bytes in the synchronizer.
* @param resource the local resource
* @return whether there are sync bytes cached for the local resources.
- * @throws TeamException
+ * @throws TeamException if an error occurs
*/
public boolean hasSyncBytes(IResource resource) throws TeamException {
return internalGetSyncBytes(resource) != null;
@@ -315,7 +315,7 @@ public class ThreeWaySynchronizer {
* using <code>setIgnored(IResource)</code>.
* @param resource the resource
* @return <code>true</code> if the resource is ignored.
- * @throws TeamException
+ * @throws TeamException if an error occurs
*/
public boolean isIgnored(IResource resource) throws TeamException {
byte[] bytes = cache.getBytes(resource);
@@ -328,7 +328,7 @@ public class ThreeWaySynchronizer {
* are never dirty (see <code>isLocallyModified</code>) and
* do not have base or remote bytes cached for them.
* @param resource the resource to be ignored
- * @throws TeamException
+ * @throws TeamException if an error occurs
*/
public void setIgnored(IResource resource) throws TeamException {
internalSetSyncBytes(resource, IGNORED_BYTES);
@@ -340,7 +340,7 @@ public class ThreeWaySynchronizer {
* @param resource the local resource
* @return the children of the local resource that have cached sync bytes
* or are not ignored
- * @throws TeamException
+ * @throws TeamException if an error occurs
*/
public IResource[] members(IResource resource) throws TeamException {
if (resource.getType() == IResource.FILE) {
@@ -370,7 +370,7 @@ public class ThreeWaySynchronizer {
* @param resource the resource
* @param depth the depth of the flush (one of <code>IResource.DEPTH_ZERO</code>,
* <code>IResource.DEPTH_ONE</code>, or <code>IResource.DEPTH_INFINITE</code>)
- * @throws TeamException
+ * @throws TeamException if an error occurs
*/
public void flush(IResource resource, int depth) throws TeamException {
ISchedulingRule rule = null;
@@ -395,7 +395,7 @@ public class ThreeWaySynchronizer {
* @param resourceRule the scheduling rule that encompasses all modifications
* @param runnable the runnable that performs the sync state modifications
* @param monitor a progress monitor
- * @throws TeamException
+ * @throws TeamException if an error occurs
*/
public void run(IResource resourceRule, IWorkspaceRunnable runnable, IProgressMonitor monitor) throws TeamException {
monitor = Policy.monitorFor(monitor);

Back to the top