Renamed getMapcodeMedium/HighPrecision to getMapcodePrecision1/2

Author: rijnb

README.md

@@ -4,8 +4,8 @@ Copyright (C) 2014 Stichting Mapcode Foundation (http://www.mapcode.com)
 
 ----
 
-This Java project contains a library to encode latitude/longitude pairs to Mapcodes
-and to decode Mapcodes back to latitude/longitude pairs.
+This Java project contains a library to encode latitude/longitude pairs to mapcodes
+and to decode mapcodes back to latitude/longitude pairs.
 
 **Online documentation can be found at: http://mapcode-foundation.github.io/mapcode-java/**
 
@@ -28,5 +28,5 @@ See the License for the specific language governing permissions and
 limitations under the License.
 
 Original C library created by Pieter Geelen. Work on Java version
-of the Mapcode library by Rijn Buve and Matthew Lowden.
+of the mapcode library by Rijn Buve and Matthew Lowden.
 

pom.xml

@@ -12,7 +12,7 @@
 
     <name>Mapcode Java Library</name>
     <description>
-        This library offers Java support for Mapcode.
+        This library offers Java support for mapcodes.
         For more info: http://www.mapcode.com
     </description>
 

src/main/java/com/mapcode/Mapcode.java

@@ -20,32 +20,37 @@
 import java.util.Arrays;
 
 /**
- * This class defines a single Mapcode encoding result, including the Mapcode itself and the
+ * This class defines a single mapcode encoding result, including the mapcode itself and the
  * territory definition.
  */
 public final class Mapcode {
     @Nonnull private final String    mapcode;
-    @Nonnull private final String    mapcodeHighPrecision;
-    @Nonnull private final String    mapcodeMediumPrecision;
+    @Nonnull private final String    mapcodePrecision1;
+    @Nonnull private final String    mapcodePrecision2;
     @Nonnull private final Territory territory;
 
     public Mapcode(
         @Nonnull final String mapcode,
         @Nonnull final Territory territory) {
-        this.mapcodeHighPrecision = mapcode;
+        this.mapcodePrecision2 = mapcode;
         if (mapcode.contains("-")) {
             this.mapcode = mapcode.substring(0, mapcode.length() - 3);
-            this.mapcodeMediumPrecision = mapcode.substring(0, mapcode.length() - 1);
+            this.mapcodePrecision1 = mapcode.substring(0, mapcode.length() - 1);
         }
         else {
             this.mapcode = mapcode;
-            this.mapcodeMediumPrecision = mapcode;
+            this.mapcodePrecision1 = mapcode;
         }
         this.territory = territory;
     }
 
     /**
-     * Get the Mapcode string (without territory information).
+     * Get the Mapcode string (without territory information) with standard precision.
+     * The returned mapcode does not include the '-' separator and additional digits.
+     *
+     * The returned precision is approximately 5 meters. The precision is defined as the maximum distance to the
+     * (latitude, longitude) pair that encoded to this mapcode, which means the mapcode defines an area of
+     * approximately 10 x 10 meters (100 m2).
      *
      * @return Mapcode string.
      */
@@ -55,25 +60,63 @@ public String getMapcode() {
     }
 
     /**
-     * Get the high-precision Mapcode string (without territory information).
-     * If a high precision code is not available, the regular Mapcode is returned.
+     * Alias for {@link #getMapcode}.
      *
-     * @return High Precision Mapcode string.
+     * @return Mapcode string.
      */
     @Nonnull
-    public String getMapcodeHighPrecision() {
-        return mapcodeHighPrecision;
+    public String getMapcodePrecision0() {
+        return mapcode;
     }
 
     /**
-     * Get the medium-precision Mapcode string (without territory information).
-     * If a medium precision code is not available, the regular Mapcode is returned.
+     * Get the medium-precision mapcode string (without territory information).
+     * The returned mapcode includes the '-' separator and 1 additional digit, if available.
+     * If a medium precision code is not available, the regular mapcode is returned.
+     *
+     * The returned precision is approximately 1 meter. The precision is defined as the maximum distance to the
+     * (latitude, longitude) pair that encoded to this mapcode, which means the mapcode defines an area of
+     * approximately 2 x 2 meters (4 m2).
      *
-     * @return Medium Precision Mapcode string.
+     * @return Medium precision mapcode string.
+     */
+    @Nonnull
+    public String getMapcodePrecision1() {
+        return mapcodePrecision1;
+    }
+
+    /**
+     * Deprecated alias for {@link #getMapcodePrecision1}.
      */
+    @Deprecated
     @Nonnull
     public String getMapcodeMediumPrecision() {
-        return mapcodeMediumPrecision;
+        return mapcodePrecision1;
+    }
+
+    /**
+     * Get the high-precision mapcode string (without territory information).
+     * The returned mapcode includes the '-' separator and 2 additional digit2, if available.
+     * If a high precision code is not available, the regular mapcode is returned.
+     *
+     * The returned precision is approximately 16 centimeters. The precision is defined as the maximum distance to the
+     * (latitude, longitude) pair that encoded to this mapcode, which means the mapcode defines an area of
+     * approximately 32 x 32 centimeters (0.1 m2).
+     *
+     * @return High precision mapcode string.
+     */
+    @Nonnull
+    public String getMapcodePrecision2() {
+        return mapcodePrecision2;
+    }
+
+    /**
+     * Deprecated alias for {@see #getMapcodePrecision2}.
+     */
+    @Deprecated
+    @Nonnull
+    public String getMapcodeHighPrecision() {
+        return mapcodePrecision2;
     }
 
     /**
@@ -92,36 +135,36 @@ public int hashCode() {
     }
 
     /**
-     * Return the local Mapcode string, potentially ambiguous.
+     * Return the local mapcode string, potentially ambiguous.
      *
      * Example:
      * 49.4V
      *
-     * @return Local Mapcode.
+     * @return Local mapcode.
      */
     @Nonnull
     public String asLocal() {
         return mapcode;
     }
 
     /**
-     * Return the full international Mapcode, including the full name of the territory and the Mapcode itself.
+     * Return the full international mapcode, including the full name of the territory and the Mapcode itself.
      * The format of the code is:
      * full-territory-name mapcode
      *
      * Example:
      * Netherlands 49.4V           (regular code)
      * Netherlands 49.4V-K2        (high precision code)
      *
-     * @return Full international Mapcode.
+     * @return Full international mapcode.
      */
     @Nonnull
     public String asInternationalFullName() {
         return territory.getFullName() + ' ' + mapcode;
     }
 
     /**
-     * Return the international Mapcode as a shorter version using the ISO territory codes where possible.
+     * Return the international mapcode as a shorter version using the ISO territory codes where possible.
      * International codes use a territory code "AAA".
      * The format of the code is:
      * short-territory-name mapcode
@@ -130,7 +173,7 @@ public String asInternationalFullName() {
      * NLD 49.4V                   (regular code)
      * NLD 49.4V-K2                (high-precision code)
      *
-     * @return Short-hand international Mapcode.
+     * @return Short-hand international mapcode.
      */
     @Nonnull
     public String asInternationalISO() {
@@ -155,4 +198,3 @@ public boolean equals(final Object obj) {
         return mapcode.equals(that.mapcode) && (this.territory.equals(that.territory));
     }
 }
-