Eclipse Plug-in Developer Guide (Galileo) - IResourceVariantComparator (Eclipse Platform API Specification)

Overview

Package

Class

Use

Tree

Deprecated

Index

Help

Eclipse Platform
Release 3.5

PREV CLASS NEXT CLASS

NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

org.eclipse.team.core.variants
Interface IResourceVariantComparator

All Known Implementing Classes:: ThreeWayResourceComparator

public interface IResourceVariantComparator

An IResourceVariantComparator is provided by a Subscriber and used by a SyncInfo to calculate the sync state of the workspace resources. Subscribers should provide a criteria best suited for their environment. For example, an FTP subscriber could choose to use file size or file timestamps as comparison criteria whereas a CVS workspace subscriber would use file revision numbers.

Since:: 3.0
See Also:: SyncInfo, Subscriber

Method Summary

boolean compare ( IResource local, IResourceVariant remote)
          Returns true if the local resource matches the remote resource based on this criteria and false otherwise.

boolean compare ( IResourceVariant base, IResourceVariant remote)
          Returns true if the base resource matches the remote resource based on this criteria and false otherwise.

boolean isThreeWay ()
          Answers true if the base tree is maintained by this comparator's subscriber.

Method Detail

compare

boolean compare(
IResource local,
                
IResourceVariant remote)

Returns true if the local resource matches the remote resource based on this criteria and false otherwise. Comparing should be fast and based on cached information.

Parameters:: local - the local resource to be compared; remote - the remote resources to be compared
Returns:: true if local and remote are equal based on this criteria and false otherwise.

compare

boolean compare(
IResourceVariant base,
                
IResourceVariant remote)

Returns true if the base resource matches the remote resource based on this criteria and false otherwise. Comparing should be fast and based on cached information.

Parameters:: base - the base resource to be compared; remote - the remote resources to be compared
Returns:: true if base and remote are equal based on this criteria and false otherwise.

isThreeWay

boolean isThreeWay()

Answers true if the base tree is maintained by this comparator's subscriber. If the base tree is not considered than the subscriber can be considered as not supported three-way comparisons. Instead comparisons are made between the local and remote only without consideration for the base.