Removed numeric territory and alphabet codes

Author: rijnb

src/main/java/com/mapcode/Alphabet.java

@@ -46,45 +46,35 @@ public enum Alphabet {
      */
     private final int number;
 
+    /**
+     * Private constructor.
+     *
+     * @param number Alphabet number, for internal use only.
+     */
     private Alphabet(final int number) {
         this.number = number;
     }
 
-    public int getNumber() {
-        return number;
-    }
-
     /**
-     * Get an alphabet from a numeric code.
+     * Get alphabet number. Package private, for internal use only.
      *
-     * @param number Numeric code.
-     * @return Alphabet.
-     * @throws UnknownAlphabetException Thrown if code out of range.
+     * @return Numeric code.
      */
-    @Nonnull
-    public static Alphabet fromNumber(final int number) throws UnknownAlphabetException {
-        if ((number >= 0) && (number < Alphabet.values().length)) {
-            return Alphabet.values()[number];
-        }
-        throw new UnknownAlphabetException(number);
+    int getNumber() {
+        return number;
     }
 
     /**
      * Return alphabet from a string, which can be a numeric or alpha code.
      *
-     * @param numberOrString Alphabet. May be a numeric or alphanumeric code.
+     * @param alphaCode Alphabet, alphanumeric code.
      * @return Alphabet.
      * @throws UnknownAlphabetException Thrown if incorrect numeric or alphanumeric code.
      */
     @Nonnull
-    public static Alphabet fromString(@Nonnull final String numberOrString) throws UnknownAlphabetException {
-        checkNonnull("numberOrString", numberOrString);
-        final String trimmed = numberOrString.trim().toUpperCase();
-        try {
-            return fromNumber(Integer.valueOf(numberOrString));
-        } catch (final IllegalArgumentException ignored) {
-            // Ignore. Re-try as alpha code.
-        }
+    public static Alphabet fromString(@Nonnull final String alphaCode) throws UnknownAlphabetException {
+        checkNonnull("alphaCode", alphaCode);
+        final String trimmed = alphaCode.trim().toUpperCase();
         try {
             return valueOf(trimmed);
         } catch (final IllegalArgumentException ignored) {

src/main/java/com/mapcode/Decoder.java

@@ -547,7 +547,7 @@ private static String aeuUnpack(final String argStr) {
             if (v2 < 0) {
                 v2 = 31;
             }
-            String s = String.valueOf(1000 + v1 + (32 * v2));
+            final String s = String.valueOf(1000 + v1 + (32 * v2));
             str = s.charAt(1) + str.substring(1, lastpos - 1) + s.charAt(2) + s.charAt(3);
             voweled = true;
         } else if (str.charAt(0) == 'U') { // v.1.50 debug decoding of U+alldigitmapcode
@@ -651,7 +651,7 @@ static String decodeUTF16(final String mapcode) {
         return result;
     }
 
-    static String encodeUTF16(final String mapcode, int alphabetCode) throws IllegalArgumentException {
+    static String encodeUTF16(final String mapcode, final int alphabetCode) throws IllegalArgumentException {
         final String mapcodeToEncode;
         if (ASCII2LANGUAGE[alphabetCode][4] == MISSCODE) {
 

src/main/java/com/mapcode/Encoder.java

@@ -65,8 +65,8 @@ private static List<Mapcode> encode(final double argLatDeg, final double argLonD
                 argLatDeg, argLonDeg, (territory == null) ? null : territory.name(), isRecursive, limitToOneResult,
                 allowWorld);
 
-        double latDeg = Point.mapToLat(argLatDeg);
-        double lonDeg = Point.mapToLon(argLonDeg);
+        final double latDeg = Point.mapToLat(argLatDeg);
+        final double lonDeg = Point.mapToLon(argLonDeg);
         Territory stateOverride = argStateOverride;
 
         final Point pointToEncode = Point.fromDeg(latDeg, lonDeg);

src/main/java/com/mapcode/Territory.java

@@ -580,11 +580,12 @@ public enum Territory {
     private final String[] fullNameAliases;
 
     /**
-     * Return the numeric territory code for a territory.
+     * Return the numeric territory code for a territory. Package private, because territory numbers are no longer
+     * exposed publicly.
      *
      * @return Integer territory code.
      */
-    public int getNumber() {
+    int getNumber() {
         return number;
     }
 
@@ -629,14 +630,15 @@ public String[] getFullNameAliases() {
     }
 
     /**
-     * Return the territory for a specific code.
+     * Return the territory for a specific code. Package private, because territory numbers are no longer exposed
+     * publicly.
      *
      * @param number Numeric territory code.
      * @return Territory.
      * @throws UnknownTerritoryException Thrown if incorrect numeric or alphanumeric code.
      */
     @Nonnull
-    public static Territory fromNumber(final int number) throws UnknownTerritoryException {
+    static Territory fromNumber(final int number) throws UnknownTerritoryException {
         if ((number < 0) || (number >= codeList.size())) {
             throw new UnknownTerritoryException(number);
         }
@@ -656,32 +658,32 @@ public static Territory fromNumber(final int number) throws UnknownTerritoryExce
      *
      * Brazilian mapcodes, on the other hand, would be specified as "BRA BDHP.JK39-1D", using the ISO 3 letter code.
      *
-     * @param numericOrAlpha Territory, may be numeric or alphanumeric code.
+     * @param alphaCode Territory, alphanumeric code.
      * @return Territory.
      * @throws UnknownTerritoryException Thrown if incorrect numeric or alphanumeric code.
      */
     @Nonnull
-    public static Territory fromString(@Nonnull final String numericOrAlpha) throws UnknownTerritoryException {
-        checkNonnull("numericOrAlpha", numericOrAlpha);
-        return createFromString(numericOrAlpha, null);
+    public static Territory fromString(@Nonnull final String alphaCode) throws UnknownTerritoryException {
+        checkNonnull("alphaCode", alphaCode);
+        return createFromString(alphaCode, null);
     }
 
     /**
      * Get a territory from a name, specifying a parent territory for disambiguation.
      *
-     * @param numericOrAlpha  Territory, may be numeric or alphanumeric code. See {@link #fromString(String)}
+     * @param alphaCode       Territory, alphanumeric code. See {@link #fromString(String)}
      *                        for an explanation of the format for this name. (This is NOT strictly an ISO code!)
      * @param parentTerritory Parent territory.
      * @return Territory.
      * @throws UnknownTerritoryException Thrown if the territory is not found given the parentTerritory.
      */
     @Nonnull
     public static Territory fromString(
-            @Nonnull final String numericOrAlpha,
+            @Nonnull final String alphaCode,
             @Nonnull final ParentTerritory parentTerritory) throws UnknownTerritoryException {
-        checkNonnull("numericOrAlpha", numericOrAlpha);
+        checkNonnull("alphaCode", alphaCode);
         checkNonnull("parentTerritory", parentTerritory);
-        return createFromString(numericOrAlpha, parentTerritory);
+        return createFromString(alphaCode, parentTerritory);
     }
 
     /**
@@ -772,7 +774,7 @@ public boolean hasSubdivisions() {
     }
 
     /**
-     * Local constructors to create a territory code.
+     * Private constructors to create a territory code.
      */
     private Territory(
             final int number,
@@ -869,26 +871,18 @@ private Territory(
     /**
      * Get a territory from a name, specifying a parent territory for disambiguation.
      *
-     * @param numericOrAlpha  Territory name.
+     * @param alphaCode       Territory, alphanumeric code.
      * @param parentTerritory Parent territory.
      * @return Territory.
      * @throws UnknownTerritoryException Thrown if the territory is not found.
      */
     @Nonnull
     private static Territory createFromString(
-            @Nonnull final String numericOrAlpha,
+            @Nonnull final String alphaCode,
             @Nullable final ParentTerritory parentTerritory) throws UnknownTerritoryException {
-        final String trimmed = Mapcode.convertStringToPlainAscii(numericOrAlpha.trim().replace('_', '-')).toUpperCase();
-
-        // First, try as numeric code.
-        try {
-            final Integer territoryCode = Integer.valueOf(trimmed);
-            return fromNumber(territoryCode);
-        } catch (final NumberFormatException ignored) {
-            // Re-try as alpha code.
-        }
+        final String trimmed = Mapcode.convertStringToPlainAscii(alphaCode.trim().replace('_', '-')).toUpperCase();
 
-        // Now, try as alpha code.
+        // Try as alpha code.
         final List<Territory> territories = nameMap.get(trimmed);
         if (territories != null) {
             if (parentTerritory == null) {

src/site/apt/ReleaseNotes.apt.vm

@@ -13,6 +13,8 @@ Release Notes (Version ${project.version})
 
     * Fixes to the data rectangles (primarily intended for ISO proposal).
 
+    * Removed functionality to use numeric territory codes; only alpha codes are accepted.
+
     * Note that this release only allows high-precision mapcodes up to 2 additional suffix characters.
     A future release will be scheduled to allow up to 8 suffix characters (nanometer accuracy).
 

src/test/java/com/mapcode/AlphabetTest.java

@@ -47,15 +47,19 @@ public void testConvertToAlphabet() throws Exception {
     public void testFromString() throws Exception {
         LOG.info("testFromString");
         assertEquals(Alphabet.ROMAN, Alphabet.fromString("ROMAN"));
-        assertEquals(Alphabet.ROMAN, Alphabet.fromString("0"));
         assertEquals(Alphabet.ROMAN, Alphabet.fromString("roman"));
 
         for (final Alphabet alphabet : Alphabet.values()) {
             assertEquals(alphabet, Alphabet.fromString(alphabet.toString()));
-            assertEquals(alphabet, Alphabet.fromString(String.valueOf(alphabet.getNumber())));
         }
     }
 
+    @Test(expected = UnknownAlphabetException.class)
+    public void testFromStringNumeric() throws Exception {
+        LOG.info("testFromStringNumeric");
+        assertEquals(Alphabet.ROMAN, Alphabet.fromString("0"));
+    }
+
     @Test(expected = IllegalArgumentException.class)
     public void testFromStringError1() {
         LOG.info("testFromStringError1");

src/test/java/com/mapcode/TerritoryTest.java

@@ -34,28 +34,6 @@ public void emptyTerritoryCodeTest() throws Exception {
         Territory.fromString("");
     }
 
-    @Test
-    public void checkAlphabetCode() throws Exception {
-        LOG.info("checkAlphabetCode");
-        int i = 0;
-        for (final Alphabet alphabet : Alphabet.values()) {
-            assertEquals(alphabet, Alphabet.fromNumber(i));
-            ++i;
-        }
-    }
-
-    @Test(expected = UnknownAlphabetException.class)
-    public void checkAlphabetCodeError1() throws Exception {
-        LOG.info("checkAlphabetCodeError1");
-        Alphabet.fromNumber(-1);
-    }
-
-    @Test(expected = UnknownAlphabetException.class)
-    public void checkAlphabetCodeError2() throws Exception {
-        LOG.info("checkAlphabetCodeError2");
-        Alphabet.fromNumber(Alphabet.values().length);
-    }
-
     @Test
     public void checkDash() throws Exception {
         LOG.info("checkDash");
@@ -84,8 +62,8 @@ public void disambiguateMNTest2() throws Exception {
     }
 
     @Test
-    public void territoryFromStringTest() throws Exception {
-        LOG.info("territoryFromStringTest");
+    public void testTerritoryFromString() throws Exception {
+        LOG.info("testTerritoryFromString");
 
         // Accept ISO-style codes.
         assertEquals(Territory.NLD, Territory.fromString("NLD"));
@@ -106,17 +84,17 @@ public void territoryFromStringTest() throws Exception {
         assertEquals(Territory.USA, Territory.fromString("USA"));
         assertEquals(Territory.USA, Territory.fromString("US"));
 
-        // Accept numeric codes as well.
-        assertEquals(Territory.VAT, Territory.fromString("0"));
-        assertEquals(Territory.AAA, Territory.fromString("532"));
-        assertEquals(Territory.NLD, Territory.fromString("112"));
-
         for (final Territory territory : Territory.values()) {
             assertEquals(territory, Territory.fromString(territory.toString()));
-            assertEquals(territory, Territory.fromString(String.valueOf(territory.getNumber())));
         }
     }
 
+    @Test(expected = UnknownTerritoryException.class)
+    public void testTerritoryFromStringNumeric() throws Exception {
+        LOG.info("testTerritoryFromStringNumeric");
+        assertEquals(Territory.VAT, Territory.fromString("0"));
+    }
+
     @Test
     public void checkAlphabet() throws Exception {
         LOG.info("checkAlphabet");