21
21
import org .apache .commons .codec .StringEncoder ;
22
22
23
23
/**
24
- * Encodes a string into a Refined Soundex value. A refined soundex code is
24
+ * Encodes a string into a Refined Soundex value. A refined Soundex code is
25
25
* optimized for spell checking words. Soundex method originally developed by
26
26
* <CITE>Margaret Odell</CITE> and <CITE>Robert Russell</CITE>.
27
27
*
@@ -77,7 +77,7 @@ public RefinedSoundex() {
77
77
}
78
78
79
79
/**
80
- * Creates a refined soundex instance using a custom mapping. This
80
+ * Creates a refined Soundex instance using a custom mapping. This
81
81
* constructor can be used to customize the mapping, and/or possibly
82
82
* provide an internationalized mapping for a non-Western character set.
83
83
*
@@ -128,15 +128,15 @@ public int difference(final String s1, final String s2) throws EncoderException
128
128
}
129
129
130
130
/**
131
- * Encodes an Object using the refined soundex algorithm. This method is
131
+ * Encodes an Object using the refined Soundex algorithm. This method is
132
132
* provided in order to satisfy the requirements of the Encoder interface,
133
133
* and will throw an EncoderException if the supplied object is not of type
134
134
* {@link String}.
135
135
*
136
136
* @param obj
137
137
* Object to encode
138
138
* @return An object (or type {@link String}) containing the refined
139
- * soundex code which corresponds to the String supplied.
139
+ * Soundex code which corresponds to the String supplied.
140
140
* @throws EncoderException
141
141
* if the parameter supplied is not of type {@link String}
142
142
*/
@@ -149,7 +149,7 @@ public Object encode(final Object obj) throws EncoderException {
149
149
}
150
150
151
151
/**
152
- * Encodes a String using the refined soundex algorithm.
152
+ * Encodes a String using the refined Soundex algorithm.
153
153
*
154
154
* @param str
155
155
* A String object to encode
@@ -185,7 +185,7 @@ char getMappingCode(final char c) {
185
185
*
186
186
* @param str
187
187
* String to encode using the Refined Soundex algorithm
188
- * @return A soundex code for the String supplied
188
+ * @return A Soundex code for the String supplied
189
189
*/
190
190
public String soundex (String str ) {
191
191
if (str == null ) {
0 commit comments