Skip to content

Commit ea802e5

Browse files
rijnbrijnb
committed
Version 1.50.0
1 parent 3209671 commit ea802e5

13 files changed

Lines changed: 105 additions & 83 deletions

‎ReleaseNotes.html‎

Lines changed: 37 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
2-
<!-- Generated by Apache Maven Doxia Site Renderer 1.4 at 2015-05-05 -->
2+
<!-- Generated by Apache Maven Doxia Site Renderer 1.4 at 2015-05-22 -->
33
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
44
<head>
55
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8" />
@@ -10,7 +10,7 @@
1010
@import url("./css/site.css");
1111
</style>
1212
<link rel="stylesheet" href="./css/print.css" type="text/css" media="print" />
13-
<meta name="Date-Revision-yyyymmdd" content="20150505" />
13+
<meta name="Date-Revision-yyyymmdd" content="20150522" />
1414
<meta http-equiv="Content-Language" content="en" />
1515

1616
</head>
@@ -27,8 +27,8 @@
2727

2828

2929
<div class="xleft">
30-
<span id="publishDate">Last Published: 2015-05-05</span>
31-
&nbsp;| <span id="projectVersion">Version: 1.42</span>
30+
<span id="publishDate">Last Published: 2015-05-22</span>
31+
&nbsp;| <span id="projectVersion">Version: 1.50.1-SNAPSHOT</span>
3232
</div>
3333
<div class="xright">
3434

@@ -66,8 +66,40 @@ <h5>Project Documentation</h5>
6666
<div id="bodyColumn">
6767
<div id="contentBox">
6868
<div class="section">
69-
<h2>Release Notes (Version 1.42)<a name="Release_Notes_Version_1.42"></a></h2>
69+
<h2>Release Notes (Version 1.50.1-SNAPSHOT)<a name="Release_Notes_Version_1.50.1-SNAPSHOT"></a></h2>
7070
<p>These are the release notes for the Java library for mapcodes.</p>
71+
<p><b>IMPORTANT: This is a SNAPSHOT version of the repository which may change at any time. Needless to say, never depend on &lt;&lt;&lt;SNAPSHOT</b>&gt; versions if you can avoid it. In any case, never depend on them for your own non-<tt>SNAPSHOT</tt> releases.</p>
72+
<div class="section">
73+
<h3>1.50.1<a name="a1.50.1"></a></h3>
74+
<ul>
75+
<li>To do.</li></ul></div>
76+
<div class="section">
77+
<h3>1.50.0<a name="a1.50.0"></a></h3>
78+
<ul>
79+
<li>Major release. This version is not backwards compatible with mapcode 1.4x: is has dropped support for Antartica AT0-8 codes and has a changed (improved) way of dealing with the Greek alphabet.</li>
80+
<li>Added 22-chararcter post-processing of all-digit mapcodes for the Greek alphabet.</li>
81+
<li>Retired legacy aliases EAZ and SKM, AU-QL, AU-TS, AU-NI and AU-JB.</li>
82+
<li>Retired legacy Antarctica claims AT0 through AT8.</li>
83+
<li>Added convencience methods for <tt>MapcodeCodec</tt> to accept <tt>Point</tt> for all encode functions as well (not just <tt>latDeg</tt>, <tt>lonDeg</tt>).</li>
84+
<li>Added alphabet support to convert mapcodes (both codes and territories) between <tt>Alphabet</tt>s.</li>
85+
<li>Exceptions have been corrected and documented in code.</li>
86+
<li>Allowed nullable values in <tt>MapcodeCodec</tt> encode and decode methods to assume reasonable defaults.</li>
87+
<li>Microdegrees are no longer support publicly in <tt>Point</tt>. Only degrees.</li>
88+
<li>Latitudes are limited to -90..90 and longitudes are wrapped to -180..180 (non inclusive).</li></ul></div>
89+
<div class="section">
90+
<h3>1.42.3<a name="a1.42.3"></a></h3>
91+
<ul>
92+
<li>To be done.</li></ul></div>
93+
<div class="section">
94+
<h3>1.42.2<a name="a1.42.2"></a></h3>
95+
<ul>
96+
<li>Upper- and lowercase mapcodes always allowed.</li></ul></div>
97+
<div class="section">
98+
<h3>1.42.1<a name="a1.42.1"></a></h3>
99+
<ul>
100+
<li>Cleaned up source. Removed all pending IntelliJ IDEA inspection warnings and reformatted code using default IDEA code style to maintain consistent layout.</li>
101+
<li>Add additional unit tests to check for correct handling of international mapcode handling.</li>
102+
<li>Added safe constants for the maximum delta distance in meters for mapcode accuracy.</li></ul></div>
71103
<div class="section">
72104
<h3>1.42<a name="a1.42"></a></h3>
73105
<ul>

