structure
Class NaturalComparator<ELTTYPE extends java.lang.Comparable<ELTTYPE>>

java.lang.Object
  structure.NaturalComparator<ELTTYPE>

All Implemented Interfaces:

java.util.Comparator<ELTTYPE>

public class NaturalComparator<ELTTYPE extends java.lang.Comparable<ELTTYPE>>
extends java.lang.Object
implements java.util.Comparator<ELTTYPE>

Implementation of the Comparator interface that provides a compare(ELTTYPE, ELTTYPE) method that compares two objects using those objects default compareTo methods.

Example usage:

To print out the equality relationship between two randomly generated integers we could use the following:

 public static void main(String[] argv){
     Random  rand = new Random();
     Comparator c = new NaturalComparator();
      
     //generate two random Integers
     Integer a = new Integer(rand.nextInt(100));
     Integer b = new Integer(rand.nextInt(100));
      
     //print out the proper equality relationship between these integers
     if(c.compare(a,b) > 0) System.out.println("A:" + a + " > B:" + b);
     else if (c.compare(a,b) < 0) System.out.println("A:" + a + " < B:" + b);
     else System.out.println("A:" + a + " = B:" + b);
 

 

Constructor Summary

NaturalComparator()

Method Summary

int	compare(ELTTYPE a, ELTTYPE b) Compare two values, a and b.
boolean	equals(java.lang.Object b) Returns true if the other object is a NaturalComparator.

Methods inherited from class java.lang.Object

getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

NaturalComparator

public NaturalComparator()

Method Detail

compare

public int compare(ELTTYPE a,
                   ELTTYPE b)

Compare two values, a and b. Simply calls the default compareTo method for a on b.

Specified by:

compare in interface java.util.Comparator<ELTTYPE extends java.lang.Comparable<ELTTYPE>>

Parameters:

a - object performing the compare

b - the object being compared

Returns:

value <, ==, > 0 if a <, ==, > b using a.compareTo

Pre:

a, b non-null, and b is same type as a

Post:

returns value <, ==, > 0 if a <, ==, > b

equals

public boolean equals(java.lang.Object b)

Returns true if the other object is a NaturalComparator.

Specified by:

equals in interface java.util.Comparator<ELTTYPE extends java.lang.Comparable<ELTTYPE>>

Overrides:

equals in class java.lang.Object

Parameters:

b - a possible NaturalComparator

Returns:

true if b is a NaturalComparator

Post:

returns true if b is a NaturalComparator