Class Caverphone
java.lang.Object
org.apache.commons.codec.language.Caverphone
- All Implemented Interfaces:
- Encoder,- StringEncoder
Deprecated.
Encodes a string into a Caverphone 2.0 value. Delegate to a 
Caverphone2 instance.
 This is an algorithm created by the Caversham Project at the University of Otago. It implements the Caverphone 2.0
 algorithm:- Since:
- 1.4
- See Also:
- 
Constructor SummaryConstructors
- 
Method SummaryModifier and TypeMethodDescriptioncaverphone(String source) Deprecated.Encodes the given String into a Caverphone value.Deprecated.Encodes an Object using the Caverphone algorithm.Deprecated.Encodes a String using the Caverphone algorithm.booleanisCaverphoneEqual(String str1, String str2) Deprecated.Tests if the Caverphones of two strings are identical.
- 
Constructor Details- 
Caverphonepublic Caverphone()Deprecated.Constructs a new instance.
 
- 
- 
Method Details- 
caverphoneDeprecated.Encodes the given String into a Caverphone value.- Parameters:
- source- String the source string
- Returns:
- A Caverphone code for the given String
 
- 
encodeDeprecated.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 typeString.- Specified by:
- encodein interface- Encoder
- Parameters:
- obj- Object to encode
- Returns:
- An object (or type String) containing the Caverphone code which corresponds to the String supplied.
- Throws:
- EncoderException- if the parameter supplied is not of type- String.
 
- 
encodeDeprecated.Encodes a String using the Caverphone algorithm.- Specified by:
- encodein interface- StringEncoder
- Parameters:
- str- String object to encode
- Returns:
- The Caverphone code corresponding to the String supplied
 
- 
isCaverphoneEqualDeprecated.Tests if the Caverphones of two strings are identical.- Parameters:
- str1- First of two strings to compare
- str2- Second of two strings to compare
- Returns:
- trueif the Caverphones of these strings are identical,- falseotherwise.
 
 
- 
Caverphone2, will be removed in 2.0.