-
Notifications
You must be signed in to change notification settings - Fork 2
Expand file tree
/
Copy pathData.java.html
More file actions
96 lines (80 loc) · 6.32 KB
/
Copy pathData.java.html
File metadata and controls
96 lines (80 loc) · 6.32 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
<?xml version="1.0" encoding="UTF-8"?><!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd"><html xmlns="http://www.w3.org/1999/xhtml" lang="en"><head><meta http-equiv="Content-Type" content="text/html;charset=UTF-8"/><link rel="stylesheet" href="../jacoco-resources/report.css" type="text/css"/><link rel="shortcut icon" href="../jacoco-resources/report.gif" type="image/gif"/><title>Data.java</title><link rel="stylesheet" href="../jacoco-resources/prettify.css" type="text/css"/><script type="text/javascript" src="../jacoco-resources/prettify.js"></script></head><body onload="window['PR_TAB_WIDTH']=4;prettyPrint()"><div class="breadcrumb" id="breadcrumb"><span class="info"><a href="../jacoco-sessions.html" class="el_session">Sessions</a></span><a href="../index.html" class="el_report">Mapcode Java Library</a> > <a href="index.source.html" class="el_package">com.mapcode</a> > <span class="el_source">Data.java</span></div><h1>Data.java</h1><pre class="source lang-java linenums">/*
* Copyright (C) 2014-2017, Stichting Mapcode Foundation (http://www.mapcode.com)
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package com.mapcode;
import javax.annotation.Nonnull;
// ----------------------------------------------------------------------------------------------
// Package private implementation class. For internal use within the Mapcode implementation only.
// ----------------------------------------------------------------------------------------------
/**
* This class the data class for Mapcode codex items.
*/
<span class="pc bpc" id="L28" title="1 of 2 branches missed.">@SuppressWarnings("MagicNumber")</span>
final class Data {
// TODO: Need explanation what this is and how this is used.
<span class="fc" id="L32"> static final char[] ENCODE_CHARS = {</span>
'0', '1', '2', '3', '4', '5', '6', '7', '8', '9', // Numerals.
'B', 'C', 'D', 'F', 'G', 'H', 'J', 'K', 'L', 'M', // Consonants.
'N', 'P', 'Q', 'R', 'S', 'T', 'V', 'W', 'X', 'Y', 'Z',
'A', 'E', 'U' // Vowels.
};
// Get direct access to the data model.
<span class="fc" id="L40"> private static final DataModel DATA_MODEL = DataModel.getInstance();</span>
private Data() {
// Disabled.
}
// TODO: Explain what these values are. Can we make this an enum instead (safer)?
static final int TERRITORY_RECORD_TYPE_NONE = 0;
static final int TERRITORY_RECORD_TYPE_PIPE = 1;
static final int TERRITORY_RECORD_TYPE_PLUS = 2;
static final int TERRITORY_RECORD_TYPE_STAR = 3;
// TODO: Need to explain what "nameless" means and what a territoryRecord is (different from territoryNumber).
static boolean isNameless(final int territoryRecord) {
<span class="pc bpc" id="L54" title="3 of 6 branches missed."> assert (0 <= territoryRecord) && (territoryRecord < DATA_MODEL.getNrTerritoryRecords());</span>
<span class="fc bfc" id="L55" title="All 2 branches covered."> return (DATA_MODEL.getDataFlags(territoryRecord) & 64) != 0;</span>
}
// TODO: Need to explain what "special shape" means.
static boolean isSpecialShape(final int territoryRecord) {
<span class="pc bpc" id="L60" title="3 of 6 branches missed."> assert (0 <= territoryRecord) && (territoryRecord < DATA_MODEL.getNrTerritoryRecords());</span>
// TODO: The "magic" of binary operators and bit shifting should be in class DataModel, not here.
<span class="fc bfc" id="L63" title="All 2 branches covered."> return (DATA_MODEL.getDataFlags(territoryRecord) & 1024) != 0;</span>
}
// TODO: Explain what territory record types are. Can they be an enum instead?
static int getTerritoryRecordType(final int territoryRecord) {
<span class="pc bpc" id="L68" title="3 of 6 branches missed."> assert (0 <= territoryRecord) && (territoryRecord < DATA_MODEL.getNrTerritoryRecords());</span>
<span class="fc" id="L69"> return (DATA_MODEL.getDataFlags(territoryRecord) >> 7) & 3; // 1=pipe 2=plus 3=star</span>
}
// TODO: Explain what "restricted" means.
static boolean isRestricted(final int territoryRecord) {
<span class="pc bpc" id="L74" title="3 of 6 branches missed."> assert (0 <= territoryRecord) && (territoryRecord < DATA_MODEL.getNrTerritoryRecords());</span>
<span class="fc bfc" id="L75" title="All 2 branches covered."> return (DATA_MODEL.getDataFlags(territoryRecord) & 512) != 0;</span>
}
static int getCodex(final int territoryRecord) {
<span class="pc bpc" id="L79" title="3 of 6 branches missed."> assert (0 <= territoryRecord) && (territoryRecord < DATA_MODEL.getNrTerritoryRecords());</span>
<span class="fc" id="L80"> final int codexflags = DATA_MODEL.getDataFlags(territoryRecord) & 31;</span>
<span class="fc" id="L81"> return (10 * (codexflags / 5)) + (codexflags % 5) + 1;</span>
}
// TODO: What does this method do? What is parameter i (rename)?
@Nonnull
static String headerLetter(final int i) {
<span class="fc" id="L87"> final int flags = DATA_MODEL.getDataFlags(i);</span>
// TODO: The "magic" of how to interpret flags must be in DataModel, not here.
<span class="fc bfc" id="L90" title="All 2 branches covered."> if (((flags >> 7) & 3) == 1) {</span>
<span class="fc" id="L91"> return Character.toString(ENCODE_CHARS[(flags >> 11) & 31]);</span>
}
<span class="fc" id="L93"> return "";</span>
}
}
</pre><div class="footer"><span class="right">Created with <a href="http://www.jacoco.org/jacoco">JaCoCo</a> 0.8.1.201803210924</span></div></body></html>