Skip to main content
aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
Diffstat (limited to 'bundles/org.eclipse.team.core/src/org/eclipse/team/core/synchronize/package.html')
-rw-r--r--bundles/org.eclipse.team.core/src/org/eclipse/team/core/synchronize/package.html57
1 files changed, 18 insertions, 39 deletions
diff --git a/bundles/org.eclipse.team.core/src/org/eclipse/team/core/synchronize/package.html b/bundles/org.eclipse.team.core/src/org/eclipse/team/core/synchronize/package.html
index c21ea5545..25d39ad6b 100644
--- a/bundles/org.eclipse.team.core/src/org/eclipse/team/core/synchronize/package.html
+++ b/bundles/org.eclipse.team.core/src/org/eclipse/team/core/synchronize/package.html
@@ -9,47 +9,26 @@
<body>
Application programming interfaces for managing synchronization state.
<h2>Package Specification</h2>
-<p>This package specifies the API for managing the synchronization
-state between the local workspace resources and a corresponding
-variants of those resources. The classes in this package can be used by
-Subscribers (see the org.eclipse.team.core.subscribers package) or
-others. The classes are roughly divided into three categories: <br>
-</p>
+<p>This package specifies the API for managing the synchronization state between
+ the local workspace resources and a corresponding variants of those resources.
+ The classes in this package can be used by Subscribers (see the org.eclipse.team.core.subscribers
+ package) or others. The classes are roughly divided into three categories: </p>
<ul>
- <li>describing the synchronization state of a single resource, <br>
- </li>
- <li>describing the synchronization state of a collection of
-resources, and <br>
- </li>
- <li>notifying interested parties of changes in the synchronization
-state.</li>
+ <li>describing the synchronization state of a one or more resources,</li>
+ <li>notifying interested parties of changes in the synchronization state.</li>
+ <li>filtering a set of resource based on a sync state criteria</li>
</ul>
-<h3>Describing the synchronization state of a single resource</h3>
-<p>The following classes are provided in order to map a local resource
-to its corresponding variant resource and, for the case of a three-way
-compare, base resource.</p>
+<h3>Describing the synchronization state of resources</h3>
+<p>The following classes are provided to accumulate (and possibly filter) the
+ synchronization state of one or more resources.</p>
<ul>
- <li>SyncInfo: node which maps a local resource to a corresponding
-variant resource (and a base resource for three-way compare) and
-descibes the synchronization state of those resources (e.g. in-sync or
-incoming-change).</li>
- <li>IResourceVariant: interface used by SyncInfo to access
-information about a variant resource, such as it's name, its type (file
-or container) and its contents.</li>
- <li>IResourceVariantComparator: interface used by SyncInfo to
-indicate whether the comparison to be used is two-way or three-way and
-to compare either a local resource with a remote resource or, in the
-case of a three-way compare, two remote resources.</li>
-</ul>
-<h3>Describing the synchronization state of a collection of resources</h3>
-<p>The following classes are provided to accumulate multiple SyncInfo
-and to filter the accumulated set based on some selection criteria.</p>
-<ul>
- <li>SyncInfoSet: a set which contains the out-of-sync SyncInfo for
-multiple local resources.</li>
- <li>SyncInfoTree: a specialized set optimized for hierarchical
-resource based access (e.g. to obtain all out-of-sync children of a
-particular local resource).</li>
+ <li>SyncInfo: node which maps a local resource to a corresponding variant resource
+ (and a base resource for three-way compare) and descibes the synchronization
+ state of those resources (e.g. in-sync or incoming-change).</li>
+ <li>SyncInfoSet: a set which contains the out-of-sync SyncInfo for multiple
+ local resources.</li>
+ <li>SyncInfoTree: a specialized set optimized for hierarchical resource based
+ access (e.g. to obtain all out-of-sync children of a particular local resource).</li>
</ul>
<h3>Notifying interested parties of sync info set changes</h3>
<p>Interested parties can register with a SyncInfoSet in order to
@@ -64,7 +43,7 @@ SyncInfoSet</li>
generated by SyncInfoTree which includes notification of resource
subtree aditions and removals.</li>
</ul>
-<h3>Additional classes</h3>
+<h3>Sync info filtering</h3>
<p>There are also some additional classes provided to help manage
SyncInfoSets</p>
<ul>

Back to the top