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 * https://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 private final Caverphone2 encoder = new Caverphone2();
41
42 /**
43 * Constructs a new instance.
44 */
45 public Caverphone() {
46 // empty
47 }
48
49 /**
50 * Encodes the given String into a Caverphone value.
51 *
52 * @param source
53 * String the source string
54 * @return A Caverphone code for the given String
55 */
56 public String caverphone(final String source) {
57 return this.encoder.encode(source);
58 }
59
60 /**
61 * Encodes an Object using the Caverphone algorithm. This method is provided in order to satisfy the requirements of
62 * the Encoder interface, and will throw an EncoderException if the supplied object is not of type {@link String}.
63 *
64 * @param obj
65 * Object to encode
66 * @return An object (or type {@link String}) containing the Caverphone code which corresponds to the String
67 * supplied.
68 * @throws EncoderException
69 * if the parameter supplied is not of type {@link String}.
70 */
71 @Override
72 public Object encode(final Object obj) throws EncoderException {
73 if (!(obj instanceof String)) {
74 throw new EncoderException("Parameter supplied to Caverphone encode is not of type java.lang.String");
75 }
76 return caverphone((String) obj);
77 }
78
79 /**
80 * Encodes a String using the Caverphone algorithm.
81 *
82 * @param str
83 * String object to encode
84 * @return The Caverphone code corresponding to the String supplied
85 */
86 @Override
87 public String encode(final String str) {
88 return caverphone(str);
89 }
90
91 /**
92 * Tests if the Caverphones of two strings are identical.
93 *
94 * @param str1
95 * First of two strings to compare
96 * @param str2
97 * Second of two strings to compare
98 * @return {@code true} if the Caverphones of these strings are identical, {@code false} otherwise.
99 */
100 public boolean isCaverphoneEqual(final String str1, final String str2) {
101 return caverphone(str1).equals(caverphone(str2));
102 }
103
104 }