Merge pull request #238 from google/FF0F89A9FFB90668CB5E5C968FD01756

(AUTOMATIC) opensource update

Author: battre

common/src/main/java/com/google/i18n/addressinput/common/AddressData.java

@@ -110,6 +110,12 @@ public final class AddressData {
   // part.
   private final List<String> addressLines;
 
+  // The landmark affix.
+  private final String landmarkAffix;
+
+  // The landmark name.
+  private final String landmarkName;
+
   // Top-level administrative subdivision of this country.
   private final String administrativeArea;
 
@@ -148,6 +154,8 @@ private AddressData(Builder builder) {
     this.sortingCode = builder.fields.get(AddressField.SORTING_CODE);
     this.organization = builder.fields.get(AddressField.ORGANIZATION);
     this.recipient = builder.fields.get(AddressField.RECIPIENT);
+    this.landmarkAffix = builder.fields.get(AddressField.LANDMARK_AFFIX);
+    this.landmarkName = builder.fields.get(AddressField.LANDMARK_NAME);
     this.addressLines = Collections.unmodifiableList(
         normalizeAddressLines(new ArrayList<String>(builder.addressLines)));
     this.languageCode = builder.language;
@@ -197,14 +205,26 @@ public String toString() {
     for (String line : addressLines) {
       output.append(line + "; ");
     }
-    output.append("ADMIN_AREA=" + administrativeArea + "; "
-        + "LOCALITY=" + locality + "; "
-        + "DEPENDENT_LOCALITY=" + dependentLocality + "; "
-        + "POSTAL_CODE=" + postalCode + "; "
-        + "SORTING_CODE=" + sortingCode + "; "
-        + "ORGANIZATION=" + organization + "; "
-        + "RECIPIENT=" + recipient
-        + ")");
+    output
+        .append("ADMIN_AREA=")
+        .append(administrativeArea)
+        .append("; " + "LOCALITY=")
+        .append(locality)
+        .append("; " + "DEPENDENT_LOCALITY=")
+        .append(dependentLocality)
+        .append("; " + "POSTAL_CODE=")
+        .append(postalCode)
+        .append("; " + "SORTING_CODE=")
+        .append(sortingCode)
+        .append("; " + "ORGANIZATION=")
+        .append(organization)
+        .append("; " + "RECIPIENT=")
+        .append(recipient)
+        .append("; " + "LANDMARK_AFFIX=")
+        .append(landmarkAffix)
+        .append("; " + "LANDMARK_NAME=")
+        .append(landmarkName)
+        .append(")");
     return output.toString();
   }
 
@@ -247,7 +267,13 @@ public boolean equals(Object o) {
             : recipient.equals(addressData.getRecipient()))
         && (languageCode == null
             ? addressData.getLanguageCode() == null
-            : languageCode.equals(addressData.getLanguageCode()));
+            : languageCode.equals(addressData.getLanguageCode()))
+        && (landmarkAffix == null
+            ? addressData.getLandmarkAffix() == null
+            : landmarkAffix.equals(addressData.getLandmarkAffix()))
+        && (landmarkName == null
+            ? addressData.getLandmarkName() == null
+            : landmarkName.equals(addressData.getLandmarkName()));
   }
 
   @Override