‎dependencies.html‎

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
2-
<!-- Generated by Apache Maven Doxia Site Renderer 1.4 at 2015-05-05 -->
2+
<!-- Generated by Apache Maven Doxia Site Renderer 1.4 at 2015-05-22 -->
33
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
44
<head>
55
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8" />
@@ -10,7 +10,7 @@
1010
@import url("./css/site.css");
1111
</style>
1212
<link rel="stylesheet" href="./css/print.css" type="text/css" media="print" />
13-
<meta name="Date-Revision-yyyymmdd" content="20150505" />
13+
<meta name="Date-Revision-yyyymmdd" content="20150522" />
1414
<meta http-equiv="Content-Language" content="en" />
1515

1616
</head>
@@ -27,8 +27,8 @@
2727

2828

2929
<div class="xleft">
30-
<span id="publishDate">Last Published: 2015-05-05</span>
31-
&nbsp;| <span id="projectVersion">Version: 1.42</span>
30+
<span id="publishDate">Last Published: 2015-05-22</span>
31+
&nbsp;| <span id="projectVersion">Version: 1.50.1-SNAPSHOT</span>
3232
</div>
3333
<div class="xright">
3434

@@ -212,7 +212,7 @@ <h2>Project Dependency Graph<a name="Project_Dependency_Graph"></a></h2><script
212212
<div class="section">
213213
<h3>Dependency Tree<a name="Dependency_Tree"></a></h3>
214214
<ul>
215-
<li>com.mapcode:mapcode:jar:1.42 <img id="_img1" src="./images/icon_info_sml.gif" alt="Information" onclick="toggleDependencyDetail( '_dep0', '_img1' );" style="cursor: pointer;vertical-align:text-bottom;"></img><div id="_dep0" style="display:none">
215+
<li>com.mapcode:mapcode:jar:1.50.1-SNAPSHOT <img id="_img1" src="./images/icon_info_sml.gif" alt="Information" onclick="toggleDependencyDetail( '_dep0', '_img1' );" style="cursor: pointer;vertical-align:text-bottom;"></img><div id="_dep0" style="display:none">
216216
<table border="0" class="bodyTable">
217217
<tr class="a">
218218
<th>Mapcode Java Library</th></tr>

‎dependency-convergence.html‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
2-
<!-- Generated by Apache Maven Doxia Site Renderer 1.4 at 2015-05-05 -->
2+
<!-- Generated by Apache Maven Doxia Site Renderer 1.4 at 2015-05-22 -->
33
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
44
<head>
55
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8" />
@@ -10,7 +10,7 @@
1010
@import url("./css/site.css");
1111
</style>
1212
<link rel="stylesheet" href="./css/print.css" type="text/css" media="print" />
13-
<meta name="Date-Revision-yyyymmdd" content="20150505" />
13+
<meta name="Date-Revision-yyyymmdd" content="20150522" />
1414
<meta http-equiv="Content-Language" content="en" />
1515

1616
</head>
@@ -27,8 +27,8 @@
2727

2828

2929
<div class="xleft">
30-
<span id="publishDate">Last Published: 2015-05-05</span>
31-
&nbsp;| <span id="projectVersion">Version: 1.42</span>
30+
<span id="publishDate">Last Published: 2015-05-22</span>
31+
&nbsp;| <span id="projectVersion">Version: 1.50.1-SNAPSHOT</span>
3232
</div>
3333
<div class="xright">
3434

‎dependency-info.html‎

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
2-
<!-- Generated by Apache Maven Doxia Site Renderer 1.4 at 2015-05-05 -->
2+
<!-- Generated by Apache Maven Doxia Site Renderer 1.4 at 2015-05-22 -->
33
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
44
<head>
55
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8" />
@@ -10,7 +10,7 @@
1010
@import url("./css/site.css");
1111
</style>
1212
<link rel="stylesheet" href="./css/print.css" type="text/css" media="print" />
13-
<meta name="Date-Revision-yyyymmdd" content="20150505" />
13+
<meta name="Date-Revision-yyyymmdd" content="20150522" />
1414
<meta http-equiv="Content-Language" content="en" />
1515

1616
</head>
@@ -27,8 +27,8 @@
2727

2828

