OPENNLP-1886: Align null contracts, annotations, and dev helper placement with the review conventions

Author: krickert

opennlp-core/opennlp-runtime/src/main/java/opennlp/tools/stemmer/light/FinnishLightStemmer.java

@@ -89,11 +89,11 @@ int stem(char[] s, int len) {
 
     for (int i = 0; i < len; i++)
       switch (s[i]) {
-        case 'ä':
-        case 'å':
+        case '\u00E4':
+        case '\u00E5':
           s[i] = 'a';
           break;
-        case 'ö':
+        case '\u00F6':
           s[i] = 'o';
           break;
       }

opennlp-core/opennlp-runtime/src/main/java/opennlp/tools/stemmer/light/FrenchLightStemmer.java

@@ -167,7 +167,7 @@ int stem(char[] s, int len) {
       s[len - 1] = 'r';
     }
 
-    if (len > 5 && endsWith(s, len, "ième")) return norm(s, len - 4);
+    if (len > 5 && endsWith(s, len, "i\u00E8me")) return norm(s, len - 4);
 
     if (len > 7 && endsWith(s, len, "teuse")) {
       len -= 2;
@@ -183,7 +183,7 @@ int stem(char[] s, int len) {
 
     if (len > 5 && endsWith(s, len, "euse")) return norm(s, len - 2);
 
-    if (len > 8 && endsWith(s, len, "ère")) {
+    if (len > 8 && endsWith(s, len, "\u00E8re")) {
       len--;
       s[len - 2] = 'e';
       return norm(s, len);
@@ -205,7 +205,7 @@ int stem(char[] s, int len) {
 
     if (len > 9 && endsWith(s, len, "nnel")) return norm(s, len - 3);
 
-    if (len > 4 && endsWith(s, len, "ète")) {
+    if (len > 4 && endsWith(s, len, "\u00E8te")) {
       len--;
       s[len - 2] = 'e';
     }
@@ -235,27 +235,27 @@ private int norm(char[] s, int len) {
     if (len > 4) {
       for (int i = 0; i < len; i++)
         switch (s[i]) {
-          case 'à':
-          case 'á':
-          case 'â':
+          case '\u00E0':
+          case '\u00E1':
+          case '\u00E2':
             s[i] = 'a';
             break;
-          case 'ô':
+          case '\u00F4':
             s[i] = 'o';
             break;
-          case 'è':
-          case 'é':
-          case 'ê':
+          case '\u00E8':
+          case '\u00E9':
+          case '\u00EA':
             s[i] = 'e';
             break;
-          case 'ù':
-          case 'û':
+          case '\u00F9':
+          case '\u00FB':
             s[i] = 'u';
             break;
-          case 'î':
+          case '\u00EE':
             s[i] = 'i';
             break;
-          case 'ç':
+          case '\u00E7':
             s[i] = 'c';
             break;
         }

opennlp-core/opennlp-runtime/src/main/java/opennlp/tools/stemmer/light/FrenchMinimalStemmer.java

@@ -90,7 +90,7 @@ int stem(char[] s, int len) {
     if (s[len - 1] == 's') len--;
     if (s[len - 1] == 'r') len--;
     if (s[len - 1] == 'e') len--;
-    if (s[len - 1] == 'é') len--;
+    if (s[len - 1] == '\u00E9') len--;
     // Character.isLetter is intentional: it is the letter test of the ported algorithm.
     if (s[len - 1] == s[len - 2] && Character.isLetter(s[len - 1])) len--;
     return len;

opennlp-core/opennlp-runtime/src/main/java/opennlp/tools/stemmer/light/GermanLightStemmer.java

@@ -81,28 +81,28 @@ public Stemmer newStemmer() {
   int stem(char[] s, int len) {
     for (int i = 0; i < len; i++)
       switch (s[i]) {
-        case 'ä':
-        case 'à':
-        case 'á':
-        case 'â':
+        case '\u00E4':
+        case '\u00E0':
+        case '\u00E1':
+        case '\u00E2':
           s[i] = 'a';
           break;
-        case 'ö':
-        case 'ò':
-        case 'ó':
-        case 'ô':
+        case '\u00F6':
+        case '\u00F2':
+        case '\u00F3':
+        case '\u00F4':
           s[i] = 'o';
           break;
-        case 'ï':
-        case 'ì':
-        case 'í':
-        case 'î':
+        case '\u00EF':
+        case '\u00EC':
+        case '\u00ED':
+        case '\u00EE':
           s[i] = 'i';
           break;
-        case 'ü':
-        case 'ù':
-        case 'ú':
-        case 'û':
+        case '\u00FC':
+        case '\u00F9':
+        case '\u00FA':
+        case '\u00FB':
           s[i] = 'u';
           break;
       }

opennlp-core/opennlp-runtime/src/main/java/opennlp/tools/stemmer/light/GermanMinimalStemmer.java

@@ -83,13 +83,13 @@ int stem(char[] s, int len) {
 
     for (int i = 0; i < len; i++)
       switch (s[i]) {
-        case 'ä':
+        case '\u00E4':
           s[i] = 'a';
           break;
-        case 'ö':
+        case '\u00F6':
           s[i] = 'o';
           break;
-        case 'ü':
+        case '\u00FC':
           s[i] = 'u';
           break;
       }

opennlp-core/opennlp-runtime/src/main/java/opennlp/tools/stemmer/light/HungarianLightStemmer.java

@@ -86,27 +86,27 @@ public Stemmer newStemmer() {
   int stem(char[] s, int len) {
     for (int i = 0; i < len; i++)
       switch (s[i]) {
-        case 'á':
+        case '\u00E1':
           s[i] = 'a';
           break;
-        case 'ë':
-        case 'é':
+        case '\u00EB':
+        case '\u00E9':
           s[i] = 'e';
           break;
-        case 'í':
+        case '\u00ED':
           s[i] = 'i';
           break;
-        case 'ó':
-        case 'ő':
-        case 'õ':
-        case 'ö':
+        case '\u00F3':
+        case '\u0151':
+        case '\u00F5':
+        case '\u00F6':
           s[i] = 'o';
           break;
-        case 'ú':
-        case 'ű':
-        case 'ũ':
-        case 'û':
-        case 'ü':
+        case '\u00FA':
+        case '\u0171':
+        case '\u0169':
+        case '\u00FB':
+        case '\u00FC':
           s[i] = 'u';
           break;
       }

opennlp-core/opennlp-runtime/src/main/java/opennlp/tools/stemmer/light/ItalianLightStemmer.java

@@ -83,34 +83,34 @@ int stem(char[] s, int len) {
 
     for (int i = 0; i < len; i++)
       switch (s[i]) {
-        case 'à':
-        case 'á':
-        case 'â':
-        case 'ä':
+        case '\u00E0':
+        case '\u00E1':
+        case '\u00E2':
+        case '\u00E4':
           s[i] = 'a';
           break;
-        case 'ò':
-        case 'ó':
-        case 'ô':
-        case 'ö':
+        case '\u00F2':
+        case '\u00F3':
+        case '\u00F4':
+        case '\u00F6':
           s[i] = 'o';
           break;
-        case 'è':
-        case 'é':
-        case 'ê':
-        case 'ë':
+        case '\u00E8':
+        case '\u00E9':
+        case '\u00EA':
+        case '\u00EB':
           s[i] = 'e';
           break;
-        case 'ù':
-        case 'ú':
-        case 'û':
-        case 'ü':
+        case '\u00F9':
+        case '\u00FA':
+        case '\u00FB':
+        case '\u00FC':
           s[i] = 'u';
           break;
-        case 'ì':
-        case 'í':
-        case 'î':
-        case 'ï':
+        case '\u00EC':
+        case '\u00ED':
+        case '\u00EE':
+        case '\u00EF':
           s[i] = 'i';
           break;
       }

opennlp-core/opennlp-runtime/src/main/java/opennlp/tools/stemmer/light/NorwegianLightStemmer.java

@@ -81,17 +81,21 @@ public final class NorwegianLightStemmer extends AbstractCharArrayStemmer
    *
    * @param first The first standard whose endings are removed; must not be null.
    * @param more  Further standards; must not be or contain null.
-   * @throws IllegalArgumentException Thrown if a variety is null.
+   * @throws IllegalArgumentException Thrown if {@code first} or {@code more} is null,
+   *         or {@code more} contains null.
    */
   public NorwegianLightStemmer(NorwegianVariety first, NorwegianVariety... more) {
-    if (first == null || more == null) {
-      throw new IllegalArgumentException("The variety must not be null.");
+    if (first == null) {
+      throw new IllegalArgumentException("first must not be null");
+    }
+    if (more == null) {
+      throw new IllegalArgumentException("more must not be null");
     }
     boolean bokmaal = first == NorwegianVariety.BOKMAAL;
     boolean nynorsk = first == NorwegianVariety.NYNORSK;
     for (final NorwegianVariety variety : more) {
       if (variety == null) {
-        throw new IllegalArgumentException("The variety must not be null.");
+        throw new IllegalArgumentException("more must not contain null");
       }
       bokmaal |= variety == NorwegianVariety.BOKMAAL;
       nynorsk |= variety == NorwegianVariety.NYNORSK;
@@ -149,8 +153,8 @@ int stem(char[] s, int len) {
 
     if (len > 7
         && (endsWith(s, len, "elser")
-            || // general ending (føl-elser -> føl)
-            endsWith(s, len, "elsen"))) // general ending (føl-elsen -> føl)
+            || // general ending (f\u00F8l-elser -> f\u00F8l)
+            endsWith(s, len, "elsen"))) // general ending (f\u00F8l-elsen -> f\u00F8l)
       return len - 5;
 
     if (len > 6
@@ -159,7 +163,7 @@ int stem(char[] s, int len) {
             (endsWith(s, len, "ande") && useNynorsk)
             || // (sov-ande -> sov)
             endsWith(s, len, "else")
-            || // general ending (føl-else -> føl)
+            || // general ending (f\u00F8l-else -> f\u00F8l)
             (endsWith(s, len, "este") && useBokmaal)
             || // adj (fin-este -> fin)
             (endsWith(s, len, "aste") && useNynorsk)

opennlp-core/opennlp-runtime/src/main/java/opennlp/tools/stemmer/light/NorwegianMinimalStemmer.java

@@ -58,7 +58,7 @@
 import static opennlp.tools.stemmer.light.StemmerUtil.endsWith;
 
 /**
- * Minimal Stemmer for Norwegian Bokmål ({@code nb}) and Nynorsk ({@code nn}).
+ * Minimal Stemmer for Norwegian Bokm\u00E5l ({@code nb}) and Nynorsk ({@code nn}).
  *
  * <p>Stems known plural forms for Norwegian nouns only, together with the genitive {@code -s}.
  *
@@ -79,17 +79,21 @@ public final class NorwegianMinimalStemmer extends AbstractCharArrayStemmer
    *
    * @param first The first standard whose endings are removed; must not be null.
    * @param more  Further standards; must not be or contain null.
-   * @throws IllegalArgumentException Thrown if a variety is null.
+   * @throws IllegalArgumentException Thrown if {@code first} or {@code more} is null,
+   *         or {@code more} contains null.
    */
   public NorwegianMinimalStemmer(NorwegianVariety first, NorwegianVariety... more) {
-    if (first == null || more == null) {
-      throw new IllegalArgumentException("The variety must not be null.");
+    if (first == null) {
+      throw new IllegalArgumentException("first must not be null");
+    }
+    if (more == null) {
+      throw new IllegalArgumentException("more must not be null");
     }
     boolean bokmaal = first == NorwegianVariety.BOKMAAL;
     boolean nynorsk = first == NorwegianVariety.NYNORSK;
     for (final NorwegianVariety variety : more) {
       if (variety == null) {
-        throw new IllegalArgumentException("The variety must not be null.");
+        throw new IllegalArgumentException("more must not contain null");
       }
       bokmaal |= variety == NorwegianVariety.BOKMAAL;
       nynorsk |= variety == NorwegianVariety.NYNORSK;