You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@commons.apache.org by gg...@apache.org on 2025/05/19 14:41:36 UTC

(commons-codec) branch master updated (489a3ca6 -> 4357dc9b)

This is an automated email from the ASF dual-hosted git repository.

ggregory pushed a change to branch master
in repository https://gitbox.apache.org/repos/asf/commons-codec.git


    from 489a3ca6 Precompile regular expressions in Lang.loadFromResource(String, Languages)
     new 43943fca Add assertion
     new 112463e9 Javadoc typo
     new 7eb185b4 Javadoc typo
     new 8e547828 Javadoc typo
     new fa89e5c4 Javadoc typo
     new 4357dc9b Javadoc typo

The 6 revisions listed above as "new" are entirely new to this
repository and will be described in separate emails.  The revisions
listed as "add" were already present in the repository and have only
been added to this reference.


Summary of changes:
 .../apache/commons/codec/language/ColognePhonetic.java   |  2 +-
 .../commons/codec/language/DaitchMokotoffSoundex.java    | 16 ++++++++--------
 .../org/apache/commons/codec/language/Metaphone.java     |  2 +-
 .../apache/commons/codec/language/RefinedSoundex.java    | 12 ++++++------
 .../java/org/apache/commons/codec/language/Soundex.java  | 14 +++++++-------
 .../codec/language/DaitchMokotoffSoundexTest.java        |  4 ++--
 6 files changed, 25 insertions(+), 25 deletions(-)


(commons-codec) 05/06: Javadoc typo

Posted by gg...@apache.org.
This is an automated email from the ASF dual-hosted git repository.

ggregory pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/commons-codec.git

commit fa89e5c47943bbf8e6485f78bf4b5e954351b036
Author: Gary Gregory <ga...@gmail.com>
AuthorDate: Mon May 19 10:41:24 2025 -0400

    Javadoc typo
---
 .../org/apache/commons/codec/language/RefinedSoundex.java    | 12 ++++++------
 1 file changed, 6 insertions(+), 6 deletions(-)

diff --git a/src/main/java/org/apache/commons/codec/language/RefinedSoundex.java b/src/main/java/org/apache/commons/codec/language/RefinedSoundex.java
index 28089946..39bd9e37 100644
--- a/src/main/java/org/apache/commons/codec/language/RefinedSoundex.java
+++ b/src/main/java/org/apache/commons/codec/language/RefinedSoundex.java
@@ -21,7 +21,7 @@ import org.apache.commons.codec.EncoderException;
 import org.apache.commons.codec.StringEncoder;
 
 /**
- * Encodes a string into a Refined Soundex value. A refined soundex code is
+ * Encodes a string into a Refined Soundex value. A refined Soundex code is
  * optimized for spell checking words. Soundex method originally developed by
  * <CITE>Margaret Odell</CITE> and <CITE>Robert Russell</CITE>.
  *
@@ -77,7 +77,7 @@ public class RefinedSoundex implements StringEncoder {
     }
 
     /**
-     * Creates a refined soundex instance using a custom mapping. This
+     * 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.
      *
@@ -128,7 +128,7 @@ public class RefinedSoundex implements StringEncoder {
     }
 
     /**
-     * Encodes an Object using the refined soundex algorithm. This method is
+     * Encodes an Object using the refined Soundex 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
      * {@link String}.
@@ -136,7 +136,7 @@ public class RefinedSoundex implements StringEncoder {
      * @param obj
      *                  Object to encode
      * @return An object (or type {@link String}) containing the refined
-     *             soundex code which corresponds to the String supplied.
+     *             Soundex code which corresponds to the String supplied.
      * @throws EncoderException
      *                  if the parameter supplied is not of type {@link String}
      */
