Applying sebb's patch from CODEC-72 - fixing the char[] API of Soundex/RefinedSoundex, which shouldn't be used externally as they are the defaults. He's replaced them with Strings for the external use and copying of inputted char[]s

git-svn-id: https://svn.apache.org/repos/asf/commons/proper/codec/trunk@757676 13f79535-47bb-0310-9956-ffa450edef68

Author: hen

src/java/org/apache/commons/codec/language/RefinedSoundex.java

@@ -30,12 +30,14 @@
  */
 public class RefinedSoundex implements StringEncoder {
 
+    public static final String US_ENGLISH_MAPPING_STRING = "01360240043788015936020505";
+
    /**
      * RefinedSoundex is *refined* for a number of reasons one being that the
      * mappings have been altered. This implementation contains default
      * mappings for US English.
      */
-    public static final char[] US_ENGLISH_MAPPING = "01360240043788015936020505".toCharArray();
+    private static final char[] US_ENGLISH_MAPPING = US_ENGLISH_MAPPING_STRING.toCharArray();
 
     /**
      * Every letter of the alphabet is "mapped" to a numerical value. This char
@@ -55,7 +57,7 @@ public class RefinedSoundex implements StringEncoder {
      * English mapping.
      */
     public RefinedSoundex() {
-        this(US_ENGLISH_MAPPING);
+        this.soundexMapping = US_ENGLISH_MAPPING;
     }
 
     /**
@@ -68,7 +70,21 @@ public RefinedSoundex() {
      *                  a given character
      */
     public RefinedSoundex(char[] mapping) {
-        this.soundexMapping = mapping;
+        this.soundexMapping = new char[mapping.length];
+        System.arraycopy(mapping, 0, this.soundexMapping, 0, mapping.length);
+    }
+
+    /**
+     * Creates a refined soundex instance using a custom mapping. This
+     * constructor can be used to customize the mapping, and/or possibly
+     * provide an internationalized mapping for a non-Western character set.
+     * 
+     * @param mapping
+     *                  Mapping string to use when finding the corresponding code for
+     *                  a given character
+     */
+    public RefinedSoundex(String mapping) {
+        this.soundexMapping = mapping.toCharArray();
     }
 
     /**

src/java/org/apache/commons/codec/language/Soundex.java

@@ -47,7 +47,7 @@ public class Soundex implements StringEncoder {
      * 
      * @see Soundex#Soundex(char[])
      */
-    public static final char[] US_ENGLISH_MAPPING = US_ENGLISH_MAPPING_STRING.toCharArray();
+    private static final char[] US_ENGLISH_MAPPING = US_ENGLISH_MAPPING_STRING.toCharArray();
 
     /**
      * An instance of Soundex using the US_ENGLISH_MAPPING mapping.
@@ -100,7 +100,7 @@ public int difference(String s1, String s2) throws EncoderException {
      * @see Soundex#US_ENGLISH_MAPPING
      */
     public Soundex() {
-        this(US_ENGLISH_MAPPING);
+        this.soundexMapping = US_ENGLISH_MAPPING;
     }
 
     /**
@@ -114,7 +114,21 @@ public Soundex() {
      *                  Mapping array to use when finding the corresponding code for a given character
      */
     public Soundex(char[] mapping) {
-        this.soundexMapping= mapping;
+        this.soundexMapping = new char[mapping.length];
+        System.arraycopy(mapping, 0, this.soundexMapping, 0, mapping.length);
+    }
+
+    /**
+     * Creates a refined soundex instance using a custom mapping. This
+     * constructor can be used to customize the mapping, and/or possibly
+     * provide an internationalized mapping for a non-Western character set.
+     * 
+     * @param mapping
+     *                  Mapping string to use when finding the corresponding code for
+     *                  a given character
+     */
+    public Soundex(String mapping) {
+        this.soundexMapping = mapping.toCharArray();
     }
 
     /**

src/test/org/apache/commons/codec/language/RefinedSoundexTest.java

@@ -113,4 +113,16 @@ public void testGetMappingCodeNonLetter() {
         char code = this.getEncoder().getMappingCode('#');
         assertEquals("Code does not equals zero", 0, code);
     }
+    
+    public void testNewInstance() {
+        assertEquals("D6043", new RefinedSoundex().soundex("dogs"));
+    }
+    
+    public void testNewInstance2() {
+        assertEquals("D6043", new RefinedSoundex(RefinedSoundex.US_ENGLISH_MAPPING_STRING.toCharArray()).soundex("dogs"));
+    }
+    
+    public void testNewInstance3() {
+        assertEquals("D6043", new RefinedSoundex(RefinedSoundex.US_ENGLISH_MAPPING_STRING).soundex("dogs"));
+    }
 }

src/test/org/apache/commons/codec/language/SoundexTest.java

@@ -382,14 +382,22 @@ public void testUsMappingEWithAcute() {
      * https://issues.apache.org/jira/browse/CODEC-56
      */
     public void testUsEnglishStatic() {
-        assertEquals(Soundex.US_ENGLISH.soundex("Williams"), "W452");
+        assertEquals("W452", Soundex.US_ENGLISH.soundex("Williams"));
     }
 
     /**
      * https://issues.apache.org/jira/browse/CODEC-54
      * https://issues.apache.org/jira/browse/CODEC-56
      */
     public void testNewInstance() {
-        assertEquals(new Soundex().soundex("Williams"), "W452");
+        assertEquals("W452", new Soundex().soundex("Williams"));
+    }
+    
+    public void testNewInstance2() {
+        assertEquals("W452", new Soundex(Soundex.US_ENGLISH_MAPPING_STRING.toCharArray()).soundex("Williams"));
+    }
+    
+    public void testNewInstance3() {
+        assertEquals("W452", new Soundex(Soundex.US_ENGLISH_MAPPING_STRING).soundex("Williams"));
     }
 }