@@ -265,7 +291,9 @@ public int hashCode() {
           sortingCode,
           organization,
           recipient,
-          languageCode
+          languageCode,
+          landmarkAffix,
+          landmarkName
         };
 
     for (String field : fields) {
@@ -436,6 +464,16 @@ public String getRecipient() {
     return recipient;
   }
 
+  /** Returns the landmark affix. */
+  public String getLandmarkAffix() {
+    return landmarkAffix;
+  }
+
+  /** Returns the landmark name. */
+  public String getLandmarkName() {
+    return landmarkName;
+  }
+
   /**
    * Returns a value for those address fields which map to a single string value.
    * <p>
@@ -472,6 +510,10 @@ public String getFieldValue(AddressField field) {
         return organization;
       case RECIPIENT:
         return recipient;
+      case LANDMARK_AFFIX:
+        return landmarkAffix;
+      case LANDMARK_NAME:
+        return landmarkName;
       default:
         throw new IllegalArgumentException("multi-value fields not supported: " + field);
     }
@@ -713,6 +755,25 @@ public Builder setRecipient(String recipient) {
       return set(AddressField.RECIPIENT, recipient);
     }
 
+    /**
+     * Sets or clears the landmark affix of the address; see {@link
+     * AddressData.Landmark#getPrefix()}.
+     *
+     * @param landmarkAffix the landmark affix, or null to clear an existing value.
+     */
+    public Builder setLandmarkAffix(String landmarkAffix) {
+      return set(AddressField.LANDMARK_AFFIX, landmarkAffix);
+    }
+
+    /**
+     * Sets or clears the landmark name of the address; see {@link AddressData.Landmark#getName()}.
+     *
+     * @param landmarkName the landmark name, or null to clear an existing value.
+     */
+    public Builder setLandmarkName(String landmarkName) {
+      return set(AddressField.LANDMARK_NAME, landmarkName);
+    }
+
     /**
      * Sets an address field with the specified value. If the value is empty (null or whitespace),
      * the original value associated with the field will be removed.

common/src/main/java/com/google/i18n/addressinput/common/AddressField.java

@@ -68,7 +68,13 @@ public enum AddressField {
   /** The input field used to enter a value for {@link AddressData#getRecipient()}. */
   RECIPIENT('N'),
   /** The input field used to enter a value for {@link AddressData#getOrganization()}. */
-  ORGANIZATION('O');
+  ORGANIZATION('O'),
+
+  /** The input field used to enter a value for {@link AddressData.Landmark#getPrefix()}. */
+  LANDMARK_AFFIX('F'),
+  /** The input field used to enter a value for {@link AddressData.Landmark#getName()}. */
+  LANDMARK_NAME('L'),
+  ;
 
   /** Classification of the visual width of address input fields. */
   public enum WidthType {

common/src/main/java/com/google/i18n/addressinput/common/FormatInterpreter.java

@@ -18,17 +18,16 @@
 
 import com.google.i18n.addressinput.common.AddressField.WidthType;
 import com.google.i18n.addressinput.common.LookupKey.ScriptType;
-
-import org.json.JSONException;
-import org.json.JSONObject;
-import org.json.JSONTokener;
-
 import java.util.ArrayList;
 import java.util.Collections;
 import java.util.EnumSet;
 import java.util.List;
 import java.util.Map;
 import java.util.Set;
+import org.json.JSONException;
+import org.json.JSONObject;
+import org.json.JSONTokener;
+import org.jspecify.nullness.Nullable;
 
 /**
  * Address format interpreter. A utility to find address format related info.
@@ -77,8 +76,7 @@ List<AddressField> getAddressFieldOrder(String formatString, String regionCode)
       AddressField field = getFieldForFormatSubstring(substring);
       // Accept only the first instance for any duplicate fields (which can occur because the
       // string we start with defines format order, which can contain duplicate fields).
-      if (!visibleFields.contains(field)) {
-        visibleFields.add(field);
+      if (visibleFields.add(field)) {
         fieldOrder.add(field);
       }
     }
@@ -189,7 +187,7 @@ static WidthType getWidthOverride(AddressField field, String regionCode) {
    * Visible for Testing - same as {@link #getWidthOverride(AddressField, String)} but testable with
    * fake data.
    */
-  static WidthType getWidthOverride(
+  static @Nullable WidthType getWidthOverride(
       AddressField field, String regionCode, Map<String, String> regionDataMap) {
     Util.checkNotNull(regionCode);
     String overridesString =
@@ -379,19 +377,27 @@ private static String getFormatString(ScriptType scriptType, String regionCode)
     return format;
   }
 
-  private static String getJsonValue(String regionCode, AddressDataKey key) {
+  private static @Nullable String getJsonValue(String regionCode, AddressDataKey key) {
     return getJsonValue(regionCode, key, RegionDataConstants.getCountryFormatMap());
   }
 
-  /**
-   * Visible for testing only.
-   */
-  static String getJsonValue(
+  /** Visible for testing only. */
+  static @Nullable String getJsonValue(
       String regionCode, AddressDataKey key, Map<String, String> regionDataMap) {
     Util.checkNotNull(regionCode);
     String jsonString = regionDataMap.get(regionCode);
-    Util.checkNotNull(jsonString, "no json data for region code " + regionCode);
-
+    if (jsonString == null) {
+      if (regionCode.equals("CQ")) {
+        // TODO: Return data for Guernsey for now for Sark but we should set up some mapping
+        // constants file in the long term.
+        jsonString = regionDataMap.get("GG");
+      }
+      if (jsonString == null) {
+        // TODO: Set up some logging to track region codes we need to account for in the
+        // aforementioned mapping constants file.
+        return null;
+      }
+    }
     try {
       JSONObject jsonObj = new JSONObject(new JSONTokener(jsonString));
       if (!jsonObj.has(Util.toLowerCaseLocaleIndependent(key.name()))) {

common/src/main/java/com/google/i18n/addressinput/common/RegionDataConstants.java

@@ -138,7 +138,7 @@ private static Map<String, String> createMap() {
     map.put("IE", "{\"name\":\"IRELAND\",\"lang\":\"en\",\"languages\":\"en\",\"fmt\":\"%N%n%O%n%A%n%D%n%C%n%S%n%Z\",\"sublocality_name_type\":\"townland\",\"state_name_type\":\"county\",\"zip_name_type\":\"eircode\",\"label_overrides\":[{\"field\":\"S\",\"label\":\"郡\",\"lang\":\"zh\"}]}");
     map.put("IL", "{\"name\":\"ISRAEL\",\"fmt\":\"%N%n%O%n%A%n%C %Z\"}");
     map.put("IM", "{\"name\":\"ISLE OF MAN\",\"fmt\":\"%N%n%O%n%A%n%C%n%Z\",\"require\":\"ACZ\",\"upper\":\"CZ\"}");
-    map.put("IN", "{\"name\":\"INDIA\",\"lang\":\"en\",\"languages\":\"en~hi\",\"fmt\":\"%N%n%O%n%A%n%C %Z%n%S\",\"require\":\"ACSZ\",\"state_name_type\":\"state\",\"zip_name_type\":\"pin\",\"label_overrides\":[{\"field\":\"S1\",\"label\":\"Sublocality 1\"},{\"field\":\"S2\",\"label\":\"Sublocality 2\"},{\"field\":\"S3\",\"label\":\"Sublocality 3\"},{\"field\":\"S4\",\"label\":\"Sublocality 4\"}]}");
+    map.put("IN", "{\"name\":\"INDIA\",\"lang\":\"en\",\"languages\":\"en~hi\",\"fmt\":\"%N%n%O%n%A%n%F%n%L%n%C %Z%n%S\",\"require\":\"ACSZ\",\"state_name_type\":\"state\",\"zip_name_type\":\"pin\",\"label_overrides\":[{\"field\":\"S1\",\"label\":\"Sublocality 1\"},{\"field\":\"S2\",\"label\":\"Sublocality 2\"},{\"field\":\"S3\",\"label\":\"Sublocality 3\"},{\"field\":\"S4\",\"label\":\"Sublocality 4\"}]}");
     map.put("IO", "{\"name\":\"BRITISH INDIAN OCEAN TERRITORY\",\"fmt\":\"%N%n%O%n%A%n%C%n%Z\",\"require\":\"ACZ\",\"upper\":\"CZ\"}");
     map.put("IQ", "{\"name\":\"IRAQ\",\"fmt\":\"%O%n%N%n%A%n%C, %S%n%Z\",\"require\":\"ACS\",\"upper\":\"CS\"}");
     map.put("IR", "{\"name\":\"IRAN\",\"lang\":\"fa\",\"languages\":\"fa\",\"fmt\":\"%O%n%N%n%S%n%C, %D%n%A%n%Z\",\"sublocality_name_type\":\"neighborhood\"}");
@@ -222,7 +222,7 @@ private static Map<String, String> createMap() {
     map.put("PY", "{\"name\":\"PARAGUAY\",\"fmt\":\"%N%n%O%n%A%n%Z %C\"}");
     map.put("QA", "{\"name\":\"QATAR\",\"upper\":\"AC\"}");
     map.put("RE", "{\"name\":\"REUNION\",\"fmt\":\"%O%n%N%n%A%n%Z %C %X\",\"require\":\"ACZ\",\"upper\":\"ACX\"}");
-    map.put("RO", "{\"name\":\"ROMANIA\",\"fmt\":\"%N%n%O%n%A%n%Z %S %C\",\"require\":\"ACZ\",\"upper\":\"AC\",\"label_overrides\":[{\"field\":\"C\",\"label\":\"Județe/sectoare\",\"lang\":\"ro\"},{\"field\":\"C\",\"label\":\"County/sector\",\"lang\":\"en\"},{\"field\":\"S\",\"label\":\"Municipiu/oraș/comună\",\"lang\":\"ro\"},{\"field\":\"S\",\"label\":\"Municipality/city/town/commune\",\"lang\":\"en\"}]}");
+    map.put("RO", "{\"name\":\"ROMANIA\",\"lang\":\"ro\",\"languages\":\"ro\",\"fmt\":\"%N%n%O%n%A%n%Z %S %C\",\"require\":\"ACZ\",\"upper\":\"AC\",\"label_overrides\":[{\"field\":\"C\",\"label\":\"Județe/sectoare\",\"lang\":\"ro\"},{\"field\":\"C\",\"label\":\"County/sector\",\"lang\":\"en\"},{\"field\":\"S\",\"label\":\"Municipiu/oraș/comună\",\"lang\":\"ro\"},{\"field\":\"S\",\"label\":\"Municipality/city/town/commune\",\"lang\":\"en\"}]}");
     map.put("RS", "{\"name\":\"REPUBLIC OF SERBIA\",\"fmt\":\"%N%n%O%n%A%n%Z %C\"}");
     map.put("RU", "{\"name\":\"RUSSIAN FEDERATION\",\"lang\":\"ru\",\"languages\":\"ru\",\"lfmt\":\"%N%n%O%n%A%n%C%n%S%n%Z\",\"fmt\":\"%N%n%O%n%A%n%C%n%S%n%Z\",\"require\":\"ACSZ\",\"upper\":\"AC\",\"state_name_type\":\"oblast\",\"label_overrides\":[{\"field\":\"CS\",\"message\":\"MSG_OFFICE_UNIT_NUMBER\"}]}");
     map.put("RW", "{\"name\":\"RWANDA\",\"upper\":\"AC\"}");

cpp/src/region_data_constants.cc

@@ -155,7 +155,7 @@ const RegionData kRegionData[] = {
       R"("fmt":"%O%n%N%n%A%n%Z %C",)"
       R"("require":"ACZ",)"
       R"("zipex":"4000,1000",)"
-      R"("posturl":"http://www.post.be/site/nl/residential/customerservice/search/postal_codes.html",)"
+      R"("posturl":"https://www.bpost.be/nl/postcodevalidatie-tool",)"
       R"("languages":"nl~fr~de")"
       "}"},
   {"BF", "{"
@@ -221,7 +221,7 @@ const RegionData kRegionData[] = {
   {"BT", "{"
       R"("fmt":"%N%n%O%n%A%n%C %Z",)"
       R"("zipex":"11001,31101,35003",)"
-      R"("posturl":"http://www.bhutanpost.bt/postcodes/",)"
+      R"("posturl":"https://bhutanpost.bt/postcode/",)"
       R"("languages":"dz")"
       "}"},
   {"BV", "{"
@@ -516,7 +516,7 @@ const RegionData kRegionData[] = {
       R"("fmt":"%N%n%O%n%A%n%Z %C",)"
       R"("require":"ACZ",)"
       R"("zipex":"151 24,151 10,101 88",)"
-      R"("posturl":"http://www.elta.gr/findapostcode.aspx",)"
+      R"("posturl":"https://postalcodes.elta.gr",)"
       R"("languages":"el")"
       "}"},
   {"GS", "{"
@@ -611,7 +611,7 @@ const RegionData kRegionData[] = {
       R"("languages":"en~gv")"
       "}"},
   {"IN", "{"
-      R"("fmt":"%N%n%O%n%A%n%C %Z%n%S",)"
+      R"("fmt":"%N%n%O%n%A%n%F%n%L%n%C %Z%n%S",)"
       R"("require":"ACSZ",)"
       R"("zip_name_type":"pin",)"
       R"("state_name_type":"state",)"
@@ -794,7 +794,7 @@ const RegionData kRegionData[] = {
       R"("fmt":"%N%n%O%n%A%n%S%n%C, %Z",)"
       R"("require":"ACZ",)"
       R"("zipex":"LV-1073,LV-1000",)"
-      R"("posturl":"http://www.pasts.lv/lv/uzzinas/nodalas/",)"
+      R"("posturl":"https://pasts.lv/lv/kategorija/pasta_nodalas/",)"
       R"("languages":"lv")"
       "}"},
   {"LY", "{"
@@ -1002,7 +1002,7 @@ const RegionData kRegionData[] = {
       R"("fmt":"%N%n%O%n%A%n%D%n%C %Z",)"
       R"("require":"ACZ",)"
       R"("zipex":"6001,6015,6332,8252,1030",)"
-      R"("posturl":"http://www.nzpost.co.nz/Cultures/en-NZ/OnlineTools/PostCodeFinder/",)"
+      R"("posturl":"https://www.nzpost.co.nz/tools/address-postcode-finder",)"
       R"("languages":"en~mi")"
       "}"},
   {"OM", "{"
@@ -1239,7 +1239,7 @@ const RegionData kRegionData[] = {
   {"SZ", "{"
       R"("fmt":"%N%n%O%n%A%n%C%n%Z",)"
       R"("zipex":"H100",)"
-      R"("posturl":"http://www.sptc.co.sz/swazipost/codes/index.php",)"
+      R"("posturl":"https://www.eswatinipost.co.sz/postcode.php",)"
       R"("languages":"en~ss")"
       "}"},
   {"TA", "{"