diff options
author | Tomasz Zarna | 2008-06-04 15:59:35 +0000 |
---|---|---|
committer | Tomasz Zarna | 2008-06-04 15:59:35 +0000 |
commit | 873500291e9162ffbb251a4fa4c470a559526f72 (patch) | |
tree | 8918028dfb9c467ca0ffc0a60994dc8c9610ab3c | |
parent | c24d0aa9e02d8b62a9a6b42f7ab64d693e173203 (diff) | |
download | eclipse.platform.team-873500291e9162ffbb251a4fa4c470a559526f72.tar.gz eclipse.platform.team-873500291e9162ffbb251a4fa4c470a559526f72.tar.xz eclipse.platform.team-873500291e9162ffbb251a4fa4c470a559526f72.zip |
bug 234375: Additional adopting of API Tooling by Team/Core
34 files changed, 189 insertions, 228 deletions
diff --git a/bundles/org.eclipse.team.core/src/org/eclipse/team/core/ICache.java b/bundles/org.eclipse.team.core/src/org/eclipse/team/core/ICache.java index f477c9170..9326a0ee4 100644 --- a/bundles/org.eclipse.team.core/src/org/eclipse/team/core/ICache.java +++ b/bundles/org.eclipse.team.core/src/org/eclipse/team/core/ICache.java @@ -1,5 +1,5 @@ /******************************************************************************* - * Copyright (c) 2000, 2006 IBM Corporation and others. + * Copyright (c) 2000, 2008 IBM Corporation and others. * All rights reserved. This program and the accompanying materials * are made available under the terms of the Eclipse Public License v1.0 * which accompanies this distribution, and is available at @@ -15,10 +15,9 @@ package org.eclipse.team.core; * to cache synchronization state related to their model for the duration of the * operation. When the context is disposed, the cache will be disposed and any * listeners notified. - * <p> - * This interface is not intended to be implemented by clients. * * @since 3.2 + * @noimplement This interface is not intended to be implemented by clients. */ public interface ICache { diff --git a/bundles/org.eclipse.team.core/src/org/eclipse/team/core/IFileContentManager.java b/bundles/org.eclipse.team.core/src/org/eclipse/team/core/IFileContentManager.java index 4ab3252fc..c586980ce 100644 --- a/bundles/org.eclipse.team.core/src/org/eclipse/team/core/IFileContentManager.java +++ b/bundles/org.eclipse.team.core/src/org/eclipse/team/core/IFileContentManager.java @@ -16,14 +16,13 @@ import org.eclipse.core.resources.IStorage; /** * This is the API to define mappings between file names, file extensions and * content types, typically used by repository providers in order to determine - * whether a given file can be treated as text or must be considered binary. + * whether a given file can be treated as text or must be considered binary. * * Mappings for names and extensions can either be contributed via an extension * point or via this interface. * * For methods that determine the content type for a given file, the following - * rules apply: - * <li> + * rules apply: <li> * <ul> * Mappings for the entire file name take precedence over mappings for the file * extension only. @@ -33,17 +32,16 @@ import org.eclipse.core.resources.IStorage; * </ul> * </li> * - * If a mapping is added for a name or an extension that already has a mapping - * which has been contributed by a plugin, it overrides the one contributed by the plugin. - * If the user-defined mapping is deleted, the plugin-contributed mapping is valid again. - * This interface is not intended to be implemented by clients. - * - * <p> - * This interface is not intended to be implemented by clients. + * If a mapping is added for a name or an extension that already has a mapping + * which has been contributed by a plugin, it overrides the one contributed by + * the plugin. If the user-defined mapping is deleted, the plugin-contributed + * mapping is valid again. This interface is not intended to be implemented by + * clients. * * @see org.eclipse.team.core.Team#getFileContentManager() * * @since 3.1 + * @noimplement This interface is not intended to be implemented by clients. */ public interface IFileContentManager { diff --git a/bundles/org.eclipse.team.core/src/org/eclipse/team/core/IFileTypeInfo.java b/bundles/org.eclipse.team.core/src/org/eclipse/team/core/IFileTypeInfo.java index 53d87db2d..5dbfdba64 100644 --- a/bundles/org.eclipse.team.core/src/org/eclipse/team/core/IFileTypeInfo.java +++ b/bundles/org.eclipse.team.core/src/org/eclipse/team/core/IFileTypeInfo.java @@ -1,5 +1,5 @@ /******************************************************************************* - * Copyright (c) 2000, 2006 IBM Corporation and others. + * Copyright (c) 2000, 2008 IBM Corporation and others. * All rights reserved. This program and the accompanying materials * are made available under the terms of the Eclipse Public License v1.0 * which accompanies this distribution, and is available at @@ -11,13 +11,12 @@ package org.eclipse.team.core; /** - * A file type info specifies both the file extension and the - * corresponding file type. - * <p> - * This interface is not intended to be implemented by clients. + * A file type info specifies both the file extension and the corresponding file + * type. * * @since 2.0 * @deprecated Use the <code>IFileContentManager</code> API instead. + * @noimplement This interface is not intended to be implemented by clients. */ public interface IFileTypeInfo { /** diff --git a/bundles/org.eclipse.team.core/src/org/eclipse/team/core/IIgnoreInfo.java b/bundles/org.eclipse.team.core/src/org/eclipse/team/core/IIgnoreInfo.java index 9264795ac..ff9db82c3 100644 --- a/bundles/org.eclipse.team.core/src/org/eclipse/team/core/IIgnoreInfo.java +++ b/bundles/org.eclipse.team.core/src/org/eclipse/team/core/IIgnoreInfo.java @@ -1,5 +1,5 @@ /******************************************************************************* - * Copyright (c) 2000, 2006 IBM Corporation and others. + * Copyright (c) 2000, 2008 IBM Corporation and others. * All rights reserved. This program and the accompanying materials * are made available under the terms of the Eclipse Public License v1.0 * which accompanies this distribution, and is available at @@ -11,12 +11,11 @@ package org.eclipse.team.core; /** - * An ignore info specifies both the pattern and the enabled state - * of a globally ignored pattern. - * <p> - * This interface is not intended to be implemented by clients. + * An ignore info specifies both the pattern and the enabled state of a globally + * ignored pattern. * * @since 2.0 + * @noimplement This interface is not intended to be implemented by clients. */ public interface IIgnoreInfo { /** diff --git a/bundles/org.eclipse.team.core/src/org/eclipse/team/core/IStringMapping.java b/bundles/org.eclipse.team.core/src/org/eclipse/team/core/IStringMapping.java index 704d64f9e..bb4d2fdc0 100644 --- a/bundles/org.eclipse.team.core/src/org/eclipse/team/core/IStringMapping.java +++ b/bundles/org.eclipse.team.core/src/org/eclipse/team/core/IStringMapping.java @@ -1,5 +1,5 @@ /******************************************************************************* - * Copyright (c) 2000, 2006 IBM Corporation and others. + * Copyright (c) 2000, 2008 IBM Corporation and others. * All rights reserved. This program and the accompanying materials * are made available under the terms of the Eclipse Public License v1.0 * which accompanies this distribution, and is available at @@ -11,15 +11,13 @@ package org.eclipse.team.core; - /** - * A simple interface for mappings from a string (usually a file name or a file extension) - * and a content type (typically <code>Team.TEXT</code>, <code>Team.BINARY</code> or - * <code>Team.UNKNOWN</code>. - * <p> - * This interface is not intended to be implemented by clients. + * A simple interface for mappings from a string (usually a file name or a file + * extension) and a content type (typically <code>Team.TEXT</code>, + * <code>Team.BINARY</code> or <code>Team.UNKNOWN</code>. * * @since 3.1 + * @noimplement This interface is not intended to be implemented by clients. */ public interface IStringMapping { diff --git a/bundles/org.eclipse.team.core/src/org/eclipse/team/core/diff/IDiff.java b/bundles/org.eclipse.team.core/src/org/eclipse/team/core/diff/IDiff.java index 58e092cd3..ba1a53194 100644 --- a/bundles/org.eclipse.team.core/src/org/eclipse/team/core/diff/IDiff.java +++ b/bundles/org.eclipse.team.core/src/org/eclipse/team/core/diff/IDiff.java @@ -1,5 +1,5 @@ /******************************************************************************* - * Copyright (c) 2000, 2006 IBM Corporation and others. + * Copyright (c) 2000, 2008 IBM Corporation and others. * All rights reserved. This program and the accompanying materials * are made available under the terms of the Eclipse Public License v1.0 * which accompanies this distribution, and is available at @@ -14,14 +14,12 @@ import org.eclipse.team.core.diff.provider.Diff; /** * A diff describes differences between two or more model objects. - * <p> - * This interface is not intended to be implemented by clients. - * Instead, clients can subclass {@link Diff}. - * </p> - * + * * @see ITwoWayDiff * @see IThreeWayDiff * @since 3.2 + * @noimplement This interface is not intended to be implemented by clients. + * Instead, clients can subclass {@link Diff}. */ public interface IDiff { diff --git a/bundles/org.eclipse.team.core/src/org/eclipse/team/core/diff/IDiffChangeEvent.java b/bundles/org.eclipse.team.core/src/org/eclipse/team/core/diff/IDiffChangeEvent.java index 082711e19..9df1e1733 100644 --- a/bundles/org.eclipse.team.core/src/org/eclipse/team/core/diff/IDiffChangeEvent.java +++ b/bundles/org.eclipse.team.core/src/org/eclipse/team/core/diff/IDiffChangeEvent.java @@ -1,5 +1,5 @@ /******************************************************************************* - * Copyright (c) 2000, 2006 IBM Corporation and others. + * Copyright (c) 2000, 2008 IBM Corporation and others. * All rights reserved. This program and the accompanying materials * are made available under the terms of the Eclipse Public License v1.0 * which accompanies this distribution, and is available at @@ -16,10 +16,9 @@ import org.eclipse.core.runtime.IStatus; /** * A change event that describes changes that have occurred * in an {@link IDiffTree}. - * <p> - * This interface is not intended to be implemented by clients. * * @since 3.2 + * @noimplement This interface is not intended to be implemented by clients. */ public interface IDiffChangeEvent { diff --git a/bundles/org.eclipse.team.core/src/org/eclipse/team/core/diff/IDiffTree.java b/bundles/org.eclipse.team.core/src/org/eclipse/team/core/diff/IDiffTree.java index fc8665a17..f0e43adcd 100644 --- a/bundles/org.eclipse.team.core/src/org/eclipse/team/core/diff/IDiffTree.java +++ b/bundles/org.eclipse.team.core/src/org/eclipse/team/core/diff/IDiffTree.java @@ -1,5 +1,5 @@ /******************************************************************************* - * Copyright (c) 2000, 2006 IBM Corporation and others. + * Copyright (c) 2000, 2008 IBM Corporation and others. * All rights reserved. This program and the accompanying materials * are made available under the terms of the Eclipse Public License v1.0 * which accompanies this distribution, and is available at @@ -13,16 +13,16 @@ package org.eclipse.team.core.diff; import org.eclipse.core.runtime.*; /** - * A diff tree provides access to a tree of {@link IDiff} instances. - * For efficiency reasons, the tree only provides diffs for paths that represent a change. - * Paths that do not contain a diff represent but are returned from the tree will - * contain child paths in the set. - * <p> - * This interface is not intended to be implemented by clients. Clients - * should use {@link org.eclipse.team.core.diff.provider.DiffTree} instead. + * A diff tree provides access to a tree of {@link IDiff} instances. For + * efficiency reasons, the tree only provides diffs for paths that represent a + * change. Paths that do not contain a diff represent but are returned from the + * tree will contain child paths in the set. * * @see org.eclipse.team.core.diff.provider.DiffTree * @since 3.2 + * @noimplement This interface is not intended to be implemented by clients. + * Clients should use + * {@link org.eclipse.team.core.diff.provider.DiffTree} instead. */ public interface IDiffTree { diff --git a/bundles/org.eclipse.team.core/src/org/eclipse/team/core/diff/IDiffVisitor.java b/bundles/org.eclipse.team.core/src/org/eclipse/team/core/diff/IDiffVisitor.java index b9f08f216..a3814d79a 100644 --- a/bundles/org.eclipse.team.core/src/org/eclipse/team/core/diff/IDiffVisitor.java +++ b/bundles/org.eclipse.team.core/src/org/eclipse/team/core/diff/IDiffVisitor.java @@ -10,7 +10,6 @@ *******************************************************************************/ package org.eclipse.team.core.diff; - /** * An objects that visits diffs in a diff tree. * <p> diff --git a/bundles/org.eclipse.team.core/src/org/eclipse/team/core/diff/IThreeWayDiff.java b/bundles/org.eclipse.team.core/src/org/eclipse/team/core/diff/IThreeWayDiff.java index 0037bda42..b732163db 100644 --- a/bundles/org.eclipse.team.core/src/org/eclipse/team/core/diff/IThreeWayDiff.java +++ b/bundles/org.eclipse.team.core/src/org/eclipse/team/core/diff/IThreeWayDiff.java @@ -1,5 +1,5 @@ /******************************************************************************* - * Copyright (c) 2000, 2006 IBM Corporation and others. + * Copyright (c) 2000, 2008 IBM Corporation and others. * All rights reserved. This program and the accompanying materials * are made available under the terms of the Eclipse Public License v1.0 * which accompanies this distribution, and is available at @@ -13,19 +13,18 @@ package org.eclipse.team.core.diff; import org.eclipse.team.core.diff.provider.ThreeWayDiff; /** - * A three-way delta that describe the synchronization state between - * two contributors and an ancestor. For simplicity, we refer to - * one of the contributors as the local and the other as the remote. - * A three-way delta is represented as a combination of two two-way - * deltas, one between the ancestor and local and the other between the - * ancestor and remote. For a three-way delta, clients can assume that - * the before state of both the local and remote changes are the same. - * <p> - * This interface is not intended to be implemented by clients. - * Clients that need to create deltas should instead use - * {@link ThreeWayDiff}. - * </p> + * A three-way delta that describe the synchronization state between two + * contributors and an ancestor. For simplicity, we refer to one of the + * contributors as the local and the other as the remote. A three-way delta is + * represented as a combination of two two-way deltas, one between the ancestor + * and local and the other between the ancestor and remote. For a three-way + * delta, clients can assume that the before state of both the local and remote + * changes are the same. + * * @since 3.2 + * @noimplement This interface is not intended to be implemented by clients. + * Clients that need to create deltas should instead use + * {@link ThreeWayDiff}. */ public interface IThreeWayDiff extends IDiff { diff --git a/bundles/org.eclipse.team.core/src/org/eclipse/team/core/diff/ITwoWayDiff.java b/bundles/org.eclipse.team.core/src/org/eclipse/team/core/diff/ITwoWayDiff.java index 0a7afc340..a8845a5fc 100644 --- a/bundles/org.eclipse.team.core/src/org/eclipse/team/core/diff/ITwoWayDiff.java +++ b/bundles/org.eclipse.team.core/src/org/eclipse/team/core/diff/ITwoWayDiff.java @@ -1,5 +1,5 @@ /******************************************************************************* - * Copyright (c) 2000, 2006 IBM Corporation and others. + * Copyright (c) 2000, 2008 IBM Corporation and others. * All rights reserved. This program and the accompanying materials * are made available under the terms of the Eclipse Public License v1.0 * which accompanies this distribution, and is available at @@ -16,16 +16,15 @@ import org.eclipse.team.core.diff.provider.TwoWayDiff; /** * A two-way diff represents the changes between two states of the same object, - * referred to as the "before" state and the "after" state. - * It is modeled after the {@link IResourceDelta} but is simplified. - * <p> - * This interface is not intended to be implemented by clients. Clients that - * need to create two-way diffs should instead use or subclass {@link TwoWayDiff} - * </p> + * referred to as the "before" state and the "after" state. It is modeled after + * the {@link IResourceDelta} but is simplified. * * @see IDiffTree * * @since 3.2 + * @noimplement This interface is not intended to be implemented by clients. + * Clients that need to create two-way diffs should instead use or + * subclass {@link TwoWayDiff} */ public interface ITwoWayDiff extends IDiff { diff --git a/bundles/org.eclipse.team.core/src/org/eclipse/team/core/diff/provider/DiffTree.java b/bundles/org.eclipse.team.core/src/org/eclipse/team/core/diff/provider/DiffTree.java index 87faa11f8..bbdbe4953 100644 --- a/bundles/org.eclipse.team.core/src/org/eclipse/team/core/diff/provider/DiffTree.java +++ b/bundles/org.eclipse.team.core/src/org/eclipse/team/core/diff/provider/DiffTree.java @@ -1,5 +1,5 @@ /******************************************************************************* - * Copyright (c) 2000, 2007 IBM Corporation and others. + * Copyright (c) 2000, 2008 IBM Corporation and others. * All rights reserved. This program and the accompanying materials * are made available under the terms of the Eclipse Public License v1.0 * which accompanies this distribution, and is available at @@ -24,11 +24,10 @@ import org.eclipse.team.internal.core.subscribers.DiffTreeStatistics; /** * Implementation of {@link IDiffTree}. - * <p> - * This class is not intended to be subclassed by clients. - * Clients can instead use {@link DiffTree}. * * @since 3.2 + * @noextend This class is not intended to be subclassed by clients. Clients can + * instead use {@link DiffTree}. */ public class DiffTree implements IDiffTree { diff --git a/bundles/org.eclipse.team.core/src/org/eclipse/team/core/diff/provider/ThreeWayDiff.java b/bundles/org.eclipse.team.core/src/org/eclipse/team/core/diff/provider/ThreeWayDiff.java index d390b3c28..77a4c483e 100644 --- a/bundles/org.eclipse.team.core/src/org/eclipse/team/core/diff/provider/ThreeWayDiff.java +++ b/bundles/org.eclipse.team.core/src/org/eclipse/team/core/diff/provider/ThreeWayDiff.java @@ -1,5 +1,5 @@ /******************************************************************************* - * Copyright (c) 2000, 2006 IBM Corporation and others. + * Copyright (c) 2000, 2008 IBM Corporation and others. * All rights reserved. This program and the accompanying materials * are made available under the terms of the Eclipse Public License v1.0 * which accompanies this distribution, and is available at @@ -19,10 +19,9 @@ import org.eclipse.team.internal.core.mapping.SyncInfoToDiffConverter; /** * Implementation of {@link IThreeWayDiff}. - * <p> - * This class is not intended to be subclasses by clients. * * @since 3.2 + * @noextend This class is not intended to be subclassed by clients. */ public class ThreeWayDiff extends Diff implements IThreeWayDiff { diff --git a/bundles/org.eclipse.team.core/src/org/eclipse/team/core/history/IFileHistory.java b/bundles/org.eclipse.team.core/src/org/eclipse/team/core/history/IFileHistory.java index 86e81ddaa..a40fab470 100644 --- a/bundles/org.eclipse.team.core/src/org/eclipse/team/core/history/IFileHistory.java +++ b/bundles/org.eclipse.team.core/src/org/eclipse/team/core/history/IFileHistory.java @@ -1,5 +1,5 @@ /******************************************************************************* - * Copyright (c) 2000, 2006 IBM Corporation and others. + * Copyright (c) 2000, 2008 IBM Corporation and others. * All rights reserved. This program and the accompanying materials * are made available under the terms of the Eclipse Public License v1.0 * which accompanies this distribution, and is available at @@ -8,21 +8,16 @@ * Contributors: * IBM Corporation - initial API and implementation *******************************************************************************/ - package org.eclipse.team.core.history; import org.eclipse.team.core.history.provider.FileHistory; - /** - * * Provides a complete set of IFileRevisions that make up this IFileHistory. * - * <p> - * This interface is not intended to be implemented by clients. Clients can - * instead subclass {@link FileHistory}. * @since 3.2 - * + * @noimplement This interface is not intended to be implemented by clients. + * Clients can instead subclass {@link FileHistory}. */ public interface IFileHistory { diff --git a/bundles/org.eclipse.team.core/src/org/eclipse/team/core/history/IFileHistoryProvider.java b/bundles/org.eclipse.team.core/src/org/eclipse/team/core/history/IFileHistoryProvider.java index ee5f56fcc..5337f03a1 100644 --- a/bundles/org.eclipse.team.core/src/org/eclipse/team/core/history/IFileHistoryProvider.java +++ b/bundles/org.eclipse.team.core/src/org/eclipse/team/core/history/IFileHistoryProvider.java @@ -1,5 +1,5 @@ /******************************************************************************* - * Copyright (c) 2000, 2006 IBM Corporation and others. + * Copyright (c) 2000, 2008 IBM Corporation and others. * All rights reserved. This program and the accompanying materials * are made available under the terms of the Eclipse Public License v1.0 * which accompanies this distribution, and is available at @@ -8,7 +8,6 @@ * Contributors: * IBM Corporation - initial API and implementation *******************************************************************************/ - package org.eclipse.team.core.history; import org.eclipse.core.filesystem.IFileStore; @@ -19,11 +18,10 @@ import org.eclipse.team.core.history.provider.FileHistoryProvider; /** * This is API to access individual file histories. * - * <p> - * This interface is not intended to be implemented by clients. Clients can - * instead subclass {@link FileHistoryProvider}. * @since 3.2 - * + * @noimplement This interface is not intended to be implemented by clients. + * Clients can instead subclass {@link FileHistoryProvider}. + * */ public interface IFileHistoryProvider { diff --git a/bundles/org.eclipse.team.core/src/org/eclipse/team/core/history/IFileRevision.java b/bundles/org.eclipse.team.core/src/org/eclipse/team/core/history/IFileRevision.java index 3b7700b62..95e2a298c 100644 --- a/bundles/org.eclipse.team.core/src/org/eclipse/team/core/history/IFileRevision.java +++ b/bundles/org.eclipse.team.core/src/org/eclipse/team/core/history/IFileRevision.java @@ -1,5 +1,5 @@ /******************************************************************************* - * Copyright (c) 2000, 2006 IBM Corporation and others. + * Copyright (c) 2000, 2008 IBM Corporation and others. * All rights reserved. This program and the accompanying materials * are made available under the terms of the Eclipse Public License v1.0 * which accompanies this distribution, and is available at @@ -17,15 +17,12 @@ import org.eclipse.core.runtime.CoreException; import org.eclipse.core.runtime.IProgressMonitor; import org.eclipse.team.core.history.provider.FileRevision; - /** * Represents an individual revision of a file. * - * <p> - * This interface is not intended to be implemented by clients. Clients can - * instead subclass {@link FileRevision}. - * * @since 3.2 + * @noimplement This interface is not intended to be implemented by clients. + * Clients can instead subclass {@link FileRevision}. */ public interface IFileRevision { diff --git a/bundles/org.eclipse.team.core/src/org/eclipse/team/core/history/ITag.java b/bundles/org.eclipse.team.core/src/org/eclipse/team/core/history/ITag.java index 11cb8d5b0..25646e0ff 100644 --- a/bundles/org.eclipse.team.core/src/org/eclipse/team/core/history/ITag.java +++ b/bundles/org.eclipse.team.core/src/org/eclipse/team/core/history/ITag.java @@ -8,10 +8,8 @@ * Contributors: * IBM Corporation - initial API and implementation *******************************************************************************/ - package org.eclipse.team.core.history; - /** * ITags can be used to hang additional repository information for IFileRevisions. * 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 a8f24e093..7cf552807 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 @@ -1,5 +1,5 @@ /******************************************************************************* - * Copyright (c) 2000, 2006 IBM Corporation and others. + * Copyright (c) 2000, 2008 IBM Corporation and others. * All rights reserved. This program and the accompanying materials * are made available under the terms of the Eclipse Public License v1.0 * which accompanies this distribution, and is available at @@ -19,28 +19,28 @@ import org.eclipse.team.core.mapping.provider.MergeContext; /** * Provides the context for an <code>IResourceMappingMerger</code> or a model - * specific synchronization view that supports merging. - * * <p> - * <a name="async">The diff tree associated with this context may be updated asynchronously in response - * to calls to any method of this context (e.g. merge and markAsMerged methods) that may result in changes - * in the synchronization state of resources. It may also get updated as a result - * of changes triggered from other sources. Hence, the callback from the diff tree - * to report changes may occur in the same thread as the method call or - * asynchronously in a separate thread, regardless of who triggered the refresh. - * Clients of this method (and any other asynchronous method on this context) may - * determine if all changes have been collected using {@link IJobManager#find(Object)} - * using this context as the <code>family</code> argument in order to determine - * if there are any jobs running that are populating the diff tree. Clients may also - * call {@link IJobManager#join(Object, IProgressMonitor)} if they wish to wait until - * all background handlers related to this context are finished. - * </p> + * specific synchronization view that supports merging. * * <p> - * This interface is not intended to be implemented by clients. Clients should - * instead subclass {@link MergeContext}. + * <a name="async">The diff tree associated with this context may be updated + * asynchronously in response to calls to any method of this context (e.g. merge + * and markAsMerged methods) that may result in changes in the synchronization + * state of resources. It may also get updated as a result of changes triggered + * from other sources. Hence, the callback from the diff tree to report changes + * may occur in the same thread as the method call or asynchronously in a + * separate thread, regardless of who triggered the refresh. Clients of this + * method (and any other asynchronous method on this context) may determine if + * all changes have been collected using {@link IJobManager#find(Object)} using + * this context as the <code>family</code> argument in order to determine if + * there are any jobs running that are populating the diff tree. Clients may + * also call {@link IJobManager#join(Object, IProgressMonitor)} if they wish to + * wait until all background handlers related to this context are finished. + * </p> * * @see IResourceMappingMerger * @see MergeContext * @since 3.2 + * @noimplement This interface is not intended to be implemented by clients. + * Clients should instead subclass {@link MergeContext}. */ public interface IMergeContext extends ISynchronizationContext { diff --git a/bundles/org.eclipse.team.core/src/org/eclipse/team/core/mapping/IMergeStatus.java b/bundles/org.eclipse.team.core/src/org/eclipse/team/core/mapping/IMergeStatus.java index 434dcebdf..d445a6881 100644 --- a/bundles/org.eclipse.team.core/src/org/eclipse/team/core/mapping/IMergeStatus.java +++ b/bundles/org.eclipse.team.core/src/org/eclipse/team/core/mapping/IMergeStatus.java @@ -16,20 +16,18 @@ import org.eclipse.core.runtime.IStatus; import org.eclipse.team.core.mapping.provider.MergeStatus; /** - * A special status that is returned when the return code - * of the <code>merge</code> method is <code>CONFLICTS</code>. - * It is possible that there were problems that caused the - * auto-merge to fail. In that case, the implementor of - * <code>IResourceMappingMerger</code> can return a multi-status - * in which one of the children is a <code>MergeStatus</code> and - * the others describe other problems that were encountered. - * <p> - * This interface is not intended to be implemented by clients. + * A special status that is returned when the return code of the + * <code>merge</code> method is <code>CONFLICTS</code>. It is possible that + * there were problems that caused the auto-merge to fail. In that case, the + * implementor of <code>IResourceMappingMerger</code> can return a multi-status + * in which one of the children is a <code>MergeStatus</code> and the others + * describe other problems that were encountered. * * @see org.eclipse.team.core.mapping.IResourceMappingMerger * @see MergeStatus * * @since 3.2 + * @noimplement This interface is not intended to be implemented by clients. */ public interface IMergeStatus extends IStatus { diff --git a/bundles/org.eclipse.team.core/src/org/eclipse/team/core/mapping/IResourceDiff.java b/bundles/org.eclipse.team.core/src/org/eclipse/team/core/mapping/IResourceDiff.java index 9a3184532..867456673 100644 --- a/bundles/org.eclipse.team.core/src/org/eclipse/team/core/mapping/IResourceDiff.java +++ b/bundles/org.eclipse.team.core/src/org/eclipse/team/core/mapping/IResourceDiff.java @@ -1,5 +1,5 @@ /******************************************************************************* - * Copyright (c) 2000, 2006 IBM Corporation and others. + * Copyright (c) 2000, 2008 IBM Corporation and others. * All rights reserved. This program and the accompanying materials * are made available under the terms of the Eclipse Public License v1.0 * which accompanies this distribution, and is available at @@ -17,18 +17,17 @@ import org.eclipse.team.core.diff.ITwoWayDiff; import org.eclipse.team.core.history.IFileRevision; /** - * A resource diff represents the changes between two resources. - * The diff can be used to describe the change between an ancestor and - * remote, an ancestor and local or between the local and a remote - * for two-way comparisons. - * <p> - * This interface is not intended to be implemented by clients. - * Clients that need to create deltas should instead use or subclass - * {@link org.eclipse.team.core.mapping.provider.ResourceDiff} - * </p> + * A resource diff represents the changes between two resources. The diff can be + * used to describe the change between an ancestor and remote, an ancestor and + * local or between the local and a remote for two-way comparisons. + * * @see IDiffTree * * @since 3.2 + * @noimplement This interface is not intended to be implemented by clients. + * Clients that need to create deltas should instead use or + * subclass + * {@link org.eclipse.team.core.mapping.provider.ResourceDiff} */ public interface IResourceDiff extends ITwoWayDiff { diff --git a/bundles/org.eclipse.team.core/src/org/eclipse/team/core/mapping/IResourceDiffTree.java b/bundles/org.eclipse.team.core/src/org/eclipse/team/core/mapping/IResourceDiffTree.java index 53ff9423c..590380793 100644 --- a/bundles/org.eclipse.team.core/src/org/eclipse/team/core/mapping/IResourceDiffTree.java +++ b/bundles/org.eclipse.team.core/src/org/eclipse/team/core/mapping/IResourceDiffTree.java @@ -1,5 +1,5 @@ /******************************************************************************* - * Copyright (c) 2000, 2006 IBM Corporation and others. + * Copyright (c) 2000, 2008 IBM Corporation and others. * All rights reserved. This program and the accompanying materials * are made available under the terms of the Eclipse Public License v1.0 * which accompanies this distribution, and is available at @@ -17,17 +17,15 @@ import org.eclipse.team.core.mapping.provider.ResourceDiffTree; /** * A resource diff tree provides access to a tree of {@link IDiff} instances - * that either contain {@link IResourceDiff} - * nodes or {@link IThreeWayDiff} nodes that contain - * {@link IResourceDiff} nodes as the local and - * remote changes. For efficiency reasons, the tree only provides diffs for - * resources that have changes. Resources that do not contain a change but are - * returned from the tree will contain children in the set. - * <p> - * Clients may not implement this interface but can use {@link ResourceDiffTree} - * instead. + * that either contain {@link IResourceDiff} nodes or {@link IThreeWayDiff} + * nodes that contain {@link IResourceDiff} nodes as the local and remote + * changes. For efficiency reasons, the tree only provides diffs for resources + * that have changes. Resources that do not contain a change but are returned + * from the tree will contain children in the set. * * @since 3.2 + * @noimplement This interface is not intended to be implemented by clients. + * Clients can use {@link ResourceDiffTree} instead. */ public interface IResourceDiffTree extends IDiffTree { diff --git a/bundles/org.eclipse.team.core/src/org/eclipse/team/core/mapping/IResourceMappingMerger.java b/bundles/org.eclipse.team.core/src/org/eclipse/team/core/mapping/IResourceMappingMerger.java index 591f349af..78b1bb3de 100644 --- a/bundles/org.eclipse.team.core/src/org/eclipse/team/core/mapping/IResourceMappingMerger.java +++ b/bundles/org.eclipse.team.core/src/org/eclipse/team/core/mapping/IResourceMappingMerger.java @@ -1,5 +1,5 @@ /******************************************************************************* - * Copyright (c) 2000, 2006 IBM Corporation and others. + * Copyright (c) 2000, 2008 IBM Corporation and others. * All rights reserved. This program and the accompanying materials * are made available under the terms of the Eclipse Public License v1.0 * which accompanies this distribution, and is available at @@ -32,10 +32,6 @@ import org.eclipse.core.runtime.jobs.ISchedulingRule; * } * </pre> * - * <p> - * Clients are not expected to implement this interface but should subclass - * {@link ResourceMappingMerger} instead. - * * @see ResourceMappingMerger * @see IStorageMerger * @see org.eclipse.core.resources.mapping.ResourceMapping @@ -43,6 +39,8 @@ import org.eclipse.core.runtime.jobs.ISchedulingRule; * @see org.eclipse.team.core.mapping.IMergeContext * * @since 3.2 + * @noimplement This interface is not intended to be implemented by clients. + * Client should subclass {@link ResourceMappingMerger} instead. */ public interface IResourceMappingMerger { diff --git a/bundles/org.eclipse.team.core/src/org/eclipse/team/core/mapping/ISynchronizationContext.java b/bundles/org.eclipse.team.core/src/org/eclipse/team/core/mapping/ISynchronizationContext.java index e2b2a7822..59a14675d 100644 --- a/bundles/org.eclipse.team.core/src/org/eclipse/team/core/mapping/ISynchronizationContext.java +++ b/bundles/org.eclipse.team.core/src/org/eclipse/team/core/mapping/ISynchronizationContext.java @@ -27,36 +27,37 @@ import org.eclipse.team.core.mapping.provider.SynchronizationContext; * <p> * The scope of the context is defined when the context is created. The creator * of the scope may affect changes on the scope which will result in property - * change events from the scope and may result in change events from - * the diff tree. Clients should note that it is possible that a change in - * the scope will result in new resources with differences being covered by the scope - * but not result in a change event from the diff tree. This can - * occur because the set may already have contained a diff for the resource - * with the understanding that the client would have ignored it. Consequently, - * clients should listen to both sources in order to guarantee that they update - * any dependent state appropriately. + * change events from the scope and may result in change events from the diff + * tree. Clients should note that it is possible that a change in the scope will + * result in new resources with differences being covered by the scope but not + * result in a change event from the diff tree. This can occur because the set + * may already have contained a diff for the resource with the understanding + * that the client would have ignored it. Consequently, clients should listen to + * both sources in order to guarantee that they update any dependent state + * appropriately. * <p> - * <a name="async">The diff tree associated with this context may be updated asynchronously in response - * to calls to any method of this context (e.g. refresh methods) that may result in changes - * in the synchronization state of resources. It may also get updated as a result - * of changes triggered from other sources. Hence, the callback from the diff tree - * to report changes may occur in the same thread as the method call or - * asynchronously in a separate thread, regardless of who triggered the refresh. - * Clients of this method (and any other asynchronous method on this context) may - * determine if all changes have been collected using {@link IJobManager#find(Object)} - * using this context as the <code>family</code> argument in order to determine - * if there are any jobs running that are populating the diff tree. Clients may also - * call {@link IJobManager#join(Object, IProgressMonitor)} if they wish to wait until + * <a name="async">The diff tree associated with this context may be updated + * asynchronously in response to calls to any method of this context (e.g. + * refresh methods) that may result in changes in the synchronization state of + * resources. It may also get updated as a result of changes triggered from + * other sources. Hence, the callback from the diff tree to report changes may + * occur in the same thread as the method call or asynchronously in a separate + * thread, regardless of who triggered the refresh. Clients of this method (and + * any other asynchronous method on this context) may determine if all changes + * have been collected using {@link IJobManager#find(Object)} using this context + * as the <code>family</code> argument in order to determine if there are any + * jobs running that are populating the diff tree. Clients may also call + * {@link IJobManager#join(Object, IProgressMonitor)} if they wish to wait until * all background handlers related to this context are finished. * </p> - * <p> - * This interface is not intended to be implemented by clients. They should subclass - * {@link SynchronizationContext} or one of its subclasses instead. * * @see SynchronizationContext * @see MergeContext * * @since 3.2 + * @noimplement This interface is not intended to be implemented by clients. + * They should subclass {@link SynchronizationContext} or one of + * its subclasses instead. */ public interface ISynchronizationContext { diff --git a/bundles/org.eclipse.team.core/src/org/eclipse/team/core/mapping/ISynchronizationScope.java b/bundles/org.eclipse.team.core/src/org/eclipse/team/core/mapping/ISynchronizationScope.java index 7ac149ce5..120a804c0 100644 --- a/bundles/org.eclipse.team.core/src/org/eclipse/team/core/mapping/ISynchronizationScope.java +++ b/bundles/org.eclipse.team.core/src/org/eclipse/team/core/mapping/ISynchronizationScope.java @@ -1,5 +1,5 @@ /******************************************************************************* - * Copyright (c) 2000, 2006 IBM Corporation and others. + * Copyright (c) 2000, 2008 IBM Corporation and others. * All rights reserved. This program and the accompanying materials * are made available under the terms of the Eclipse Public License v1.0 * which accompanies this distribution, and is available at @@ -18,15 +18,15 @@ import org.eclipse.core.resources.mapping.*; * Interface which defines the protocol for translating a set of * <code>ResourceMapping</code> objects representing a view selection into the * complete set of resources to be operated on. - * <p> - * This interface is not intended to be implemented by clients. Instead, clients should - * use a {@link ISynchronizationScopeManager} to generate a resource mapping scope from - * a set of input resource mappings. * * @see org.eclipse.core.resources.mapping.ResourceMapping * @see ISynchronizationScopeManager * * @since 3.2 + * @noimplement This interface is not intended to be implemented by clients. + * Instead, clients should use a + * {@link ISynchronizationScopeManager} to generate a resource + * mapping scope from a set of input resource mappings. */ public interface ISynchronizationScope { 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 07ce4cc94..62ab38422 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 @@ -1,5 +1,5 @@ /******************************************************************************* - * Copyright (c) 2006 IBM Corporation and others. + * Copyright (c) 2006, 2008 IBM Corporation and others. * All rights reserved. This program and the accompanying materials * are made available under the terms of the Eclipse Public License v1.0 * which accompanies this distribution, and is available at @@ -17,22 +17,20 @@ import org.eclipse.core.runtime.IProgressMonitor; import org.eclipse.team.core.mapping.provider.SynchronizationScopeManager; /** - * A scope manager is responsible for ensuring that the resources - * contained within an {@link ISynchronizationScope} stay up-to-date - * with the model elements (represented as {@link ResourceMapping} instances) - * contained in the scope. The task of keeping a scope up-to-date is - * accomplished by obtaining {@link ISynchronizationScopeParticipant} instances - * for each model that has elements contained in the scope. - * - * <p> - * This interface is not intended to be implemented by clients. Clients can instead - * subclass {@link SynchronizationScopeManager}. + * A scope manager is responsible for ensuring that the resources contained + * within an {@link ISynchronizationScope} stay up-to-date with the model + * elements (represented as {@link ResourceMapping} instances) contained in the + * scope. The task of keeping a scope up-to-date is accomplished by obtaining + * {@link ISynchronizationScopeParticipant} instances for each model that has + * elements contained in the scope. * * @see org.eclipse.core.resources.mapping.ResourceMapping * @see SynchronizationScopeManager * @see ISynchronizationScopeParticipant * * @since 3.2 + * @noimplement This interface is not intended to be implemented by clients. + * Clients can instead subclass {@link SynchronizationScopeManager} */ public interface ISynchronizationScopeManager { diff --git a/bundles/org.eclipse.team.core/src/org/eclipse/team/core/mapping/provider/ResourceDiffTree.java b/bundles/org.eclipse.team.core/src/org/eclipse/team/core/mapping/provider/ResourceDiffTree.java index 5f51979d3..9b230161e 100644 --- a/bundles/org.eclipse.team.core/src/org/eclipse/team/core/mapping/provider/ResourceDiffTree.java +++ b/bundles/org.eclipse.team.core/src/org/eclipse/team/core/mapping/provider/ResourceDiffTree.java @@ -1,5 +1,5 @@ /******************************************************************************* - * Copyright (c) 2000, 2006 IBM Corporation and others. + * Copyright (c) 2000, 2008 IBM Corporation and others. * All rights reserved. This program and the accompanying materials * are made available under the terms of the Eclipse Public License v1.0 * which accompanies this distribution, and is available at @@ -23,10 +23,9 @@ import org.eclipse.team.core.mapping.IResourceDiffTree; /** * Implementation of {@link IResourceDiffTree}. - * <p> - * This class is not intended to be subclassed by clients. * * @since 3.2 + * @noextend This class is not intended to be subclassed by clients. */ public class ResourceDiffTree extends DiffTree implements IResourceDiffTree { 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 ee0aa75ba..3122e9005 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 @@ -1,5 +1,5 @@ /******************************************************************************* - * Copyright (c) 2000, 2007 IBM Corporation and others. + * Copyright (c) 2000, 2008 IBM Corporation and others. * All rights reserved. This program and the accompanying materials * are made available under the terms of the Eclipse Public License v1.0 * which accompanies this distribution, and is available at @@ -50,7 +50,7 @@ import org.eclipse.team.internal.core.mapping.*; * {@link SubscriberScopeManager} class includes participates in the scope * management process. * <p> - * This class is can be subclasses by clients. + * This class can be subclasses by clients. * * @see org.eclipse.core.resources.mapping.ResourceMapping * @see SubscriberScopeManager diff --git a/bundles/org.eclipse.team.core/src/org/eclipse/team/core/subscribers/ISubscriberChangeEvent.java b/bundles/org.eclipse.team.core/src/org/eclipse/team/core/subscribers/ISubscriberChangeEvent.java index 738639fac..e9deabc22 100644 --- a/bundles/org.eclipse.team.core/src/org/eclipse/team/core/subscribers/ISubscriberChangeEvent.java +++ b/bundles/org.eclipse.team.core/src/org/eclipse/team/core/subscribers/ISubscriberChangeEvent.java @@ -12,11 +12,13 @@ package org.eclipse.team.core.subscribers; import org.eclipse.core.resources.IResource; /** - * A change event that describes a change in a resource - * that is or was supervised by a subscriber. + * A change event that describes a change in a resource that is or was + * supervised by a subscriber. * <p> - * Clients are not intended to implement. Instead subclass {@link SubscriberChangeEvent}. + * Clients are not intended to implement. Instead subclass + * {@link SubscriberChangeEvent}. * </p> + * * @see ISubscriberChangeListener * @since 3.0 * @noimplement This interface is not intended to be implemented by clients. 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 36cfb6c1c..dd837b223 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 @@ -14,17 +14,16 @@ import org.eclipse.core.runtime.IProgressMonitor; import org.eclipse.team.core.TeamException; /** - * A handle that provides access to locally cached resource variants that + * A handle that provides access to locally cached resource variants that * represent a resource line-up such as a project version or branch. - * <p> - * This interface is not intended to be implemented by clients. However, - * clients may subclass {@link AbstractResourceVariantTree} or {@link ResourceVariantTree}. - * </p> * * @see AbstractResourceVariantTree * @see ResourceVariantTree * @since 3.0 * @noimplement This interface is not intended to be implemented by clients. + * However, clients may subclass + * {@link AbstractResourceVariantTree} or + * {@link ResourceVariantTree}. */ public interface IResourceVariantTree { 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 41c58e7ba..3ef3b4c12 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 @@ -18,11 +18,9 @@ import org.eclipse.core.runtime.*; import org.eclipse.team.core.TeamException; /** - * A <code>ResourceVariantByteStore</code> that caches the variant bytes using - * the <code>org.eclipse.core.resources.ISynchronizer</code> so that - * the tree is cached across workbench invocations. - * <p> - * This class is not intended to be subclassed by clients. + * A <code>ResourceVariantByteStore</code> that caches the variant bytes using + * the <code>org.eclipse.core.resources.ISynchronizer</code> so that the tree is + * cached across workbench invocations. * * @since 3.0 * @noextend This class is not intended to be subclassed by clients. diff --git a/bundles/org.eclipse.team.core/src/org/eclipse/team/core/variants/SessionResourceVariantByteStore.java b/bundles/org.eclipse.team.core/src/org/eclipse/team/core/variants/SessionResourceVariantByteStore.java index 5e9ac2028..48d32f574 100644 --- a/bundles/org.eclipse.team.core/src/org/eclipse/team/core/variants/SessionResourceVariantByteStore.java +++ b/bundles/org.eclipse.team.core/src/org/eclipse/team/core/variants/SessionResourceVariantByteStore.java @@ -18,10 +18,8 @@ import org.eclipse.core.runtime.Assert; import org.eclipse.team.core.TeamException; /** - * A <code>ResourceVariantByteStore</code> that caches the variant bytes in memory - * and does not persist them over workbench invocations. - * <p> - * This class is not intended to be subclassed by clients. + * A <code>ResourceVariantByteStore</code> that caches the variant bytes in + * memory and does not persist them over workbench invocations. * * @since 3.0 * @noextend This class is not intended to be subclassed by clients. diff --git a/bundles/org.eclipse.team.core/src/org/eclipse/team/internal/core/mapping/ResourceMappingScope.java b/bundles/org.eclipse.team.core/src/org/eclipse/team/internal/core/mapping/ResourceMappingScope.java index 787e1e78e..c81cf57c3 100644 --- a/bundles/org.eclipse.team.core/src/org/eclipse/team/internal/core/mapping/ResourceMappingScope.java +++ b/bundles/org.eclipse.team.core/src/org/eclipse/team/internal/core/mapping/ResourceMappingScope.java @@ -1,5 +1,5 @@ /******************************************************************************* - * Copyright (c) 2000, 2007 IBM Corporation and others. + * Copyright (c) 2000, 2008 IBM Corporation and others. * All rights reserved. This program and the accompanying materials * are made available under the terms of the Eclipse Public License v1.0 * which accompanies this distribution, and is available at @@ -19,14 +19,13 @@ import org.eclipse.team.core.mapping.ISynchronizationScope; import org.eclipse.team.core.mapping.provider.SynchronizationScopeManager; /** - * Concrete implementation of the {@link ISynchronizationScope} - * interface for use by clients. - * <p> - * This class is not intended to be subclasses by clients. + * Concrete implementation of the {@link ISynchronizationScope} interface for + * use by clients. * * @see org.eclipse.core.resources.mapping.ResourceMapping * * @since 3.2 + * @noextend This class is not intended to be subclassed by clients. */ public class ResourceMappingScope extends AbstractResourceMappingScope { diff --git a/bundles/org.eclipse.team.core/src/org/eclipse/team/internal/core/subscribers/DescendantResourceVariantByteStore.java b/bundles/org.eclipse.team.core/src/org/eclipse/team/internal/core/subscribers/DescendantResourceVariantByteStore.java index 45bd0021a..b5f36b8ab 100644 --- a/bundles/org.eclipse.team.core/src/org/eclipse/team/internal/core/subscribers/DescendantResourceVariantByteStore.java +++ b/bundles/org.eclipse.team.core/src/org/eclipse/team/internal/core/subscribers/DescendantResourceVariantByteStore.java @@ -1,5 +1,5 @@ /******************************************************************************* - * Copyright (c) 2000, 2006 IBM Corporation and others. + * Copyright (c) 2000, 2008 IBM Corporation and others. * All rights reserved. This program and the accompanying materials * are made available under the terms of the Eclipse Public License v1.0 * which accompanies this distribution, and is available at @@ -21,19 +21,20 @@ import org.eclipse.team.core.variants.*; /** * A <code>ResourceVariantByteStore</code> that optimizes the memory footprint - * of a remote resource variant tree by only storing those bytes that - * differ from a base resource variant tree. This class should only be used - * for cases where the base and remote are on the same line-of-descent. - * For example, when the remote tree represents the current state of a branch - * and the base represents the state of the same branch when the local workspace - * as last refreshed. + * of a remote resource variant tree by only storing those bytes that differ + * from a base resource variant tree. This class should only be used for cases + * where the base and remote are on the same line-of-descent. For example, when + * the remote tree represents the current state of a branch and the base + * represents the state of the same branch when the local workspace as last + * refreshed. * <p> * This class also contains the logic that allows subclasses to determine if - * bytes stored in the remote tree are on a different line-of-descent than the base. - * This is necessary because it is possible for the base tree to change in ways that - * invalidate the stored remote variants. For example, if the local resources are moved - * from the main trunck to a branch, any cached remote resource variants would be stale. - * + * bytes stored in the remote tree are on a different line-of-descent than the + * base. This is necessary because it is possible for the base tree to change in + * ways that invalidate the stored remote variants. For example, if the local + * resources are moved from the main trunk to a branch, any cached remote + * resource variants would be stale. + * * @since 3.0 */ public abstract class DescendantResourceVariantByteStore extends ResourceVariantByteStore { diff --git a/bundles/org.eclipse.team.core/src/org/eclipse/team/internal/core/subscribers/SyncSetInputFromSyncSet.java b/bundles/org.eclipse.team.core/src/org/eclipse/team/internal/core/subscribers/SyncSetInputFromSyncSet.java index 5074723c3..1aa887c66 100644 --- a/bundles/org.eclipse.team.core/src/org/eclipse/team/internal/core/subscribers/SyncSetInputFromSyncSet.java +++ b/bundles/org.eclipse.team.core/src/org/eclipse/team/internal/core/subscribers/SyncSetInputFromSyncSet.java @@ -1,5 +1,5 @@ /******************************************************************************* - * Copyright (c) 2000, 2006 IBM Corporation and others. + * Copyright (c) 2000, 2008 IBM Corporation and others. * All rights reserved. This program and the accompanying materials * are made available under the terms of the Eclipse Public License v1.0 * which accompanies this distribution, and is available at @@ -17,7 +17,7 @@ import org.eclipse.team.core.synchronize.*; import org.eclipse.team.internal.core.Policy; /** - * Ths class uses the contents of one sync set as the input of another. + * This class uses the contents of one sync set as the input of another. */ public class SyncSetInputFromSyncSet extends SyncSetInput implements ISyncInfoSetChangeListener { |