mirror of
https://gitlab.winehq.org/wine/wine-gecko.git
synced 2024-09-13 09:24:08 -07:00
105 lines
3.9 KiB
Java
105 lines
3.9 KiB
Java
// Mozilla has modified this file - see http://hg.mozilla.org/ for details.
|
|
/*
|
|
* 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 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.
|
|
*/
|
|
|
|
package org.mozilla.apache.commons.codec.language;
|
|
|
|
import org.mozilla.apache.commons.codec.EncoderException;
|
|
import org.mozilla.apache.commons.codec.StringEncoder;
|
|
|
|
/**
|
|
* Encodes a string into a Caverphone 2.0 value. Delegate to a {@link Caverphone2} instance.
|
|
*
|
|
* This is an algorithm created by the Caversham Project at the University of Otago. It implements the Caverphone 2.0
|
|
* algorithm:
|
|
*
|
|
* @author Apache Software Foundation
|
|
* @version $Id: Caverphone.java 1079535 2011-03-08 20:54:37Z ggregory $
|
|
* @see <a href="http://en.wikipedia.org/wiki/Caverphone">Wikipedia - Caverphone</a>
|
|
* @see <a href="http://caversham.otago.ac.nz/files/working/ctp150804.pdf">Caverphone 2.0 specification</a>
|
|
* @since 1.4
|
|
* @deprecated 1.5 Replaced by {@link Caverphone2}, will be removed in 2.0.
|
|
*/
|
|
public class Caverphone implements StringEncoder {
|
|
|
|
/**
|
|
* Delegate to a {@link Caverphone2} instance to avoid code duplication.
|
|
*/
|
|
final private Caverphone2 encoder = new Caverphone2();
|
|
|
|
/**
|
|
* Creates an instance of the Caverphone encoder
|
|
*/
|
|
public Caverphone() {
|
|
super();
|
|
}
|
|
|
|
/**
|
|
* Encodes the given String into a Caverphone value.
|
|
*
|
|
* @param source
|
|
* String the source string
|
|
* @return A caverphone code for the given String
|
|
*/
|
|
public String caverphone(String source) {
|
|
return this.encoder.encode(source);
|
|
}
|
|
|
|
/**
|
|
* Encodes an Object using the caverphone algorithm. This method is provided in order to satisfy the requirements of
|
|
* the Encoder interface, and will throw an EncoderException if the supplied object is not of type java.lang.String.
|
|
*
|
|
* @param pObject
|
|
* Object to encode
|
|
* @return An object (or type java.lang.String) containing the caverphone code which corresponds to the String
|
|
* supplied.
|
|
* @throws EncoderException
|
|
* if the parameter supplied is not of type java.lang.String
|
|
*/
|
|
public Object encode(Object pObject) throws EncoderException {
|
|
if (!(pObject instanceof String)) {
|
|
throw new EncoderException("Parameter supplied to Caverphone encode is not of type java.lang.String");
|
|
}
|
|
return this.caverphone((String) pObject);
|
|
}
|
|
|
|
/**
|
|
* Encodes a String using the Caverphone algorithm.
|
|
*
|
|
* @param pString
|
|
* String object to encode
|
|
* @return The caverphone code corresponding to the String supplied
|
|
*/
|
|
public String encode(String pString) {
|
|
return this.caverphone(pString);
|
|
}
|
|
|
|
/**
|
|
* Tests if the caverphones of two strings are identical.
|
|
*
|
|
* @param str1
|
|
* First of two strings to compare
|
|
* @param str2
|
|
* Second of two strings to compare
|
|
* @return <code>true</code> if the caverphones of these strings are identical, <code>false</code> otherwise.
|
|
*/
|
|
public boolean isCaverphoneEqual(String str1, String str2) {
|
|
return this.caverphone(str1).equals(this.caverphone(str2));
|
|
}
|
|
|
|
}
|