2929
<div class="xleft">
30-
<span id="publishDate">Last Published: 2015-05-05</span>
31-
&nbsp;| <span id="projectVersion">Version: 1.42</span>
30+
<span id="publishDate">Last Published: 2015-05-22</span>
31+
&nbsp;| <span id="projectVersion">Version: 1.50.1-SNAPSHOT</span>
3232
</div>
3333
<div class="xright">
3434

@@ -108,36 +108,36 @@ <h3>Apache Maven<a name="Apache_Maven"></a></h3><a name="Apache_Maven"></a>
108108
<pre>&lt;dependency&gt;
109109
&lt;groupId&gt;com.mapcode&lt;/groupId&gt;
110110
&lt;artifactId&gt;mapcode&lt;/artifactId&gt;
111-
&lt;version&gt;1.42&lt;/version&gt;
111+
&lt;version&gt;1.50.1-SNAPSHOT&lt;/version&gt;
112112
&lt;/dependency&gt;</pre></div></div>
113113
<div class="section">
114114
<h3>Apache Buildr<a name="Apache_Buildr"></a></h3><a name="Apache_Buildr"></a>
115115
<div class="source">
116-
<pre>'com.mapcode:mapcode:jar:1.42'</pre></div></div>
116+
<pre>'com.mapcode:mapcode:jar:1.50.1-SNAPSHOT'</pre></div></div>
117117
<div class="section">
118118
<h3>Apache Ivy<a name="Apache_Ivy"></a></h3><a name="Apache_Ivy"></a>
119119
<div class="source">
120-
<pre>&lt;dependency org=&quot;com.mapcode&quot; name=&quot;mapcode&quot; rev=&quot;1.42&quot;&gt;
120+
<pre>&lt;dependency org=&quot;com.mapcode&quot; name=&quot;mapcode&quot; rev=&quot;1.50.1-SNAPSHOT&quot;&gt;
121121
&lt;artifact name=&quot;mapcode&quot; type=&quot;jar&quot; /&gt;
122122
&lt;/dependency&gt;</pre></div></div>
123123
<div class="section">
124124
<h3>Groovy Grape<a name="Groovy_Grape"></a></h3><a name="Groovy_Grape"></a>
125125
<div class="source">
126126
<pre>@Grapes(
127-
@Grab(group='com.mapcode', module='mapcode', version='1.42')
127+
@Grab(group='com.mapcode', module='mapcode', version='1.50.1-SNAPSHOT')
128128
)</pre></div></div>
129129
<div class="section">
130130
<h3>Grails<a name="Grails"></a></h3><a name="Grails"></a>
131131
<div class="source">
132-
<pre>compile 'com.mapcode:mapcode:1.42'</pre></div></div>
132+
<pre>compile 'com.mapcode:mapcode:1.50.1-SNAPSHOT'</pre></div></div>
133133
<div class="section">
134134
<h3>Leiningen<a name="Leiningen"></a></h3><a name="Leiningen"></a>
135135
<div class="source">
136-
<pre>[com.mapcode/mapcode &quot;1.42&quot;]</pre></div></div>
136+
<pre>[com.mapcode/mapcode &quot;1.50.1-SNAPSHOT&quot;]</pre></div></div>
137137
<div class="section">
138138
<h3>SBT<a name="SBT"></a></h3><a name="SBT"></a>
139139
<div class="source">
140-
<pre>libraryDependencies += &quot;com.mapcode&quot; % &quot;mapcode&quot; % &quot;1.42&quot;</pre></div></div></div>
140+
<pre>libraryDependencies += &quot;com.mapcode&quot; % &quot;mapcode&quot; % &quot;1.50.1-SNAPSHOT&quot;</pre></div></div></div>
141141
</div>
142142
</div>
143143
<div class="clear">

‎distribution-management.html‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
2-
<!-- Generated by Apache Maven Doxia Site Renderer 1.4 at 2015-05-05 -->
2+
<!-- Generated by Apache Maven Doxia Site Renderer 1.4 at 2015-05-22 -->
33
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
44
<head>
55
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8" />
@@ -10,7 +10,7 @@
1010
@import url("./css/site.css");
1111
</style>
1212
<link rel="stylesheet" href="./css/print.css" type="text/css" media="print" />
13-
<meta name="Date-Revision-yyyymmdd" content="20150505" />
13+
<meta name="Date-Revision-yyyymmdd" content="20150522" />
1414
<meta http-equiv="Content-Language" content="en" />
1515

1616
</head>
@@ -27,8 +27,8 @@
2727

2828

