1 /*
2 * Licensed to the Apache Software Foundation (ASF) under one or more
3 * contributor license agreements. See the NOTICE file distributed with
4 * this work for additional information regarding copyright ownership.
5 * The ASF licenses this file to You under the Apache License, Version 2.0
6 * (the "License"); you may not use this file except in compliance with
7 * the License. You may obtain a copy of the License at
8 *
9 * http://www.apache.org/licenses/LICENSE-2.0
10 *
11 * Unless required by applicable law or agreed to in writing, software
12 * distributed under the License is distributed on an "AS IS" BASIS,
13 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14 * See the License for the specific language governing permissions and
15 * limitations under the License.
16 */
17
18 package org.apache.commons.codec.language;
19
20 import org.apache.commons.codec.EncoderException;
21 import org.apache.commons.codec.StringEncoder;
22
23 /**
24 * Encodes a string into a Caverphone 2.0 value. Delegate to a {@link Caverphone2} instance.
25 *
26 * This is an algorithm created by the Caversham Project at the University of Otago. It implements the Caverphone 2.0
27 * algorithm:
28 *
29 * @see <a href="https://en.wikipedia.org/wiki/Caverphone">Wikipedia - Caverphone</a>
30 * @see <a href="https://caversham.otago.ac.nz/files/working/ctp150804.pdf">Caverphone 2.0 specification</a>
31 * @since 1.4
32 * @deprecated 1.5 Replaced by {@link Caverphone2}, will be removed in 2.0.
33 */
34 @Deprecated
35 public class Caverphone implements StringEncoder {
36
37 /**
38 * Delegate to a {@link Caverphone2} instance to avoid code duplication.
39 */
40 final private Caverphone2 encoder = new Caverphone2();
41
42 /**
43 * Encodes the given String into a Caverphone value.
44 *
45 * @param source
46 * String the source string
47 * @return A caverphone code for the given String
48 */
49 public String caverphone(final String source) {
50 return this.encoder.encode(source);
51 }
52
53 /**
54 * Encodes an Object using the caverphone algorithm. This method is provided in order to satisfy the requirements of
55 * the Encoder interface, and will throw an EncoderException if the supplied object is not of type {@link String}.
56 *
57 * @param obj
58 * Object to encode
59 * @return An object (or type {@link String}) containing the caverphone code which corresponds to the String
60 * supplied.
61 * @throws EncoderException
62 * if the parameter supplied is not of type {@link String}.
63 */
64 @Override
65 public Object encode(final Object obj) throws EncoderException {
66 if (!(obj instanceof String)) {
67 throw new EncoderException("Parameter supplied to Caverphone encode is not of type java.lang.String");
68 }
69 return this.caverphone((String) obj);
70 }
71
72 /**
73 * Encodes a String using the Caverphone algorithm.
74 *
75 * @param str
76 * String object to encode
77 * @return The caverphone code corresponding to the String supplied
78 */
79 @Override
80 public String encode(final String str) {
81 return this.caverphone(str);
82 }
83
84 /**
85 * Tests if the caverphones of two strings are identical.
86 *
87 * @param str1
88 * First of two strings to compare
89 * @param str2
90 * Second of two strings to compare
91 * @return {@code true} if the caverphones of these strings are identical, {@code false} otherwise.
92 */
93 public boolean isCaverphoneEqual(final String str1, final String str2) {
94 return this.caverphone(str1).equals(this.caverphone(str2));
95 }
96
97 }