nz.ac.waikato.jdsl.core.ref
Class ComparatorExtender

java.lang.Object
  nz.ac.waikato.jdsl.core.ref.AbstractComparator
      nz.ac.waikato.jdsl.core.ref.ComparatorExtender

All Implemented Interfaces:

Comparator, EqualityComparator

public class ComparatorExtender
extends AbstractComparator
implements Comparator

Takes a java.util.Comparator and adapts it to the nz.ac.waikato.jdsl.core.api.Comparator.

Version:

JDSL 2.1.1

Author:

Mike Boilen (mgb), Luca Vismara (lv)

Constructor Summary

ComparatorExtender(java.util.Comparator comparator)
Constructs a new comparator which adapts the given java.util.Comparator.

Method Summary

int	compare(java.lang.Object x1, java.lang.Object x2) Adapts the comparator method of the underlying comparator.
boolean	isComparable(java.lang.Object o) Tests if an object is comparator by asking the comparator if compare(o,o)

Methods inherited from class nz.ac.waikato.jdsl.core.ref.AbstractComparator

isEqualTo, isGreaterThan, isGreaterThanOrEqualTo, isLessThan, isLessThanOrEqualTo

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface nz.ac.waikato.jdsl.core.api.Comparator

isGreaterThan, isGreaterThanOrEqualTo, isLessThan, isLessThanOrEqualTo

Methods inherited from interface nz.ac.waikato.jdsl.core.api.EqualityComparator

isEqualTo

Constructor Detail

ComparatorExtender

public ComparatorExtender(java.util.Comparator comparator)

Constructs a new comparator which adapts the given java.util.Comparator.

Method Detail

compare

public int compare(java.lang.Object x1,
                   java.lang.Object x2)
            throws java.lang.ClassCastException

Adapts the comparator method of the underlying comparator.

Specified by:

compare in interface Comparator

Specified by:

compare in class AbstractComparator

Parameters:

x1 - First Object to compare

x2 - Second Object to compare

Returns:

a negative value if a < b, zero if a == b, and a positive value if a > b

Throws:

java.lang.ClassCastException - if the underlying comparator throws a ClassCastException

See Also:

Comparator.compare(Object,Object)

isComparable

public boolean isComparable(java.lang.Object o)

Tests if an object is comparator by asking the comparator if compare(o,o)

Specified by:

isComparable in interface EqualityComparator

Parameters:

o - Any java.lang.Object

Returns:

True if and only if this comparator may compare this object.

See Also:

Comparator.compare(Object,Object)