2929
<div class="xleft">
30-
<span id="publishDate">Last Published: 2015-05-05</span>
31-
&nbsp;| <span id="projectVersion">Version: 1.42</span>
30+
<span id="publishDate">Last Published: 2015-05-22</span>
31+
&nbsp;| <span id="projectVersion">Version: 1.50.1-SNAPSHOT</span>
3232
</div>
3333
<div class="xright">
3434

‎index.html‎

Lines changed: 14 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
2-
<!-- Generated by Apache Maven Doxia Site Renderer 1.4 at 2015-05-05 -->
2+
<!-- Generated by Apache Maven Doxia Site Renderer 1.4 at 2015-05-22 -->
33
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
44
<head>
55
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8" />
@@ -10,7 +10,7 @@
1010
@import url("./css/site.css");
1111
</style>
1212
<link rel="stylesheet" href="./css/print.css" type="text/css" media="print" />
13-
<meta name="Date-Revision-yyyymmdd" content="20150505" />
13+
<meta name="Date-Revision-yyyymmdd" content="20150522" />
1414
<meta http-equiv="Content-Language" content="en" />
1515

1616
</head>
@@ -27,8 +27,8 @@
2727

2828

2929
<div class="xleft">
30-
<span id="publishDate">Last Published: 2015-05-05</span>
31-
&nbsp;| <span id="projectVersion">Version: 1.42</span>
30+
<span id="publishDate">Last Published: 2015-05-22</span>
31+
&nbsp;| <span id="projectVersion">Version: 1.50.1-SNAPSHOT</span>
3232
</div>
3333
<div class="xright">
3434

