org.simmetrics.simplifiers.Caverphone2 Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of simmetrics-core Show documentation

There is a newer version: 4.1.1

package org.simmetrics.simplifiers;

/**
 * Encodes a string into a Caverphone 2.0 value.
 *
 * This is an algorithm created by the Caversham Project at the University of
 * Otago. It implements the Caverphone 2.0 algorithm.
 * 
 * 
 * This class is immutable and thread-safe.
 * 
 * 
 * @see Wikipedia -
 *      Caverphone
 * @see Caverphone
 *      2.0 specification
 * @see org.apache.commons.codec.language.Caverphone2
 *
 */
public class Caverphone2 implements Simplifier {

	private final org.apache.commons.codec.language.Caverphone2 simplifier = new org.apache.commons.codec.language.Caverphone2();

	@Override
	public String simplify(String input) {
		return simplifier.encode(input);
	}
	@Override
	public String toString() {
		return "Caverphone2";
	}
}