net.sf.japi.swing
Class LocaleComparator

java.lang.Object
  net.sf.japi.swing.LocaleComparator

All Implemented Interfaces:

Comparator<Locale>

public final class LocaleComparator
extends Object
implements Comparator<Locale>

Implementation of Comparator that is able to compare Locale instances by their names (allowing null). The Locale for sorting the Locales is determined at creation time.

Author:

Christian Hujer

Constructor Summary

LocaleComparator()
Create a LocaleComparator.

Method Summary

int	compare(Locale o1, Locale o2) Compares its two arguments for order.

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

LocaleComparator

public LocaleComparator()

Create a LocaleComparator.

Method Detail

compare

public int compare(Locale o1,
                   Locale o2)

Compares its two arguments for order. Returns a negative integer, zero, or a positive integer as the first argument is less than, equal to, or greater than the second.

The implementor must ensure that sgn(compare(x, y)) == -sgn(compare(y, x)) for all x and y. (This implies that compare(x, y) must throw an exception if and only if compare(y, x) throws an exception.)

The implementor must also ensure that the relation is transitive: ((compare(x, y)>0) && (compare(y, z)>0)) implies compare(x, z)>0.

Finally, the implementer must ensure that compare(x, y)==0 implies that sgn(compare(x, z))==sgn(compare(y, z)) for all z.

It is generally the case, but not strictly required that (compare(x, y)==0) == (x.equals(y)). Generally speaking, any comparator that violates this condition should clearly indicate this fact. The recommended language is "Note: this comparator imposes orderings that are inconsistent with equals."

Specified by:

compare in interface Comparator<Locale>

Parameters:

o1 - the first object to be compared.

o2 - the second object to be compared.

Returns:

a negative integer, zero, or a positive integer as the first argument is less than, equal to, or greater than the second.