[LUCENE-807] Minor improvement to JavaDoc for ScoreDocComparator

• Type: Improvement
• Status: Closed
• Priority: Trivial
• Resolution: Fixed
• Affects Version/s: 2.1
• Fix Version/s: 2.2
• Component/s: general/javadocs
• Lucene Fields: New, Patch Available
• Assignee: Unassigned
• Reporter: Paul Cowan
• Created: 19/Feb/07 01:26
• Updated: 28/Aug/22 11:34
• Resolved: 15/Mar/07 08:48

Description

About to attach a very small patch for ScoreDocComparator which broadens the contract of compare(ScoreDoc, ScoreDoc) to follow the same semantics as java.util.Comparator.compare() – allow any integer to be returned, rather than specifically -1/0/-1.

Note that this behaviour must already be acceptable; the anonymous ScoreDocComparators returned by FieldSortedHitQueue.comparatorStringLocale() already return the result of Collator.compare(), which is not tied to this -1/0/1 restriction.