Docjar: A Java Source and Docuemnt Enginecom.*    java.*    javax.*    org.*    all    new    plug-in

Quick Search    Search Deep

org.eclipse.compare.rangedifferencer
Interface IRangeComparator  view IRangeComparator download IRangeComparator.java


public interface IRangeComparator

For breaking an object to compare into a sequence of comparable entities.

It is used by RangeDifferencer to find longest sequences of matching and non-matching ranges.

For example, to compare two text documents and find longest common sequences of matching and non-matching lines, the implementation must break the document into lines. getRangeCount would return the number of lines in the document, and rangesEqual would compare a specified line given with one in another IRangeComparator.

Clients should implement this interface; there is no standard implementation.


Method Summary
 int getRangeCount()
          Returns the number of comparable entities.
 boolean rangesEqual(int thisIndex, IRangeComparator other, int otherIndex)
          Returns whether the comparable entity given by the first index matches an entity specified by the other IRangeComparator and index.
 boolean skipRangeComparison(int length, int maxLength, IRangeComparator other)
          Returns whether a comparison should be skipped because it would be too costly (or lengthy).
 

Method Detail

getRangeCount

public int getRangeCount()
Returns the number of comparable entities.


rangesEqual

public boolean rangesEqual(int thisIndex,
                           IRangeComparator other,
                           int otherIndex)
Returns whether the comparable entity given by the first index matches an entity specified by the other IRangeComparator and index.


skipRangeComparison

public boolean skipRangeComparison(int length,
                                   int maxLength,
                                   IRangeComparator other)
Returns whether a comparison should be skipped because it would be too costly (or lengthy).