All Downloads are FREE. Search and download functionalities are using the official Maven repository.

org.apache.commons.codec.language.AbstractCaverphone Maven / Gradle / Ivy

There is a newer version: 2.12.15
Show newest version
/*
 * 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.apache.commons.codec.language;

import org.apache.commons.codec.EncoderException;
import org.apache.commons.codec.StringEncoder;

/**
 * Encodes a string into a Caverphone value.
 *
 * This is an algorithm created by the Caversham Project at the University of Otago. It implements the Caverphone 2.0
 * algorithm:
 *
 * 

This class is immutable and thread-safe.

* * @version $Id: Caverphone.java 1075947 2011-03-01 17:56:14Z ggregory $ * @see Wikipedia - Caverphone * @since 1.5 */ public abstract class AbstractCaverphone implements StringEncoder { /** * Creates an instance of the Caverphone encoder */ public AbstractCaverphone() { super(); } /** * 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 source * 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 */ @Override public Object encode(final Object source) throws EncoderException { if (!(source instanceof String)) { throw new EncoderException("Parameter supplied to Caverphone encode is not of type java.lang.String"); } return this.encode((String) source); } /** * Tests if the encodings of two strings are equal. * * This method might be promoted to a new AbstractStringEncoder superclass. * * @param str1 * First of two strings to compare * @param str2 * Second of two strings to compare * @return true if the encodings of these strings are identical, false otherwise. * @throws EncoderException * thrown if there is an error condition during the encoding process. */ public boolean isEncodeEqual(final String str1, final String str2) throws EncoderException { return this.encode(str1).equals(this.encode(str2)); } }




© 2015 - 2024 Weber Informatics LLC | Privacy Policy