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