001/*
002 * Licensed to the Apache Software Foundation (ASF) under one or more
003 * contributor license agreements.  See the NOTICE file distributed with
004 * this work for additional information regarding copyright ownership.
005 * The ASF licenses this file to You under the Apache License, Version 2.0
006 * (the "License"); you may not use this file except in compliance with
007 * the License.  You may obtain a copy of the License at
008 *
009 *      https://www.apache.org/licenses/LICENSE-2.0
010 *
011 * Unless required by applicable law or agreed to in writing, software
012 * distributed under the License is distributed on an "AS IS" BASIS,
013 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
014 * See the License for the specific language governing permissions and
015 * limitations under the License.
016 */
017
018package org.apache.commons.codec.language;
019
020import org.apache.commons.codec.EncoderException;
021import org.apache.commons.codec.StringEncoder;
022
023/**
024 * Encodes a string into a Caverphone value.
025 *
026 * This is an algorithm created by the Caversham Project at the University of Otago. It implements the Caverphone 2.0
027 * algorithm:
028 *
029 * <p>
030 * This class is immutable and thread-safe.
031 * </p>
032 *
033 * @see <a href="https://en.wikipedia.org/wiki/Caverphone">Wikipedia - Caverphone</a>
034 * @since 1.5
035 */
036public abstract class AbstractCaverphone implements StringEncoder {
037
038    /**
039     * Constructs a new instance for subclasses.
040     */
041    public AbstractCaverphone() {
042        // empty
043    }
044
045    /**
046     * Encodes an Object using the Caverphone algorithm. This method is provided in order to satisfy the requirements of
047     * the Encoder interface, and will throw an EncoderException if the supplied object is not of type {@link String}.
048     *
049     * @param source
050     *            Object to encode.
051     * @return An object (or type {@link String}) containing the Caverphone code which corresponds to the String
052     *         supplied.
053     * @throws EncoderException
054     *             Thrown if the parameter supplied is not of type {@link String}.
055     */
056    @Override
057    public Object encode(final Object source) throws EncoderException {
058        if (!(source instanceof String)) {
059            throw new EncoderException("Parameter supplied to Caverphone encode is not of type java.lang.String");
060        }
061        return this.encode((String) source);
062    }
063
064    /**
065     * Tests if the encodings of two strings are equal.
066     *
067     * This method might be promoted to a new AbstractStringEncoder superclass.
068     *
069     * @param str1
070     *            First of two strings to compare.
071     * @param str2
072     *            Second of two strings to compare.
073     * @return {@code true} if the encodings of these strings are identical, {@code false} otherwise.
074     * @throws EncoderException
075     *             Thrown if there is an error condition during the encoding process.
076     */
077    public boolean isEncodeEqual(final String str1, final String str2) throws EncoderException {
078        return this.encode(str1).equals(this.encode(str2));
079    }
080
081}