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 value.
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 * <p>
30 * This class is immutable and thread-safe.
31 * </p>
32 *
33 * @see <a href="https://en.wikipedia.org/wiki/Caverphone">Wikipedia - Caverphone</a>
34 * @since 1.5
35 */
36 public abstract class AbstractCaverphone implements StringEncoder {
37
38 /**
39 * Constructs a new instance for subclasses.
40 */
41 public AbstractCaverphone() {
42 // empty
43 }
44
45 /**
46 * Encodes an Object using the Caverphone algorithm. This method is provided in order to satisfy the requirements of
47 * the Encoder interface, and will throw an EncoderException if the supplied object is not of type {@link String}.
48 *
49 * @param source
50 * Object to encode.
51 * @return An object (or type {@link String}) containing the Caverphone code which corresponds to the String
52 * supplied.
53 * @throws EncoderException
54 * Thrown if the parameter supplied is not of type {@link String}.
55 */
56 @Override
57 public Object encode(final Object source) throws EncoderException {
58 if (!(source instanceof String)) {
59 throw new EncoderException("Parameter supplied to Caverphone encode is not of type java.lang.String");
60 }
61 return this.encode((String) source);
62 }
63
64 /**
65 * Tests if the encodings of two strings are equal.
66 *
67 * This method might be promoted to a new AbstractStringEncoder superclass.
68 *
69 * @param str1
70 * First of two strings to compare.
71 * @param str2
72 * Second of two strings to compare.
73 * @return {@code true} if the encodings of these strings are identical, {@code false} otherwise.
74 * @throws EncoderException
75 * Thrown if there is an error condition during the encoding process.
76 */
77 public boolean isEncodeEqual(final String str1, final String str2) throws EncoderException {
78 return this.encode(str1).equals(this.encode(str2));
79 }
80
81 }