Strings are comparable, and this comparator allows you to configure it with an instance of a class which implements StringEncoder. More...

Inherits Comparator.

Description

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.

Author: Apache Software Foundation

Version

Id: StringEncoderComparator.java,v 1.14 2004/06/21 23:24:17 ggregory Exp

Notice

The following notice applies to the original API on which this API is based, and to its documentation. The documentation of this API has been revised from the original.

/*
 * Copyright (C) 2006 The Android Open Source Project
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *      http://www.apache.org/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.
 */

Public Member Functions
	StringEncoderComparator ()
	Constructs a new instance.

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

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. More...

Constructor & Destructor Documentation

◆ StringEncoderComparator()

StringEncoderComparator ( StringEncoder stringEncoder )

Parameters

stringEncoder the StringEncoder used for comparisons.

Member Function Documentation

◆ compare()

int compare	(	Object	o1,
		Object	o2
	)

If an com.good.gd.apache.commons.codec.EncoderException is encountered, return 0.