-
Notifications
You must be signed in to change notification settings - Fork 2
Expand file tree
/
Copy pathMapcode.html
More file actions
814 lines (796 loc) · 46.8 KB
/
Copy pathMapcode.html
File metadata and controls
814 lines (796 loc) · 46.8 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc (1.8.0_162) on Thu May 03 18:04:41 CEST 2018 -->
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>Mapcode (Mapcode Java Library 2.4.6 API)</title>
<meta name="date" content="2018-05-03">
<link rel="stylesheet" type="text/css" href="../../stylesheet.css" title="Style">
<script type="text/javascript" src="../../script.js"></script>
</head>
<body>
<script type="text/javascript"><!--
try {
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="Mapcode (Mapcode Java Library 2.4.6 API)";
}
}
catch(err) {
}
//-->
var methods = {"i0":9,"i1":10,"i2":10,"i3":10,"i4":10,"i5":10,"i6":10,"i7":10,"i8":10,"i9":10,"i10":10,"i11":10,"i12":10,"i13":10,"i14":9,"i15":9,"i16":10,"i17":10,"i18":9,"i19":10};
var tabs = {65535:["t0","All Methods"],1:["t1","Static Methods"],2:["t2","Instance Methods"],8:["t4","Concrete Methods"]};
var altColor = "altColor";
var rowColor = "rowColor";
var tableTab = "tableTab";
var activeTableTab = "activeTableTab";
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="topNav"><a name="navbar.top">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div>
<a name="navbar.top.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../com/mapcode/package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="class-use/Mapcode.html">Use</a></li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../index-all.html">Index</a></li>
<li><a href="../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../com/mapcode/IncorrectDataModelException.html" title="class in com.mapcode"><span class="typeNameLink">Prev Class</span></a></li>
<li><a href="../../com/mapcode/MapcodeCodec.html" title="class in com.mapcode"><span class="typeNameLink">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../index.html?com/mapcode/Mapcode.html" target="_top">Frames</a></li>
<li><a href="Mapcode.html" target="_top">No Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_top">
<li><a href="../../allclasses-noframe.html">All Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_top");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
</div>
<div>
<ul class="subNavList">
<li>Summary: </li>
<li>Nested | </li>
<li><a href="#field.summary">Field</a> | </li>
<li><a href="#constructor.summary">Constr</a> | </li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail: </li>
<li><a href="#field.detail">Field</a> | </li>
<li><a href="#constructor.detail">Constr</a> | </li>
<li><a href="#method.detail">Method</a></li>
</ul>
</div>
<a name="skip.navbar.top">
<!-- -->
</a></div>
<!-- ========= END OF TOP NAVBAR ========= -->
<!-- ======== START OF CLASS DATA ======== -->
<div class="header">
<div class="subTitle">com.mapcode</div>
<h2 title="Class Mapcode" class="title">Class Mapcode</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li><a href="https://docs.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">java.lang.Object</a></li>
<li>
<ul class="inheritance">
<li>com.mapcode.Mapcode</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<hr>
<br>
<pre>public final class <span class="typeNameLabel">Mapcode</span>
extends <a href="https://docs.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></pre>
<div class="block">This class defines a single mapcode encoding result, including the alphanumeric code and the
territory definition.
On terminology, mapcode territory and mapcode code:
In written form. a mapcode is defined as an alphanumeric code, optionally preceded by a
territory code.
For example: "NLD 49.4V" is a mapcode, but "49.4V" is a mapcode as well, The latter is called
a "local" mapcode, because it is not internationally unambiguous unless preceded by a territory
code.
For "NLD 49.4V" the "NLD"-part is called "the territory" and the "49.4V"-part is called
"the code" (which are both part of "the mapcode").
This distinction between "territory" and "code" in a mapcode is why the interface of this class
has been changed from version 1.50.0 to reflect this terminology.
On alphabets:
Mapcode codes can be represented in different alphabets. Note that an alphabet is something else
than a locale or a language. The supported alphabets for mapcodes are listed in <a href="../../com/mapcode/Alphabet.html" title="enum in com.mapcode"><code>Alphabet</code></a>.
Mapcode objects provide methods to obtain the mapcode code in a specific alphabet. By default,
the <a href="../../com/mapcode/Alphabet.html#ROMAN"><code>Alphabet.ROMAN</code></a> is used.</div>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- =========== FIELD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="field.summary">
<!-- -->
</a>
<h3>Field Summary</h3>
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Field Summary table, listing fields, and an explanation">
<caption><span>Fields</span><span class="tabEnd"> </span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Field and Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static <a href="https://docs.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../com/mapcode/Mapcode.html#REGEX_MAPCODE">REGEX_MAPCODE</a></span></code>
<div class="block">This patterns/regular expressions is used for checking mapcode format strings.</div>
</td>
</tr>
</table>
</li>
</ul>
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor.summary">
<!-- -->
</a>
<h3>Constructor Summary</h3>
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation">
<caption><span>Constructors</span><span class="tabEnd"> </span></caption>
<tr>
<th class="colOne" scope="col">Constructor and Description</th>
</tr>
<tr class="altColor">
<td class="colOne"><code><span class="memberNameLink"><a href="../../com/mapcode/Mapcode.html#Mapcode-java.lang.String-com.mapcode.Territory-">Mapcode</a></span>(<a href="https://docs.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> code,
<a href="../../com/mapcode/Territory.html" title="enum in com.mapcode">Territory</a> territory)</code>
<div class="block">Create a mapcode object.</div>
</td>
</tr>
</table>
</li>
</ul>
<!-- ========== METHOD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="method.summary">
<!-- -->
</a>
<h3>Method Summary</h3>
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
<caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd"> </span></span><span id="t1" class="tableTab"><span><a href="javascript:show(1);">Static Methods</a></span><span class="tabEnd"> </span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd"> </span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd"> </span></span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Method and Description</th>
</tr>
<tr id="i0" class="altColor">
<td class="colFirst"><code>static boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../com/mapcode/Mapcode.html#containsTerritory-java.lang.String-">containsTerritory</a></span>(<a href="https://docs.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> mapcode)</code>
<div class="block">Returns whether the mapcode contains territory information or not.</div>
</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../com/mapcode/Mapcode.html#equals-java.lang.Object-">equals</a></span>(<a href="https://docs.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a> obj)</code> </td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code><a href="https://docs.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../com/mapcode/Mapcode.html#getCode--">getCode</a></span>()</code> </td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code><a href="https://docs.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../com/mapcode/Mapcode.html#getCode-com.mapcode.Alphabet-">getCode</a></span>(<a href="../../com/mapcode/Alphabet.html" title="enum in com.mapcode">Alphabet</a> alphabet)</code>
<div class="block">Get the Mapcode string (without territory information) with standard precision.</div>
</td>
</tr>
<tr id="i4" class="altColor">
<td class="colFirst"><code><a href="https://docs.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../com/mapcode/Mapcode.html#getCode-int-">getCode</a></span>(int precision)</code> </td>
</tr>
<tr id="i5" class="rowColor">
<td class="colFirst"><code><a href="https://docs.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../com/mapcode/Mapcode.html#getCode-int-com.mapcode.Alphabet-">getCode</a></span>(int precision,
<a href="../../com/mapcode/Alphabet.html" title="enum in com.mapcode">Alphabet</a> alphabet)</code>
<div class="block">Get the mapcode code (without territory information) with a specified precision.</div>
</td>
</tr>
<tr id="i6" class="altColor">
<td class="colFirst"><code><a href="https://docs.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../com/mapcode/Mapcode.html#getCodeWithTerritory--">getCodeWithTerritory</a></span>()</code> </td>
</tr>
<tr id="i7" class="rowColor">
<td class="colFirst"><code><a href="https://docs.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../com/mapcode/Mapcode.html#getCodeWithTerritory-com.mapcode.Alphabet-">getCodeWithTerritory</a></span>(<a href="../../com/mapcode/Alphabet.html" title="enum in com.mapcode">Alphabet</a> alphabet)</code> </td>
</tr>
<tr id="i8" class="altColor">
<td class="colFirst"><code><a href="https://docs.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../com/mapcode/Mapcode.html#getCodeWithTerritory-int-">getCodeWithTerritory</a></span>(int precision)</code> </td>
</tr>
<tr id="i9" class="rowColor">
<td class="colFirst"><code><a href="https://docs.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../com/mapcode/Mapcode.html#getCodeWithTerritory-int-com.mapcode.Alphabet-">getCodeWithTerritory</a></span>(int precision,
<a href="../../com/mapcode/Alphabet.html" title="enum in com.mapcode">Alphabet</a> alphabet)</code>
<div class="block">Return the international mapcode as a shorter version using the ISO territory codes where possible.</div>
</td>
</tr>
<tr id="i10" class="altColor">
<td class="colFirst"><code><a href="https://docs.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../com/mapcode/Mapcode.html#getCodeWithTerritoryFullname--">getCodeWithTerritoryFullname</a></span>()</code> </td>
</tr>
<tr id="i11" class="rowColor">
<td class="colFirst"><code><a href="https://docs.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../com/mapcode/Mapcode.html#getCodeWithTerritoryFullname-com.mapcode.Alphabet-">getCodeWithTerritoryFullname</a></span>(<a href="../../com/mapcode/Alphabet.html" title="enum in com.mapcode">Alphabet</a> alphabet)</code> </td>
</tr>
<tr id="i12" class="altColor">
<td class="colFirst"><code><a href="https://docs.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../com/mapcode/Mapcode.html#getCodeWithTerritoryFullname-int-">getCodeWithTerritoryFullname</a></span>(int precision)</code> </td>
</tr>
<tr id="i13" class="rowColor">
<td class="colFirst"><code><a href="https://docs.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../com/mapcode/Mapcode.html#getCodeWithTerritoryFullname-int-com.mapcode.Alphabet-">getCodeWithTerritoryFullname</a></span>(int precision,
<a href="../../com/mapcode/Alphabet.html" title="enum in com.mapcode">Alphabet</a> alphabet)</code>
<div class="block">Return the full international mapcode, including the full name of the territory and the mapcode code itself.</div>
</td>
</tr>
<tr id="i14" class="altColor">
<td class="colFirst"><code>static int</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../com/mapcode/Mapcode.html#getPrecisionFormat-java.lang.String-">getPrecisionFormat</a></span>(<a href="https://docs.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> mapcode)</code>
<div class="block">This method return the mapcode type, given a mapcode string.</div>
</td>
</tr>
<tr id="i15" class="rowColor">
<td class="colFirst"><code>static double</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../com/mapcode/Mapcode.html#getSafeMaxOffsetInMeters-int-">getSafeMaxOffsetInMeters</a></span>(int precision)</code>
<div class="block">Get a safe maximum for the distance between a decoded mapcode and its original
location used for encoding the mapcode.</div>
</td>
</tr>
<tr id="i16" class="altColor">
<td class="colFirst"><code><a href="../../com/mapcode/Territory.html" title="enum in com.mapcode">Territory</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../com/mapcode/Mapcode.html#getTerritory--">getTerritory</a></span>()</code>
<div class="block">Get the territory information.</div>
</td>
</tr>
<tr id="i17" class="rowColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../com/mapcode/Mapcode.html#hashCode--">hashCode</a></span>()</code> </td>
</tr>
<tr id="i18" class="altColor">
<td class="colFirst"><code>static boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../com/mapcode/Mapcode.html#isValidMapcodeFormat-java.lang.String-">isValidMapcodeFormat</a></span>(<a href="https://docs.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> mapcode)</code>
<div class="block">This method provides a shortcut to checking if a mapcode string is formatted properly or not at all.</div>
</td>
</tr>
<tr id="i19" class="rowColor">
<td class="colFirst"><code><a href="https://docs.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../com/mapcode/Mapcode.html#toString--">toString</a></span>()</code>
<div class="block">This method is defined as returning the mapcode code including its territory,
with normal precision (precision 0).</div>
</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.java.lang.Object">
<!-- -->
</a>
<h3>Methods inherited from class java.lang.<a href="https://docs.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></h3>
<code><a href="https://docs.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#clone--" title="class or interface in java.lang">clone</a>, <a href="https://docs.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#finalize--" title="class or interface in java.lang">finalize</a>, <a href="https://docs.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#getClass--" title="class or interface in java.lang">getClass</a>, <a href="https://docs.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#notify--" title="class or interface in java.lang">notify</a>, <a href="https://docs.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#notifyAll--" title="class or interface in java.lang">notifyAll</a>, <a href="https://docs.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#wait--" title="class or interface in java.lang">wait</a>, <a href="https://docs.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#wait-long-" title="class or interface in java.lang">wait</a>, <a href="https://docs.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#wait-long-int-" title="class or interface in java.lang">wait</a></code></li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ============ FIELD DETAIL =========== -->
<ul class="blockList">
<li class="blockList"><a name="field.detail">
<!-- -->
</a>
<h3>Field Detail</h3>
<a name="REGEX_MAPCODE">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>REGEX_MAPCODE</h4>
<pre><a href="https://docs.oracle.com/javase/6/docs/api/javax/annotation/Nonnull.html?is-external=true" title="class or interface in javax.annotation">@Nonnull</a>
public static final <a href="https://docs.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> REGEX_MAPCODE</pre>
<div class="block">This patterns/regular expressions is used for checking mapcode format strings.
They've been made public to allow others to use the correct regular expressions as well.</div>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../constant-values.html#com.mapcode.Mapcode.REGEX_MAPCODE">Constant Field Values</a></dd>
</dl>
</li>
</ul>
</li>
</ul>
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor.detail">
<!-- -->
</a>
<h3>Constructor Detail</h3>
<a name="Mapcode-java.lang.String-com.mapcode.Territory-">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>Mapcode</h4>
<pre>public Mapcode(<a href="https://docs.oracle.com/javase/6/docs/api/javax/annotation/Nonnull.html?is-external=true" title="class or interface in javax.annotation">@Nonnull</a>
<a href="https://docs.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> code,
<a href="https://docs.oracle.com/javase/6/docs/api/javax/annotation/Nonnull.html?is-external=true" title="class or interface in javax.annotation">@Nonnull</a>
<a href="../../com/mapcode/Territory.html" title="enum in com.mapcode">Territory</a> territory)
throws <a href="https://docs.oracle.com/javase/6/docs/api/java/lang/IllegalArgumentException.html?is-external=true" title="class or interface in java.lang">IllegalArgumentException</a></pre>
<div class="block">Create a mapcode object. Normally, mapcodes are created be encoding a lat/lon pair
using <a href="../../com/mapcode/MapcodeCodec.html#encode-double-double-"><code>MapcodeCodec.encode(double, double)</code></a> rather than creating them yourself.
Note that it is possible to create invalid mapcodes this way, which are syntactically
correct.
Note that the constructor will throw an <a href="https://docs.oracle.com/javase/6/docs/api/java/lang/IllegalArgumentException.html?is-external=true" title="class or interface in java.lang"><code>IllegalArgumentException</code></a> if the syntax of the mapcode
is not correct. The mapcode is not checked for validity, other than its syntax.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>code</code> - Code of mapcode.</dd>
<dd><code>territory</code> - Territory.</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="https://docs.oracle.com/javase/6/docs/api/java/lang/IllegalArgumentException.html?is-external=true" title="class or interface in java.lang">IllegalArgumentException</a></code> - Thrown if syntax not valid or if the mapcode string contains
territory information.</dd>
</dl>
</li>
</ul>
</li>
</ul>
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method.detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="getCode-com.mapcode.Alphabet-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getCode</h4>
<pre><a href="https://docs.oracle.com/javase/6/docs/api/javax/annotation/Nonnull.html?is-external=true" title="class or interface in javax.annotation">@Nonnull</a>
public <a href="https://docs.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> getCode(<a href="https://docs.oracle.com/javase/6/docs/api/javax/annotation/Nullable.html?is-external=true" title="class or interface in javax.annotation">@Nullable</a>
<a href="../../com/mapcode/Alphabet.html" title="enum in com.mapcode">Alphabet</a> alphabet)</pre>
<div class="block">Get the Mapcode string (without territory information) with standard precision.
The returned mapcode does not include the '-' separator and additional digits.
A mapcode defines an area of approximately 10 x 10 meters (100 m2) and will decode
to the center of that area. On average, the original coordinate will be 3.6 meters
from this center: the average inaccuracy of a mapcode.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>alphabet</code> - Alphabet.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>Mapcode string.</dd>
</dl>
</li>
</ul>
<a name="getCode--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getCode</h4>
<pre><a href="https://docs.oracle.com/javase/6/docs/api/javax/annotation/Nonnull.html?is-external=true" title="class or interface in javax.annotation">@Nonnull</a>
public <a href="https://docs.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> getCode()</pre>
</li>
</ul>
<a name="getCode-int-com.mapcode.Alphabet-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getCode</h4>
<pre><a href="https://docs.oracle.com/javase/6/docs/api/javax/annotation/Nonnull.html?is-external=true" title="class or interface in javax.annotation">@Nonnull</a>
public <a href="https://docs.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> getCode(int precision,
<a href="https://docs.oracle.com/javase/6/docs/api/javax/annotation/Nullable.html?is-external=true" title="class or interface in javax.annotation">@Nullable</a>
<a href="../../com/mapcode/Alphabet.html" title="enum in com.mapcode">Alphabet</a> alphabet)</pre>
<div class="block">Get the mapcode code (without territory information) with a specified precision.
The returned mapcode includes a '-' separator and additional digits for precisions 1 to 8.
The precision defines the size of a geographical area a single mapcode covers. This means It also defines
the maximum distance to the location, a (latitude, longitude) pair, that encoded to this mapcode.
Precision 0: area is approx 10 x 10 meters (100 m2); max. distance from original location less than 7.5 meters.
Precision 1: area is approx 3.33 m2; max. distance from original location less than 1.5 meters.
Precision 1: area is approx 0.11 m2; max. distance from original location less than 0.4 meters.
etc. (each level reduces the area by a factor of 30)
The accuracy is slightly better than the figures above, but these figures are safe assumptions.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>precision</code> - Precision. Range: 0..8.</dd>
<dd><code>alphabet</code> - Alphabet.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>Mapcode code.</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="https://docs.oracle.com/javase/6/docs/api/java/lang/IllegalArgumentException.html?is-external=true" title="class or interface in java.lang">IllegalArgumentException</a></code> - Thrown if precision is out of range (must be in [0, 8]).</dd>
</dl>
</li>
</ul>
<a name="getCode-int-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getCode</h4>
<pre><a href="https://docs.oracle.com/javase/6/docs/api/javax/annotation/Nonnull.html?is-external=true" title="class or interface in javax.annotation">@Nonnull</a>
public <a href="https://docs.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> getCode(int precision)
throws <a href="https://docs.oracle.com/javase/6/docs/api/java/lang/IllegalArgumentException.html?is-external=true" title="class or interface in java.lang">IllegalArgumentException</a></pre>
<dl>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="https://docs.oracle.com/javase/6/docs/api/java/lang/IllegalArgumentException.html?is-external=true" title="class or interface in java.lang">IllegalArgumentException</a></code></dd>
</dl>
</li>
</ul>
<a name="getCodeWithTerritoryFullname-int-com.mapcode.Alphabet-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getCodeWithTerritoryFullname</h4>
<pre><a href="https://docs.oracle.com/javase/6/docs/api/javax/annotation/Nonnull.html?is-external=true" title="class or interface in javax.annotation">@Nonnull</a>
public <a href="https://docs.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> getCodeWithTerritoryFullname(int precision,
<a href="https://docs.oracle.com/javase/6/docs/api/javax/annotation/Nullable.html?is-external=true" title="class or interface in javax.annotation">@Nullable</a>
<a href="../../com/mapcode/Alphabet.html" title="enum in com.mapcode">Alphabet</a> alphabet)
throws <a href="https://docs.oracle.com/javase/6/docs/api/java/lang/IllegalArgumentException.html?is-external=true" title="class or interface in java.lang">IllegalArgumentException</a></pre>
<div class="block">Return the full international mapcode, including the full name of the territory and the mapcode code itself.
The format of the string is:
full-territory-name cde
Example:
Netherlands 49.4V (regular code)
Netherlands 49.4V-K2 (high precision code)</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>precision</code> - Precision specifier. Range: [0, 8].</dd>
<dd><code>alphabet</code> - Alphabet.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>Full international mapcode.</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="https://docs.oracle.com/javase/6/docs/api/java/lang/IllegalArgumentException.html?is-external=true" title="class or interface in java.lang">IllegalArgumentException</a></code> - Thrown if precision is out of range (must be in [0, 8]).</dd>
</dl>
</li>
</ul>
<a name="getCodeWithTerritoryFullname-int-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getCodeWithTerritoryFullname</h4>
<pre><a href="https://docs.oracle.com/javase/6/docs/api/javax/annotation/Nonnull.html?is-external=true" title="class or interface in javax.annotation">@Nonnull</a>
public <a href="https://docs.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> getCodeWithTerritoryFullname(int precision)
throws <a href="https://docs.oracle.com/javase/6/docs/api/java/lang/IllegalArgumentException.html?is-external=true" title="class or interface in java.lang">IllegalArgumentException</a></pre>
<dl>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="https://docs.oracle.com/javase/6/docs/api/java/lang/IllegalArgumentException.html?is-external=true" title="class or interface in java.lang">IllegalArgumentException</a></code></dd>
</dl>
</li>
</ul>
<a name="getCodeWithTerritoryFullname-com.mapcode.Alphabet-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getCodeWithTerritoryFullname</h4>
<pre><a href="https://docs.oracle.com/javase/6/docs/api/javax/annotation/Nonnull.html?is-external=true" title="class or interface in javax.annotation">@Nonnull</a>
public <a href="https://docs.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> getCodeWithTerritoryFullname(<a href="https://docs.oracle.com/javase/6/docs/api/javax/annotation/Nullable.html?is-external=true" title="class or interface in javax.annotation">@Nullable</a>
<a href="../../com/mapcode/Alphabet.html" title="enum in com.mapcode">Alphabet</a> alphabet)</pre>
</li>
</ul>
<a name="getCodeWithTerritoryFullname--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getCodeWithTerritoryFullname</h4>
<pre><a href="https://docs.oracle.com/javase/6/docs/api/javax/annotation/Nonnull.html?is-external=true" title="class or interface in javax.annotation">@Nonnull</a>
public <a href="https://docs.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> getCodeWithTerritoryFullname()</pre>
</li>
</ul>
<a name="getCodeWithTerritory-int-com.mapcode.Alphabet-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getCodeWithTerritory</h4>
<pre><a href="https://docs.oracle.com/javase/6/docs/api/javax/annotation/Nonnull.html?is-external=true" title="class or interface in javax.annotation">@Nonnull</a>
public <a href="https://docs.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> getCodeWithTerritory(int precision,
<a href="https://docs.oracle.com/javase/6/docs/api/javax/annotation/Nullable.html?is-external=true" title="class or interface in javax.annotation">@Nullable</a>
<a href="../../com/mapcode/Alphabet.html" title="enum in com.mapcode">Alphabet</a> alphabet)
throws <a href="https://docs.oracle.com/javase/6/docs/api/java/lang/IllegalArgumentException.html?is-external=true" title="class or interface in java.lang">IllegalArgumentException</a></pre>
<div class="block">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
Example:
NLD 49.4V (regular code)
NLD 49.4V-K2 (high-precision code)</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>precision</code> - Precision specifier. Range: [0, 8].</dd>
<dd><code>alphabet</code> - Alphabet.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>Short-hand international mapcode.</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="https://docs.oracle.com/javase/6/docs/api/java/lang/IllegalArgumentException.html?is-external=true" title="class or interface in java.lang">IllegalArgumentException</a></code> - Thrown if precision is out of range (must be in [0, 8]).</dd>
</dl>
</li>
</ul>
<a name="getCodeWithTerritory-int-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getCodeWithTerritory</h4>
<pre><a href="https://docs.oracle.com/javase/6/docs/api/javax/annotation/Nonnull.html?is-external=true" title="class or interface in javax.annotation">@Nonnull</a>
public <a href="https://docs.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> getCodeWithTerritory(int precision)
throws <a href="https://docs.oracle.com/javase/6/docs/api/java/lang/IllegalArgumentException.html?is-external=true" title="class or interface in java.lang">IllegalArgumentException</a></pre>
<dl>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="https://docs.oracle.com/javase/6/docs/api/java/lang/IllegalArgumentException.html?is-external=true" title="class or interface in java.lang">IllegalArgumentException</a></code></dd>
</dl>
</li>
</ul>
<a name="getCodeWithTerritory-com.mapcode.Alphabet-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getCodeWithTerritory</h4>
<pre><a href="https://docs.oracle.com/javase/6/docs/api/javax/annotation/Nonnull.html?is-external=true" title="class or interface in javax.annotation">@Nonnull</a>
public <a href="https://docs.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> getCodeWithTerritory(<a href="https://docs.oracle.com/javase/6/docs/api/javax/annotation/Nonnull.html?is-external=true" title="class or interface in javax.annotation">@Nonnull</a>
<a href="../../com/mapcode/Alphabet.html" title="enum in com.mapcode">Alphabet</a> alphabet)</pre>
</li>
</ul>
<a name="getCodeWithTerritory--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getCodeWithTerritory</h4>
<pre><a href="https://docs.oracle.com/javase/6/docs/api/javax/annotation/Nonnull.html?is-external=true" title="class or interface in javax.annotation">@Nonnull</a>
public <a href="https://docs.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> getCodeWithTerritory()</pre>
</li>
</ul>
<a name="getTerritory--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getTerritory</h4>
<pre><a href="https://docs.oracle.com/javase/6/docs/api/javax/annotation/Nonnull.html?is-external=true" title="class or interface in javax.annotation">@Nonnull</a>
public <a href="../../com/mapcode/Territory.html" title="enum in com.mapcode">Territory</a> getTerritory()</pre>
<div class="block">Get the territory information.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>Territory information.</dd>
</dl>
</li>
</ul>
<a name="getPrecisionFormat-java.lang.String-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getPrecisionFormat</h4>
<pre>public static int getPrecisionFormat(<a href="https://docs.oracle.com/javase/6/docs/api/javax/annotation/Nonnull.html?is-external=true" title="class or interface in javax.annotation">@Nonnull</a>
<a href="https://docs.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> mapcode)
throws <a href="../../com/mapcode/UnknownPrecisionFormatException.html" title="class in com.mapcode">UnknownPrecisionFormatException</a></pre>
<div class="block">This method return the mapcode type, given a mapcode string. If the mapcode string has an invalid
format, an exception is thrown.
Note that this method only checks the syntactic validity of the mapcode, the string format. It does not
check if the mapcode is really a valid mapcode representing a position on Earth.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>mapcode</code> - Mapcode (optionally with a territory).</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>Type of mapcode code format.</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="../../com/mapcode/UnknownPrecisionFormatException.html" title="class in com.mapcode">UnknownPrecisionFormatException</a></code> - If precision format is incorrect.</dd>
</dl>
</li>
</ul>
<a name="isValidMapcodeFormat-java.lang.String-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isValidMapcodeFormat</h4>
<pre>public static boolean isValidMapcodeFormat(<a href="https://docs.oracle.com/javase/6/docs/api/javax/annotation/Nonnull.html?is-external=true" title="class or interface in javax.annotation">@Nonnull</a>
<a href="https://docs.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> mapcode)
throws <a href="https://docs.oracle.com/javase/6/docs/api/java/lang/IllegalArgumentException.html?is-external=true" title="class or interface in java.lang">IllegalArgumentException</a></pre>
<div class="block">This method provides a shortcut to checking if a mapcode string is formatted properly or not at all.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>mapcode</code> - Mapcode (optionally with a territory).</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>True if the mapcode format, the syntax, is correct. This does not mean the mapcode code is
actually a valid mapcode representing a location on Earth.</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="https://docs.oracle.com/javase/6/docs/api/java/lang/IllegalArgumentException.html?is-external=true" title="class or interface in java.lang">IllegalArgumentException</a></code> - If mapcode is null.</dd>
</dl>
</li>
</ul>
<a name="containsTerritory-java.lang.String-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>containsTerritory</h4>
<pre>public static boolean containsTerritory(<a href="https://docs.oracle.com/javase/6/docs/api/javax/annotation/Nonnull.html?is-external=true" title="class or interface in javax.annotation">@Nonnull</a>
<a href="https://docs.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> mapcode)
throws <a href="https://docs.oracle.com/javase/6/docs/api/java/lang/IllegalArgumentException.html?is-external=true" title="class or interface in java.lang">IllegalArgumentException</a></pre>
<div class="block">Returns whether the mapcode contains territory information or not.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>mapcode</code> - Mapcode string, optionally with territory information.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>True if mapcode contains territory information.</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="https://docs.oracle.com/javase/6/docs/api/java/lang/IllegalArgumentException.html?is-external=true" title="class or interface in java.lang">IllegalArgumentException</a></code> - If mapcode has incorrect syntax.</dd>
</dl>
</li>
</ul>
<a name="getSafeMaxOffsetInMeters-int-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getSafeMaxOffsetInMeters</h4>
<pre>public static double getSafeMaxOffsetInMeters(int precision)</pre>
<div class="block">Get a safe maximum for the distance between a decoded mapcode and its original
location used for encoding the mapcode. The actual accuracy (resolution) of mapcodes is
better than this, but these are safe values to use under normal circumstances.
Do not make any other assumptions on these numbers than that mapcodes are never more off
by this distance.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>precision</code> - Precision of mapcode.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>Maximum offset in meters.</dd>
</dl>
</li>
</ul>
<a name="toString--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>toString</h4>
<pre><a href="https://docs.oracle.com/javase/6/docs/api/javax/annotation/Nonnull.html?is-external=true" title="class or interface in javax.annotation">@Nonnull</a>
public <a href="https://docs.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> toString()</pre>
<div class="block">This method is defined as returning the mapcode code including its territory,
with normal precision (precision 0).</div>
<dl>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code><a href="https://docs.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#toString--" title="class or interface in java.lang">toString</a></code> in class <code><a href="https://docs.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></code></dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>Mapcode, including territory and code. Plain ASCII, non-Unicode.</dd>
</dl>
</li>
</ul>
<a name="hashCode--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>hashCode</h4>
<pre>public int hashCode()</pre>
<dl>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code><a href="https://docs.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#hashCode--" title="class or interface in java.lang">hashCode</a></code> in class <code><a href="https://docs.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></code></dd>
</dl>
</li>
</ul>
<a name="equals-java.lang.Object-">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>equals</h4>
<pre>public boolean equals(<a href="https://docs.oracle.com/javase/6/docs/api/javax/annotation/Nullable.html?is-external=true" title="class or interface in javax.annotation">@Nullable</a>
<a href="https://docs.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a> obj)</pre>
<dl>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code><a href="https://docs.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#equals-java.lang.Object-" title="class or interface in java.lang">equals</a></code> in class <code><a href="https://docs.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></code></dd>
</dl>
</li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
</div>
<!-- ========= END OF CLASS DATA ========= -->
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<div class="bottomNav"><a name="navbar.bottom">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
<a name="navbar.bottom.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../com/mapcode/package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="class-use/Mapcode.html">Use</a></li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../index-all.html">Index</a></li>
<li><a href="../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../com/mapcode/IncorrectDataModelException.html" title="class in com.mapcode"><span class="typeNameLink">Prev Class</span></a></li>
<li><a href="../../com/mapcode/MapcodeCodec.html" title="class in com.mapcode"><span class="typeNameLink">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../index.html?com/mapcode/Mapcode.html" target="_top">Frames</a></li>
<li><a href="Mapcode.html" target="_top">No Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_bottom">
<li><a href="../../allclasses-noframe.html">All Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_bottom");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
</div>
<div>
<ul class="subNavList">
<li>Summary: </li>
<li>Nested | </li>
<li><a href="#field.summary">Field</a> | </li>
<li><a href="#constructor.summary">Constr</a> | </li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail: </li>
<li><a href="#field.detail">Field</a> | </li>
<li><a href="#constructor.detail">Constr</a> | </li>
<li><a href="#method.detail">Method</a></li>
</ul>
</div>
<a name="skip.navbar.bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
<p class="legalCopy"><small>Copyright © 2018 <a href="http://mapcode.com">Stichting Mapcode Foundation</a>. All rights reserved.</small></p>
</body>
</html>