org.simmetrics.simplifiers.Caverphone2 Maven / Gradle / Ivy
/*
* #%L
* Simmetrics Core
* %%
* Copyright (C) 2014 - 2016 Simmetrics Authors
* %%
* 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.
* #L%
*/
package org.simmetrics.simplifiers;
import static com.google.common.base.Preconditions.checkNotNull;
/**
* 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
*
* @deprecated will be removed due to a lack of a good use case
*/
@Deprecated
public final 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) {
checkNotNull(input);
return simplifier.encode(input);
}
@Override
public String toString() {
return "Caverphone2";
}
}