changeset 16212:0ceaa5dc89ec

8071929: Locale.getISOCountries() has inconsistent behaviour for "AN", "BU" and "CS" country codes. Reviewed-by: naoto
author rgoel
date Wed, 07 Dec 2016 11:35:12 +0530
parents f22652e8f85f
children df8bc808aeb9
files src/java.base/share/classes/java/util/Locale.java src/java.base/share/classes/java/util/LocaleISOData.java test/java/util/Locale/Bug8071929.java
diffstat 3 files changed, 258 insertions(+), 3 deletions(-) [+]
line wrap: on
line diff
--- a/src/java.base/share/classes/java/util/Locale.java	Tue Dec 06 17:49:44 2016 -0800
+++ b/src/java.base/share/classes/java/util/Locale.java	Wed Dec 07 11:35:12 2016 +0530
@@ -46,6 +46,7 @@
 import java.io.ObjectStreamField;
 import java.io.Serializable;
 import java.text.MessageFormat;
+import java.util.concurrent.ConcurrentHashMap;
 import java.util.spi.LocaleNameProvider;
 
 import sun.security.action.GetPropertyAction;
@@ -600,6 +601,68 @@
     static final long serialVersionUID = 9149081749638150636L;
 
     /**
+     * Enum for specifying the type defined in ISO 3166. This enum is used to
+     * retrieve the two-letter ISO3166-1 alpha-2, three-letter ISO3166-1
+     * alpha-3, four-letter ISO3166-3 country codes.
+     *
+     * @see #getISOCountries(Locale.IsoCountryCode)
+     * @since 9
+     */
+    public static enum IsoCountryCode {
+        /**
+         * PART1_ALPHA2 is used to represent the ISO3166-1 alpha-2 two letter
+         * country codes.
+         */
+        PART1_ALPHA2 {
+            @Override
+            Set<String> createCountryCodeSet() {
+                return Set.of(Locale.getISOCountries());
+            }
+        },
+
+        /**
+         *
+         * PART1_ALPHA3 is used to represent the ISO3166-1 alpha-3 three letter
+         * country codes.
+         */
+        PART1_ALPHA3 {
+            @Override
+            Set<String> createCountryCodeSet() {
+                return LocaleISOData.computeISO3166_1Alpha3Countries();
+            }
+        },
+
+        /**
+         * PART3 is used to represent the ISO3166-3 four letter country codes.
+         */
+        PART3 {
+            @Override
+            Set<String> createCountryCodeSet() {
+                return Set.of(LocaleISOData.ISO3166_3);
+            }
+        };
+
+        /**
+         * Concrete implementation of this method attempts to compute value
+         * for iso3166CodesMap for each IsoCountryCode type key.
+         */
+        abstract Set<String> createCountryCodeSet();
+
+        /**
+         * Map to hold country codes for each ISO3166 part.
+         */
+        private static Map<IsoCountryCode, Set<String>> iso3166CodesMap = new ConcurrentHashMap<>();
+
+        /**
+         * This method is called from Locale class to retrieve country code set
+         * for getISOCountries(type)
+         */
+        static Set<String> retrieveISOCountryCodes(IsoCountryCode type) {
+            return iso3166CodesMap.computeIfAbsent(type, IsoCountryCode::createCountryCodeSet);
+        }
+    }
+
+    /**
      * Display types for retrieving localized names from the name providers.
      */
     private static final int DISPLAY_LANGUAGE = 0;
