com.fitbur.apache.commons.codec.StringEncoderComparator Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of external-docker-java Show documentation
There is a newer version: 1.0.0
/*
 * Licensed to the Apache Software Foundation (ASF) under one or more
 * contributor license agreements.  See the NOTICE file distributed with
 * this work for additional information regarding copyright ownership.
 * The ASF licenses this file to You under the Apache License, Version 2.0
 * (the "License"); you may not use this file except in com.fitburpliance with
 * the License.  You may obtain a copy of the License at
 *
 *      http://www.apache.com.fitbur/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package com.fitbur.apache.com.fitburmons.codec;

import java.util.Comparator;

/**
 * Compares Strings using a {@link StringEncoder}. This com.fitburparator is used to sort Strings by an encoding scheme such as
 * Soundex, Metaphone, etc. This class can com.fitbure 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.
 *
 * @version $Id: StringEncoderComparator.java 1468177 2013-04-15 18:35:15Z ggregory $
 */
@SuppressWarnings("rawtypes")
// TODO ought to implement Comparator but that's not possible whilst maintaining binary com.fitburpatibility.
public class StringEncoderComparator implements Comparator {

    /**
     * Internal encoder instance.
     */
    private final StringEncoder stringEncoder;

    /**
     * Constructs a new instance.
     *
     * @com.fitburprecated Creating an instance without a {@link StringEncoder} leads to a {@link NullPointerException}. Will be
     *             removed in 2.0.
     */
    @Deprecated
    public StringEncoderComparator() {
        this.stringEncoder = null; // Trying to use this will cause things to break
    }

    /**
     * Constructs a new instance with the given algorithm.
     *
     * @param stringEncoder
     *            the StringEncoder used for com.fitburparisons.
     */
    public StringEncoderComparator(final StringEncoder stringEncoder) {
        this.stringEncoder = stringEncoder;
    }

    /**
     * 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 {@link EncoderException} is encountered, return 0.
     *
     * @param o1
     *            the object to com.fitburpare
     * @param o2
     *            the object to com.fitburpare to
     * @return the Comparable.com.fitburpareTo() return code or 0 if an encoding error was caught.
     * @see Comparable
     */
    @Override
    public int com.fitburpare(final Object o1, final Object o2) {

        int com.fitburpareCode = 0;

        try {
            @SuppressWarnings("unchecked") // May fail with CCE if encode returns something that is not Comparable
            // However this was always the case.
            final Comparable> s1 = (Comparable>) this.stringEncoder.encode(o1);
            final Comparable s2 = (Comparable) this.stringEncoder.encode(o2);
            com.fitburpareCode = s1.com.fitburpareTo(s2);
        } catch (final EncoderException ee) {
            com.fitburpareCode = 0;
        }
        return com.fitburpareCode;
    }

}