Class StringEncoderComparator

  • All Implemented Interfaces:
    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.

    This class is immutable and thread-safe.

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      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.
      • Methods inherited from class java.lang.Object

        equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
      • Methods inherited from interface java.util.Comparator

        equals, reversed, thenComparing, thenComparing, thenComparing, thenComparingDouble, thenComparingInt, thenComparingLong
    • Constructor Detail

      • StringEncoderComparator

        @Deprecated
        public StringEncoderComparator()
        Deprecated.
        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.
        Parameters:
        stringEncoder - the StringEncoder used for comparisons.
    • Method Detail

      • 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.
        Specified by:
        compare in interface java.util.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