Class ContributionComparator
- All Implemented Interfaces:
Comparator
IComparableContribution
instances, either as a
ViewerComparator
(for StructuredViewer
s) or as a traditional
Comparator
.
This class orders contributions by first grouping by priority
(IComparableContribution.getPriority()
) and then by utilizing the
JFace policy comparator to order by label
(IComparableContribution.getLabel()
).- Since:
- 3.4
- See Also:
-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionint
Returns the category of the given element.int
Returns the category of the given element.int
This implementation ofComparator.compare(Object, Object)
does a blind cast on each element toIComparableContribution
.int
Returns a negative, zero, or positive number depending on whether the first element is less than, equal to, or greater than the second element.int
Returns a negative, zero, or positive number depending on whether the first element is less than, equal to, or greater than the second element.Methods inherited from class org.eclipse.jface.viewers.ViewerComparator
getComparator, isSorterProperty, sort
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
Methods inherited from interface java.util.Comparator
equals, reversed, thenComparing, thenComparing, thenComparing, thenComparingDouble, thenComparingInt, thenComparingLong
-
Constructor Details
-
ContributionComparator
public ContributionComparator()
-
-
Method Details
-
compare
This implementation ofComparator.compare(Object, Object)
does a blind cast on each element toIComparableContribution
.- Specified by:
compare
in interfaceComparator
-
compare
Returns a negative, zero, or positive number depending on whether the first element is less than, equal to, or greater than the second element.The default implementation of this method is based on comparing the elements' categories as computed by the
category
framework method. Elements within the same category are further subjected to a case insensitive compare of their label strings. Subclasses may override.- Parameters:
c1
- the first elementc2
- the second element- Returns:
- a negative number if the first element is less than the second
element; the value
0
if the first element is equal to the second element; and a positive number if the first element is greater than the second element
-
compare
Description copied from class:ViewerComparator
Returns a negative, zero, or positive number depending on whether the first element is less than, equal to, or greater than the second element.The default implementation of this method is based on comparing the elements' categories as computed by the
category
framework method. Elements within the same category are further subjected to a case insensitive compare of their label strings, either as computed by the content viewer's label provider, or theirtoString
values in other cases. Subclasses may override.- Overrides:
compare
in classViewerComparator
- Parameters:
viewer
- the viewere1
- the first elemente2
- the second element- Returns:
- a negative number if the first element is less than the
second element; the value
0
if the first element is equal to the second element; and a positive number if the first element is greater than the second element
-
category
Returns the category of the given element. The category is a number used to allocate elements to bins; the bins are arranged in ascending numeric order. The elements within a bin are arranged via a second level sort criterion.The default implementation of this framework method returns the result of
IComparableContribution.getPriority()
. Subclasses may re-implement this method to provide non-trivial categorization.- Parameters:
c
- the element- Returns:
- the category
-
category
Description copied from class:ViewerComparator
Returns the category of the given element. The category is a number used to allocate elements to bins; the bins are arranged in ascending numeric order. The elements within a bin are arranged via a second level sort criterion.The default implementation of this framework method returns
0
. Subclasses may reimplement this method to provide non-trivial categorization.- Overrides:
category
in classViewerComparator
- Parameters:
element
- the element- Returns:
- the category
-