org.apache.commons.codec
Class StringEncoderComparator
- Comparator
public class StringEncoderComparator
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:
- Apache Software Foundation
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.
|
stringEncoder
private StringEncoder stringEncoder
Internal encoder instance.
StringEncoderComparator
public StringEncoderComparator()
Constructs a new instance.
StringEncoderComparator
public StringEncoderComparator(StringEncoder stringEncoder)
Constructs a new instance with the given algorithm.
stringEncoder
- the StringEncoder used for comparisons.
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
.
o1
- the object to compareo2
- the object to compare to
- the Comparable.compareTo() return code or 0 if an encoding error was caught.
Comparable
commons-codec version 1.3 - Copyright © 2002-2004 - Apache Software Foundation