@@ -996,12 +1059,18 @@
     /**
      * Returns a list of all 2-letter country codes defined in ISO 3166.
      * Can be used to create Locales.
+     * This method is equivalent to {@link #getISOCountries(Locale.IsoCountryCode type)}
+     * with {@code type}  {@link IsoCountryCode#PART1_ALPHA2}.
      * <p>
      * <b>Note:</b> The <code>Locale</code> class also supports other codes for
      * country (region), such as 3-letter numeric UN M.49 area codes.
      * Therefore, the list returned by this method does not contain ALL valid
      * codes that can be used to create Locales.
-     *
+     * <p>
+     * Note that this method does not return obsolete 2-letter country codes.
+     * ISO3166-3 codes which designate country codes for those obsolete codes,
+     * can be retrieved from {@link #getISOCountries(Locale.IsoCountryCode type)} with
+     * {@code type}  {@link IsoCountryCode#PART3}.
      * @return An array of ISO 3166 two-letter country codes.
      */
     public static String[] getISOCountries() {
@@ -1014,6 +1083,20 @@
     }
 
     /**
+     * Returns a {@code Set} of ISO3166 country codes for the specified type.
+     *
+     * @param type {@link Locale.IsoCountryCode} specified ISO code type.
+     * @see java.util.Locale.IsoCountryCode
+     * @throws NullPointerException if type is null
+     * @return a {@code Set} of ISO country codes for the specified type.
+     * @since 9
+     */
+    public static Set<String> getISOCountries(IsoCountryCode type) {
+        Objects.requireNonNull(type);
+        return IsoCountryCode.retrieveISOCountryCodes(type);
+    }
+
+    /**
      * Returns a list of all 2-letter language codes defined in ISO 639.
      * Can be used to create Locales.
      * <p>
--- a/src/java.base/share/classes/java/util/LocaleISOData.java	Tue Dec 06 17:49:44 2016 -0800
+++ b/src/java.base/share/classes/java/util/LocaleISOData.java	Wed Dec 07 11:35:12 2016 +0530
@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2005, 2013, Oracle and/or its affiliates. All rights reserved.
+ * Copyright (c) 2005, 2016, Oracle and/or its affiliates. All rights reserved.
  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
  *
  * This code is free software; you can redistribute it and/or modify it
@@ -231,7 +231,7 @@
         + "AI" + "AIA"  // Anguilla
         + "AL" + "ALB"  // Albania, People's Socialist Republic of
         + "AM" + "ARM"  // Armenia
-        + "AN" + "ANT"  // Netherlands Antilles
+//      + "AN" + "ANT"  // Netherlands Antilles
         + "AO" + "AGO"  // Angola, Republic of
         + "AQ" + "ATA"  // Antarctica (the territory South of 60 deg S)
         + "AR" + "ARG"  // Argentina, Argentine Republic
@@ -477,6 +477,29 @@
         + "ZW" + "ZWE"  // Zimbabwe
         ;
 
+    /**
+     * Array to hold country codes for ISO3166-3.
+     */
+    static final String[] ISO3166_3 = {
+        "AIDJ", "ANHH", "BQAQ", "BUMM", "BYAA", "CSHH", "CSXX", "CTKI", "DDDE",
+        "DYBJ", "FQHH", "FXFR", "GEHH", "HVBF", "JTUM", "MIUM", "NHVU", "NQAQ",
+        "NTHH", "PCHH", "PUUM", "PZPA", "RHZW", "SKIN", "SUHH", "TPTL", "VDVN",
+        "WKUM", "YDYE", "YUCS", "ZRCD"
+    };
+
+    /**
+     * This method computes a set of ISO3166-1 alpha-3 country codes from
+     * existing isoCountryTable.
+     */
+    static Set<String> computeISO3166_1Alpha3Countries() {
+        int tableLength = isoCountryTable.length();
+        String[] isoTable = new String[tableLength / 5];
+        for (int i = 0, index = 0; index < tableLength; i++, index += 5) {
+            isoTable[i] = isoCountryTable.substring(index + 2, index + 5);
+        }
+        return Set.of(isoTable);
+    }
+
     private LocaleISOData() {
     }
 }
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/test/java/util/Locale/Bug8071929.java	Wed Dec 07 11:35:12 2016 +0530
@@ -0,0 +1,149 @@
+/*
+ * Copyright (c) 2016, Oracle and/or its affiliates. All rights reserved.
+ * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
+ *
+ * This code is free software; you can redistribute it and/or modify it
+ * under the terms of the GNU General Public License version 2 only, as
+ * published by the Free Software Foundation.
+ *
+ * This code is distributed in the hope that it will be useful, but WITHOUT
+ * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
+ * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
+ * version 2 for more details (a copy is included in the LICENSE file that
+ * accompanied this code).
+ *
+ * You should have received a copy of the GNU General Public License version
+ * 2 along with this work; if not, write to the Free Software Foundation,
+ * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
+ *
+ * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
+ * or visit www.oracle.com if you need additional information or have any
+ * questions.
+ */
+
+/*
+ * @test
+ * @bug 8071929
+ * @summary Test obsolete ISO3166-1 alpha-2 country codes should not be retrieved.
+ * ISO3166-1 alpha-2, ISO3166-1 alpha-3, ISO3166-3 country codes
+ * from overloaded getISOCountries(Iso3166 type) are retrieved correctly.
+ */
+import java.util.HashSet;
+import java.util.List;
+import java.util.Locale;
+import java.util.Locale.IsoCountryCode;
+import java.util.Set;
+import java.util.stream.Collectors;
+
+public class Bug8071929 {
+
+    private static final List<String> ISO3166_1_ALPHA2_OBSOLETE_CODES = List.of("AN", "BU", "CS",
+            "NT", "SF", "TP", "YU", "ZR");
+
+    private static final Set<String> ISO3166_3EXPECTED = Set.of(
+            "AIDJ", "ANHH", "BQAQ", "BUMM", "BYAA", "CSHH", "CSXX", "CTKI", "DDDE",
+            "DYBJ", "FQHH", "FXFR", "GEHH", "HVBF", "JTUM", "MIUM", "NHVU", "NQAQ",
+            "NTHH", "PCHH", "PUUM", "PZPA", "RHZW", "SKIN", "SUHH", "TPTL", "VDVN",
+            "WKUM", "YDYE", "YUCS", "ZRCD");
+
+    private static final Set<String> ISO3166_1_ALPHA3_EXPECTED
+            = Set.of("ABW", "AFG", "AGO", "AIA", "ALA", "ALB", "AND",
+                    "ARE", "ARG", "ARM", "ASM", "ATA", "ATF", "ATG",
+                    "AUS", "AUT", "AZE", "BDI", "BEL", "BEN", "BES", "BFA",
+                    "BGD", "BGR", "BHR", "BHS", "BIH", "BLM", "BLR", "BLZ",
+                    "BMU", "BOL", "BRA", "BRB", "BRN", "BTN", "BVT", "BWA", "CAF", "CAN",
+                    "CCK", "CHE", "CHL", "CHN", "CIV", "CMR", "COD", "COG", "COK", "COL",
+                    "COM", "CPV", "CRI", "CUB", "CUW", "CXR", "CYM", "CYP", "CZE", "DEU",
+                    "DJI", "DMA", "DNK", "DOM", "DZA", "ECU", "EGY", "ERI", "ESH", "ESP",
+                    "EST", "ETH", "FIN", "FJI", "FLK", "FRA", "FRO", "FSM", "GAB", "GBR",
+                    "GEO", "GGY", "GHA", "GIB", "GIN", "GLP", "GMB", "GNB", "GNQ",
+                    "GRC", "GRD", "GRL", "GTM", "GUF", "GUM", "GUY", "HKG", "HMD", "HND",
+                    "HRV", "HTI", "HUN", "IDN", "IMN", "IND", "IOT", "IRL", "IRN", "IRQ",
+                    "ISL", "ISR", "ITA", "JAM", "JEY", "JOR", "JPN", "KAZ", "KEN", "KGZ",
+                    "KHM", "KIR", "KNA", "KOR", "KWT", "LAO", "LBN", "LBR", "LBY", "LCA",
+                    "LIE", "LKA", "LSO", "LTU", "LUX", "LVA", "MAC", "MAF", "MAR", "MCO",
+                    "MDA", "MDG", "MDV", "MEX", "MHL", "MKD", "MLI", "MLT", "MMR", "MNE",
+                    "MNG", "MNP", "MOZ", "MRT", "MSR", "MTQ", "MUS", "MWI", "MYS", "MYT",
+                    "NAM", "NCL", "NER", "NFK", "NGA", "NIC", "NIU", "NLD", "NOR", "NPL",
+                    "NRU", "NZL", "OMN", "PAK", "PAN", "PCN", "PER", "PHL", "PLW", "PNG",
+                    "POL", "PRI", "PRK", "PRT", "PRY", "PSE", "PYF", "QAT", "REU", "ROU",
+                    "RUS", "RWA", "SAU", "SDN", "SEN", "SGP", "SGS", "SHN", "SJM", "SLB",
+                    "SLE", "SLV", "SMR", "SOM", "SPM", "SRB", "SSD", "STP", "SUR", "SVK",
+                    "SVN", "SWE", "SWZ", "SXM", "SYC", "SYR", "TCA", "TCD", "TGO", "THA",
+                    "TJK", "TKL", "TKM", "TLS", "TON", "TTO", "TUN", "TUR", "TUV", "TWN",
+                    "TZA", "UGA", "UKR", "UMI", "URY", "USA", "UZB", "VAT", "VCT", "VEN",
+                    "VGB", "VIR", "VNM", "VUT", "WLF", "WSM", "YEM", "ZAF", "ZMB", "ZWE");
+
+    /**
+     * This method checks that obsolete ISO3166-1 alpha-2 country codes are not
+     * retrieved in output of getISOCountries() method.
+     */
+    private static void checkISO3166_1_Alpha2ObsoleteCodes() {
+        Set<String> unexpectedCodes = ISO3166_1_ALPHA2_OBSOLETE_CODES.stream().
+                filter(Set.of(Locale.getISOCountries())::contains).collect(Collectors.toSet());
+        if (!unexpectedCodes.isEmpty()) {
+            throw new RuntimeException("Obsolete ISO3166-1 alpha2 two letter"
+                    + " country Codes " + unexpectedCodes + " in output of getISOCountries() method");
+        }
+    }
+
+    /**
+     * This method checks that ISO3166-3 country codes which are PART3 of
+     * IsoCountryCode enum, are retrieved correctly.
+     */
+    private static void checkISO3166_3Codes() {
+        Set<String> iso3166_3Codes = Locale.getISOCountries(IsoCountryCode.PART3);
+        if (!iso3166_3Codes.equals(ISO3166_3EXPECTED)) {
+            reportDifference(iso3166_3Codes, ISO3166_3EXPECTED);
+        }
+    }
+
+    /**
+     * This method checks that ISO3166-1 alpha-3 country codes which are
+     * PART1_ALPHA3 of IsoCountryCode enum, are retrieved correctly.
+     */
+    private static void checkISO3166_1_Alpha3Codes() {
+        Set<String> iso3166_1_Alpha3Codes = Locale.getISOCountries(IsoCountryCode.PART1_ALPHA3);
+        if (!iso3166_1_Alpha3Codes.equals(ISO3166_1_ALPHA3_EXPECTED)) {
+            reportDifference(iso3166_1_Alpha3Codes, ISO3166_1_ALPHA3_EXPECTED);
+        }
+    }
+
+    /**
+     * This method checks that ISO3166-1 alpha-2 country codes, which are
+     * PART1_ALPHA2 of IsoCountryCode enum, are retrieved correctly.
+     */
+    private static void checkISO3166_1_Alpha2Codes() {
+        Set<String> iso3166_1_Alpha2Codes = Locale.getISOCountries(IsoCountryCode.PART1_ALPHA2);
+        Set<String> ISO3166_1_ALPHA2_EXPECTED = Set.of(Locale.getISOCountries());
+        if (!iso3166_1_Alpha2Codes.equals(ISO3166_1_ALPHA2_EXPECTED)) {
+            reportDifference(iso3166_1_Alpha2Codes, ISO3166_1_ALPHA2_EXPECTED);
+        }
+    }
+
+    private static void reportDifference(Set<String> retrievedCountrySet, Set<String> expectedCountrySet) {
+        Set<String> retrievedSet = new HashSet<>(retrievedCountrySet);
+        Set<String> expectedSet = new HashSet<>(expectedCountrySet);
+        retrievedSet.removeAll(expectedCountrySet);
+        expectedSet.removeAll(retrievedCountrySet);
+        if ((retrievedSet.size() > 0) && (expectedSet.size() > 0)) {
+            throw new RuntimeException("Retrieved country codes set contains extra codes "
+                    + retrievedSet + " and missing codes " + expectedSet);
+        }
+        if (retrievedSet.size() > 0) {
+            throw new RuntimeException("Retrieved country codes set contains extra codes "
+                    + retrievedSet);
+        }
+        if (expectedSet.size() > 0) {
+            throw new RuntimeException("Retrieved country codes set is missing codes "
+                    + expectedSet);
+        }
+    }
+
+    public static void main(String[] args) {
+        checkISO3166_1_Alpha2ObsoleteCodes();
+        checkISO3166_1_Alpha2Codes();
+        checkISO3166_1_Alpha3Codes();
+        checkISO3166_3Codes();
+    }
+}