org.apache.commons.codec
Class StringEncoderComparator

java.lang.Object
  org.apache.commons.codec.StringEncoderComparator

All Implemented Interfaces:

Comparator

public class StringEncoderComparator
extends Object
implements Comparator

Strings are comparable, and this comparator allows you to configure it with an instance of a class which implements StringEncoder. This comparator is used to sort Strings by an encoding scheme such as Soundex, Metaphone, etc. This class can come in handy if one need to sort Strings by an encoded form of a name such as Soundex.

Version:

$Id: StringEncoderComparator.java 793391 2009-07-12 18:38:08Z ggregory $

Author:

Apache Software Foundation

Constructor Summary

StringEncoderComparator()
Deprecated. as creating without a StringEncoder will lead to a broken NullPointerException creating comparator.

StringEncoderComparator(StringEncoder stringEncoder)
Constructs a new instance with the given algorithm.

Method Summary

int	compare(Object o1, Object o2) Compares two strings based not on the strings themselves, but on an encoding of the two strings using the StringEncoder this Comparator was created with.

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

StringEncoderComparator

public StringEncoderComparator()

Deprecated. as creating without a StringEncoder will lead to a broken NullPointerException creating comparator.

Constructs a new instance.

StringEncoderComparator

public StringEncoderComparator(StringEncoder stringEncoder)

Constructs a new instance with the given algorithm.

Parameters:

stringEncoder - the StringEncoder used for comparisons.

Method Detail

compare

public int compare(Object o1,
                   Object o2)

Compares two strings based not on the strings themselves, but on an encoding of the two strings using the StringEncoder this Comparator was created with. If an EncoderException is encountered, return 0.

Specified by:

compare in interface Comparator

Parameters:

o1 - the object to compare

o2 - the object to compare to

Returns:

the Comparable.compareTo() return code or 0 if an encoding error was caught.

See Also:

Comparable