@@ -106,7 +106,7 @@ <h2>Release Notes<a name="Release_Notes"></a></h2>
106106
<p>You can find the release notes for this library at: <b><a href="./ReleaseNotes.html">Release Notes</a></b></p></div>
107107
<div class="section">
108108
<h2>Code Style Settings for IntelliJ IDEA<a name="Code_Style_Settings_for_IntelliJ_IDEA"></a></h2>
109-
<p>The Java code uses the IntelliJ IDEA code style settings as specified in: <b><a href="./IntelliJ.html">IntelliJ IDEA Code Style Settings</a></b>.</p></div>
109+
<p>The Java code uses the default IntelliJ IDEA code style settings for Java.</p></div>
110110
<div class="section">
111111
<h2>How To Build The Mapcode Library JAR File<a name="How_To_Build_The_Mapcode_Library_JAR_File"></a></h2>
112112
<p>The sources for the Mapcode Library for Java contain everything to build the Mapcode JAR file as well as a significant number of unit tests to verify the correctness of the implementation against the reference C implementation.</p>
@@ -154,11 +154,6 @@ <h2>Class <tt>MapcodeCodec.java</tt><a name="Class_MapcodeCodec.java"></a></h2>
154154
catch (final UnknownMapcodeException e) {
155155
// If the location is not within the territory, this exception is thrown.
156156
}</pre></div></li>
157-
<li>It's important to note that for the encoding methods:
158-
<ul>
159-
<li><b>latitudes</b> are always between <tt>-90</tt> and <tt>90</tt>, and</li>
160-
<li><b>longitudes</b> are always between <tt>-180</tt> and <tt>180</tt>.
161-
<p>An runtime exception <tt>IllegalArgumentException</tt> exception is thrown for values outside these ranges.</p></li></ul></li>
162157
<li><tt>Point decode(String mapcode)</tt> decodes a mapcode to a <tt>Point</tt> which contains a location. Example:
163158
<div class="source">
164159
<pre>final Point p = MapcodeCodec.decode(&quot;NLD 49.4V&quot;);</pre></div></li>
@@ -171,28 +166,23 @@ <h2>Class <tt>Mapcode.java</tt><a name="Class_Mapcode.java"></a></h2>
171166
<p>This class represents mapcodes, which consist of a string of characters, digits and a decimal point and a territory specification. The territory specification is required for national (local) mapcodes, which are not globally unique.</p>
172167
<p>The class also exposes methods to convert mapcodes to proper mapcode strings, usable for printing and it allows string-formatted mapcodes to be converted to <tt>Mapcode</tt> objects, where territory information is properly parsed and converted to a <tt>Territory</tt> enumeration value.</p>
173168
<ul>
174-
<li><tt>String getMapcode()</tt> returns the mapcode string which does not include territory information. You can also use <tt>getMapcodePrecision1()</tt> and <tt>getMapcodePrecision2()</tt> for more precision, but longer mapcodes.
169+
<li><tt>String getCode()</tt> returns the mapcode string which does not include territory information. You can also use <tt>getCode(1)</tt> and <tt>getCode(2)</tt> for more precision, but longer mapcodes.
175170
<ul>
176-
<li>The default precision offered by <tt>getMapcode()</tt> is approximately 5m (maximum distance to latitude, longitude the mapcode decodes to). This corresponds to an area of 10m x 10m (100m2). These mapcodes include no additional precision digits.</li>
177-
<li>The precision offered by <tt>getMapcodePrecision1()</tt> is approximately 1m. This corresponds to an area of 2m x 2m (4m2). These mapcodes include 1 additional precision digit.</li>
178-
<li>The precision offered by <tt>getMapcodePrecision2()</tt> is approximately 0.16m. This corresponds to an area of 0.32m x 0.32m (0.1m2). These mapcodes include 2 additional precision digits.</li></ul></li>
171+
<li>The default precision offered by <tt>getCode()</tt> is approximately 10m (maximum distance to latitude, longitude the mapcode decodes to). This corresponds to an area of 20m x 20m (400m2). These mapcodes include no additional precision digits.</li>
172+
<li>The precision offered by <tt>getMapcodePrecision1()</tt> is approximately 2m. This corresponds to an area of 4m x 4m (16m2). These mapcodes include 1 additional precision digit.</li>
173+
<li>The precision offered by <tt>getMapcodePrecision2()</tt> is approximately 0.40m. This corresponds to an area of 0.80m x 0.80m (0.64m2). These mapcodes include 2 additional precision digits.</li></ul></li>
179174
<li><tt>Territory getTerritory()</tt> returns the territory information.</li>
180-
<li><tt>StringasInternationFullname()</tt> returns mapcodes string with territory information, specified as a full country name.</li>
181-
<li><tt>String asInternationISO()</tt> returns mapcodes string with territory information, specified as an ISO code name. Importanmt: This is returns the same result as <tt>toString()</tt>.</li></ul></div>
175+
<li><tt>toString()</tt> and <tt>getCodeWithTerritory()</tt> return mapcodes string with territory information, specified as a ISO code.</li></ul></div>
182176
<div class="section">
183177
<h2>Class <tt>Point.java</tt><a name="Class_Point.java"></a></h2>
184-
<p>This class represents (latitude, longitude) locations. It offers methods to create locations using degrees or micro-degrees (which are degrees times 1.000.000).</p>
178+
<p>This class represents (latitude, longitude) locations. It offers methods to create locations using degrees.</p>
185179
<ul>
186180
<li><tt>Point fromDeg(double latitude, double longitude)</tt> returns a <tt>Point</tt> for a given (latitude, longitude) pair. Note that:
187181
<ul>
188182
<li><b>latitudes</b> are always between <tt>-90</tt> and <tt>90</tt>, and</li>
189-
<li><b>longitudes</b> are always between <tt>-180</tt> and <tt>180</tt>.</li></ul></li>
190-
<li><tt>Point fromMicroDeg(int latitude, int longitude)</tt> is the same as <tt>fromDeg</tt> except the values are integers and are degerees times 1.000.000, so the ranges are:
191-
<ul>
192-
<li><b>latitudes</b> are always between <tt>-90000000</tt> and <tt>90000000</tt>, and</li>
193-
<li><b>longitudes</b> are always between <tt>-180000000</tt> and <tt>180000000</tt>.</li></ul></li>
194-
<li><tt>double getLat()</tt> and <tt>getLon()</tt> return the latitude and longitude respectively, in degrees.</li>
195-
<li><tt>int getLatMicroDegrees()</tt> and <tt>getLonMicroDegrees()</tt> return the latitude and longitude respectively, in micro-degrees.</li></ul></div>
183+
<li><b>longitudes</b> are always between <tt>-180</tt> and <tt>180</tt>;</li>
184+
<li>Values outside these range are correctly limited (latitude) or wrapped (longitude) to these ranges.</li></ul></li>
185+
<li><tt>double getLat()</tt> and <tt>getLon()</tt> return the latitude and longitude respectively, in degrees.</li></ul></div>
196186
<div class="section">
197187
<h2>What Is A Mapcode?<a name="What_Is_A_Mapcode"></a></h2>
198188
<p>A mapcode represents a location. Every location on Earth can be represented by a mapcode. Mapcodes were designed to be short, easy to recognise, remember and communicate. They are precise to a few meters, which is good enough for every-day use.</p></div>

0 commit comments

Comments
 (0)