depends.org.apache.commons.codec

类 StringEncoderComparator

java.lang.Object

depends.org.apache.commons.codec.StringEncoderComparator

所有已实现的接口:

java.util.Comparator

public class StringEncoderComparator
extends java.lang.Object
implements java.util.Comparator

Compares Strings using a 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.

构造器概要

构造器

构造器和说明
StringEncoderComparator() 已过时。 Creating an instance without a StringEncoder leads to a NullPointerException. Will be removed in 2.0.
StringEncoderComparator(StringEncoder stringEncoder) Constructs a new instance with the given algorithm.

方法概要

方法

限定符和类型	方法和说明
int	compare(java.lang.Object o1, java.lang.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.

从类继承的方法 java.lang.Object

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

从接口继承的方法 java.util.Comparator

equals

构造器详细资料

StringEncoderComparator

public StringEncoderComparator()

已过时。 Creating an instance without a StringEncoder leads to a NullPointerException. Will be removed in 2.0.

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(java.lang.Object o1,
          java.lang.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.

指定者:

compare 在接口中 java.util.Comparator

参数:

o1 - the object to compare

o2 - the object to compare to

返回:

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

另请参阅:

Comparable