@@ -149,7 +149,7 @@ public class RefinedSoundex implements StringEncoder {
     }
 
     /**
-     * Encodes a String using the refined soundex algorithm.
+     * Encodes a String using the refined Soundex algorithm.
      *
      * @param str
      *                  A String object to encode
@@ -185,7 +185,7 @@ public class RefinedSoundex implements StringEncoder {
      *
      * @param str
      *                  String to encode using the Refined Soundex algorithm
-     * @return A soundex code for the String supplied
+     * @return A Soundex code for the String supplied
      */
     public String soundex(String str) {
         if (str == null) {


(commons-codec) 06/06: Javadoc typo

Posted by gg...@apache.org.
This is an automated email from the ASF dual-hosted git repository.

ggregory pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/commons-codec.git

commit 4357dc9bdebf5e32944de74015172872e3da9cfa
Author: Gary Gregory <ga...@gmail.com>
AuthorDate: Mon May 19 10:41:32 2025 -0400

    Javadoc typo
---
 .../java/org/apache/commons/codec/language/Soundex.java    | 14 +++++++-------
 1 file changed, 7 insertions(+), 7 deletions(-)

diff --git a/src/main/java/org/apache/commons/codec/language/Soundex.java b/src/main/java/org/apache/commons/codec/language/Soundex.java
index fd6aaced..5c12cd1f 100644
--- a/src/main/java/org/apache/commons/codec/language/Soundex.java
+++ b/src/main/java/org/apache/commons/codec/language/Soundex.java
@@ -146,7 +146,7 @@ public class Soundex implements StringEncoder {
     }
 
     /**
-     * Creates a soundex instance using the given mapping. This constructor can be used to provide an internationalized
+     * Creates a Soundex instance using the given mapping. This constructor can be used to provide an internationalized
      * mapping for a non-Western character set.
      * <p>
      * Every letter of the alphabet is "mapped" to a numerical value. This char array holds the values to which each
@@ -165,7 +165,7 @@ public class Soundex implements StringEncoder {
     }
 
     /**
-     * Creates a refined soundex instance using a custom mapping. This constructor can be used to customize the mapping,
+     * 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.
      * <p>
      * If the mapping contains an instance of {@link #SILENT_MARKER} then H and W are not given special treatment
@@ -181,7 +181,7 @@ public class Soundex implements StringEncoder {
     }
 
     /**
-     * Creates a refined soundex instance using a custom mapping. This constructor can be used to customize the mapping,
+     * 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
@@ -217,12 +217,12 @@ public class Soundex implements StringEncoder {
     }
 
     /**
-     * Encodes an Object using the soundex algorithm. This method is provided in order to satisfy the requirements of
+     * Encodes an Object using the Soundex 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 {@link String}.
      *
      * @param obj
      *                  Object to encode
-     * @return An object (or type {@link String}) containing the soundex code which corresponds to the String
+     * @return An object (or type {@link String}) containing the Soundex code which corresponds to the String
      *             supplied.
      * @throws EncoderException
      *                  if the parameter supplied is not of type {@link String}
@@ -238,7 +238,7 @@ public class Soundex implements StringEncoder {
     }
 
     /**
-     * Encodes a String using the soundex algorithm.
+     * Encodes a String using the Soundex algorithm.
      *
      * @param str
      *                  A String object to encode
@@ -305,7 +305,7 @@ public class Soundex implements StringEncoder {
      *
      * @param str
      *                  String to encode using the Soundex algorithm
-     * @return A soundex code for the String supplied
+     * @return A Soundex code for the String supplied
      * @throws IllegalArgumentException
      *                  if a character is not mapped
      */


(commons-codec) 02/06: Javadoc typo

Posted by gg...@apache.org.
This is an automated email from the ASF dual-hosted git repository.

ggregory pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/commons-codec.git

commit 112463e9a29cbb5937c50570edf29684dcd63697
Author: Gary Gregory <ga...@gmail.com>
AuthorDate: Mon May 19 10:39:18 2025 -0400

    Javadoc typo
---
 .../commons/codec/language/DaitchMokotoffSoundex.java    | 16 ++++++++--------
 1 file changed, 8 insertions(+), 8 deletions(-)

diff --git a/src/main/java/org/apache/commons/codec/language/DaitchMokotoffSoundex.java b/src/main/java/org/apache/commons/codec/language/DaitchMokotoffSoundex.java
index 06f256de..b4f4b030 100644
--- a/src/main/java/org/apache/commons/codec/language/DaitchMokotoffSoundex.java
+++ b/src/main/java/org/apache/commons/codec/language/DaitchMokotoffSoundex.java
@@ -39,7 +39,7 @@ import org.apache.commons.codec.StringEncoder;
  * accuracy in matching especially Slavish and Yiddish surnames with similar pronunciation but differences in spelling.
  * </p>
  * <p>
- * The main differences compared to the other soundex variants are:
+ * The main differences compared to the other Soundex variants are:
  * </p>
  * <ul>
  * <li>coded names are 6 digits long
@@ -75,7 +75,7 @@ public class DaitchMokotoffSoundex implements StringEncoder {
     private static final char NUL = '\0';
 
     /**
-     * Inner class representing a branch during DM soundex encoding.
+     * Inner class representing a branch during DM Soundex encoding.
      */
     private static final class Branch {
         private final StringBuilder builder;
@@ -219,7 +219,7 @@ public class DaitchMokotoffSoundex implements StringEncoder {
     /** The resource file containing the replacement and folding rules */
     private static final String RESOURCE_FILE = "/org/apache/commons/codec/language/dmrules.txt";
 
-    /** The code length of a DM soundex value. */
+    /** The code length of a DM Soundex value. */
     private static final int MAX_LENGTH = 6;
 
     /** Transformation rules indexed by the first character of their pattern. */
@@ -353,7 +353,7 @@ public class DaitchMokotoffSoundex implements StringEncoder {
     }
 
     /**
-     * Performs a cleanup of the input string before the actual soundex transformation.
+     * Performs a cleanup of the input string before the actual Soundex transformation.
      * <p>
      * Removes all whitespace characters and performs ASCII folding if enabled.
      * </p>
@@ -380,7 +380,7 @@ public class DaitchMokotoffSoundex implements StringEncoder {
     }
 
     /**
-     * Encodes an Object using the Daitch-Mokotoff soundex algorithm without branching.
+     * Encodes an Object using the Daitch-Mokotoff Soundex algorithm without branching.
      * <p>
      * 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 {@link String}.
@@ -389,7 +389,7 @@ public class DaitchMokotoffSoundex implements StringEncoder {
      * @see #soundex(String)
      * @param obj
      *            Object to encode
-     * @return An object (of type {@link String}) containing the DM soundex code, which corresponds to the String
+     * @return An object (of type {@link String}) containing the DM Soundex code, which corresponds to the String
      *         supplied.
      * @throws EncoderException
      *             if the parameter supplied is not of type {@link String}
@@ -406,7 +406,7 @@ public class DaitchMokotoffSoundex implements StringEncoder {
     }
 
     /**
-     * Encodes a String using the Daitch-Mokotoff soundex algorithm without branching.
+     * Encodes a String using the Daitch-Mokotoff Soundex algorithm without branching.
      *
      * @see #soundex(String)
      * @param source
@@ -424,7 +424,7 @@ public class DaitchMokotoffSoundex implements StringEncoder {
     }
 
     /**
-     * Encodes a String using the Daitch-Mokotoff soundex algorithm with branching.
+     * Encodes a String using the Daitch-Mokotoff Soundex algorithm with branching.
      * <p>
      * In case a string is encoded into multiple codes (see branching rules), the result will contain all codes,
      * separated by '|'.


(commons-codec) 01/06: Add assertion

Posted by gg...@apache.org.
This is an automated email from the ASF dual-hosted git repository.

ggregory pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/commons-codec.git

commit 43943fcad460c23d64344225236d916df8d53f21
Author: Gary Gregory <ga...@gmail.com>
AuthorDate: Mon May 19 10:38:04 2025 -0400

    Add assertion
---
 .../org/apache/commons/codec/language/DaitchMokotoffSoundexTest.java  | 4 ++--
 1 file changed, 2 insertions(+), 2 deletions(-)

diff --git a/src/test/java/org/apache/commons/codec/language/DaitchMokotoffSoundexTest.java b/src/test/java/org/apache/commons/codec/language/DaitchMokotoffSoundexTest.java
index 0c7846bd..fa882223 100644
--- a/src/test/java/org/apache/commons/codec/language/DaitchMokotoffSoundexTest.java
+++ b/src/test/java/org/apache/commons/codec/language/DaitchMokotoffSoundexTest.java
@@ -151,8 +151,8 @@ public class DaitchMokotoffSoundexTest extends AbstractStringEncoderTest<DaitchM
         assertEquals("645740", soundex("Moskowitz"));
         assertEquals("645740", soundex("Moskovitz"));
         assertEquals("154600|145460|454600|445460", soundex("Jackson"));
-        assertEquals("154654|154645|154644|145465|145464|454654|454645|454644|445465|445464",
-                soundex("Jackson-Jackson"));
+        assertEquals("154654|154645|154644|145465|145464|454654|454645|454644|445465|445464", soundex("Jackson-Jackson"));
+        assertEquals("154654|154645|154644|145465|145464|454654|454645|454644|445465|445464", soundex("JacksonJackson"));
     }
 
     @Test


(commons-codec) 04/06: Javadoc typo

Posted by gg...@apache.org.
This is an automated email from the ASF dual-hosted git repository.

ggregory pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/commons-codec.git

commit 8e54782842f172cbe66eb5ed196e8f6545f7b98a
Author: Gary Gregory <ga...@gmail.com>
AuthorDate: Mon May 19 10:41:20 2025 -0400

    Javadoc typo
---
 src/main/java/org/apache/commons/codec/language/Metaphone.java | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/src/main/java/org/apache/commons/codec/language/Metaphone.java b/src/main/java/org/apache/commons/codec/language/Metaphone.java
index 6a964fe4..22220e4e 100644
--- a/src/main/java/org/apache/commons/codec/language/Metaphone.java
+++ b/src/main/java/org/apache/commons/codec/language/Metaphone.java
@@ -161,7 +161,7 @@ public class Metaphone implements StringEncoder {
 
     /**
      * Find the metaphone value of a String. This is similar to the
-     * soundex algorithm, but better at finding similar sounding words.
+     * Soundex algorithm, but better at finding similar sounding words.
      * All input is converted to upper case.
      * Limitations: Input format is expected to be a single ASCII word
      * with only characters in the A - Z range, no punctuation or numbers.


(commons-codec) 03/06: Javadoc typo

Posted by gg...@apache.org.
This is an automated email from the ASF dual-hosted git repository.

ggregory pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/commons-codec.git

commit 7eb185b4cc9bb5f90b8de7ce7c466a2b8b8f5744
Author: Gary Gregory <ga...@gmail.com>
AuthorDate: Mon May 19 10:41:12 2025 -0400

    Javadoc typo
---
 src/main/java/org/apache/commons/codec/language/ColognePhonetic.java | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/src/main/java/org/apache/commons/codec/language/ColognePhonetic.java b/src/main/java/org/apache/commons/codec/language/ColognePhonetic.java
index 10cffc48..6534625b 100644
--- a/src/main/java/org/apache/commons/codec/language/ColognePhonetic.java
+++ b/src/main/java/org/apache/commons/codec/language/ColognePhonetic.java
@@ -31,7 +31,7 @@ import org.apache.commons.codec.StringEncoder;
  * </p>
  * <p>
  * The <em>K&ouml;lner Phonetik</em> is a phonetic algorithm which is optimized for the German language. It is related to
- * the well-known soundex algorithm.
+ * the well-known Soundex algorithm.
  * </p>
  *
  * <h2>Algorithm</h2>