Eclipse Platform
Release 3.4

org.eclipse.core.commands.common
Class NamedHandleObjectComparator

java.lang.Object
  extended byorg.eclipse.core.commands.common.NamedHandleObjectComparator
All Implemented Interfaces:
Comparator

public class NamedHandleObjectComparator
extends Object
implements Comparator

Comparator for instances of NamedHandleObject for display to an end user. The comparison is based on the name of the instances.

Since:
3.2

Constructor Summary
NamedHandleObjectComparator()
           
 
Method Summary
 int compare(Object left, Object right)
          Compares to instances of NamedHandleObject based on their names.
 
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
 

Constructor Detail

NamedHandleObjectComparator

public NamedHandleObjectComparator()
Method Detail

compare

public final int compare(Object left,
                         Object right)
Compares to instances of NamedHandleObject based on their names. This is useful is they are display to an end user.

Specified by:
compare in interface Comparator
Parameters:
left - The first obect to compare; may be null.
right - The second object to compare; may be null.
Returns:
-1 if left is null and right is not null; 0 if they are both null; 1 if left is not null and right is null. Otherwise, the result of left.compareTo(right).

Eclipse Platform
Release 3.4

Guidelines for using Eclipse APIs.

Copyright (c) Eclipse contributors and others 2000, 2008. All rights reserved.