xref: /aosp_15_r20/external/zxing/docs/apidocs/com/google/zxing/pdf417/PDF417Common.html (revision 513427e33d61bc67fc40bc261642ac0b2a686b45)
1<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
2<!-- NewPage -->
3<html lang="en">
4<head>
5<!-- Generated by javadoc -->
6<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
7<title>PDF417Common (ZXing 3.5.1 API)</title>
8<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style">
9<script type="text/javascript" src="../../../../script.js"></script>
10</head>
11<body>
12<script type="text/javascript"><!--
13    try {
14        if (location.href.indexOf('is-external=true') == -1) {
15            parent.document.title="PDF417Common (ZXing 3.5.1 API)";
16        }
17    }
18    catch(err) {
19    }
20//-->
21var methods = {"i0":41,"i1":9,"i2":9};
22var tabs = {65535:["t0","All Methods"],1:["t1","Static Methods"],8:["t4","Concrete Methods"],32:["t6","Deprecated Methods"]};
23var altColor = "altColor";
24var rowColor = "rowColor";
25var tableTab = "tableTab";
26var activeTableTab = "activeTableTab";
27</script>
28<noscript>
29<div>JavaScript is disabled on your browser.</div>
30</noscript>
31<!-- ========= START OF TOP NAVBAR ======= -->
32<div class="topNav"><a name="navbar.top">
33<!--   -->
34</a>
35<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div>
36<a name="navbar.top.firstrow">
37<!--   -->
38</a>
39<ul class="navList" title="Navigation">
40<li><a href="../../../../overview-summary.html">Overview</a></li>
41<li><a href="package-summary.html">Package</a></li>
42<li class="navBarCell1Rev">Class</li>
43<li><a href="class-use/PDF417Common.html">Use</a></li>
44<li><a href="package-tree.html">Tree</a></li>
45<li><a href="../../../../deprecated-list.html">Deprecated</a></li>
46<li><a href="../../../../index-all.html">Index</a></li>
47<li><a href="../../../../help-doc.html">Help</a></li>
48</ul>
49</div>
50<div class="subNav">
51<ul class="navList">
52<li>Prev&nbsp;Class</li>
53<li><a href="../../../../com/google/zxing/pdf417/PDF417Reader.html" title="class in com.google.zxing.pdf417"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
54</ul>
55<ul class="navList">
56<li><a href="../../../../index.html?com/google/zxing/pdf417/PDF417Common.html" target="_top">Frames</a></li>
57<li><a href="PDF417Common.html" target="_top">No&nbsp;Frames</a></li>
58</ul>
59<ul class="navList" id="allclasses_navbar_top">
60<li><a href="../../../../allclasses-noframe.html">All&nbsp;Classes</a></li>
61</ul>
62<div>
63<script type="text/javascript"><!--
64  allClassesLink = document.getElementById("allclasses_navbar_top");
65  if(window==top) {
66    allClassesLink.style.display = "block";
67  }
68  else {
69    allClassesLink.style.display = "none";
70  }
71  //-->
72</script>
73</div>
74<div>
75<ul class="subNavList">
76<li>Summary:&nbsp;</li>
77<li>Nested&nbsp;|&nbsp;</li>
78<li><a href="#field.summary">Field</a>&nbsp;|&nbsp;</li>
79<li>Constr&nbsp;|&nbsp;</li>
80<li><a href="#method.summary">Method</a></li>
81</ul>
82<ul class="subNavList">
83<li>Detail:&nbsp;</li>
84<li><a href="#field.detail">Field</a>&nbsp;|&nbsp;</li>
85<li>Constr&nbsp;|&nbsp;</li>
86<li><a href="#method.detail">Method</a></li>
87</ul>
88</div>
89<a name="skip.navbar.top">
90<!--   -->
91</a></div>
92<!-- ========= END OF TOP NAVBAR ========= -->
93<!-- ======== START OF CLASS DATA ======== -->
94<div class="header">
95<div class="subTitle">com.google.zxing.pdf417</div>
96<h2 title="Class PDF417Common" class="title">Class PDF417Common</h2>
97</div>
98<div class="contentContainer">
99<ul class="inheritance">
100<li><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">java.lang.Object</a></li>
101<li>
102<ul class="inheritance">
103<li>com.google.zxing.pdf417.PDF417Common</li>
104</ul>
105</li>
106</ul>
107<div class="description">
108<ul class="blockList">
109<li class="blockList">
110<hr>
111<br>
112<pre>public final class <span class="typeNameLabel">PDF417Common</span>
113extends <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></pre>
114<dl>
115<dt><span class="simpleTagLabel">Author:</span></dt>
116<dd>SITA Lab ([email protected]), Guenther Grau</dd>
117</dl>
118</li>
119</ul>
120</div>
121<div class="summary">
122<ul class="blockList">
123<li class="blockList">
124<!-- =========== FIELD SUMMARY =========== -->
125<ul class="blockList">
126<li class="blockList"><a name="field.summary">
127<!--   -->
128</a>
129<h3>Field Summary</h3>
130<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Field Summary table, listing fields, and an explanation">
131<caption><span>Fields</span><span class="tabEnd">&nbsp;</span></caption>
132<tr>
133<th class="colFirst" scope="col">Modifier and Type</th>
134<th class="colLast" scope="col">Field and Description</th>
135</tr>
136<tr class="altColor">
137<td class="colFirst"><code>static int</code></td>
138<td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/google/zxing/pdf417/PDF417Common.html#BARS_IN_MODULE">BARS_IN_MODULE</a></span></code>&nbsp;</td>
139</tr>
140<tr class="rowColor">
141<td class="colFirst"><code>static int</code></td>
142<td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/google/zxing/pdf417/PDF417Common.html#MAX_CODEWORDS_IN_BARCODE">MAX_CODEWORDS_IN_BARCODE</a></span></code>&nbsp;</td>
143</tr>
144<tr class="altColor">
145<td class="colFirst"><code>static int</code></td>
146<td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/google/zxing/pdf417/PDF417Common.html#MAX_ROWS_IN_BARCODE">MAX_ROWS_IN_BARCODE</a></span></code>&nbsp;</td>
147</tr>
148<tr class="rowColor">
149<td class="colFirst"><code>static int</code></td>
150<td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/google/zxing/pdf417/PDF417Common.html#MIN_ROWS_IN_BARCODE">MIN_ROWS_IN_BARCODE</a></span></code>&nbsp;</td>
151</tr>
152<tr class="altColor">
153<td class="colFirst"><code>static int</code></td>
154<td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/google/zxing/pdf417/PDF417Common.html#MODULES_IN_CODEWORD">MODULES_IN_CODEWORD</a></span></code>&nbsp;</td>
155</tr>
156<tr class="rowColor">
157<td class="colFirst"><code>static int</code></td>
158<td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/google/zxing/pdf417/PDF417Common.html#MODULES_IN_STOP_PATTERN">MODULES_IN_STOP_PATTERN</a></span></code>&nbsp;</td>
159</tr>
160<tr class="altColor">
161<td class="colFirst"><code>static int</code></td>
162<td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/google/zxing/pdf417/PDF417Common.html#NUMBER_OF_CODEWORDS">NUMBER_OF_CODEWORDS</a></span></code>&nbsp;</td>
163</tr>
164<tr class="rowColor">
165<td class="colFirst"><code>static int[]</code></td>
166<td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/google/zxing/pdf417/PDF417Common.html#SYMBOL_TABLE">SYMBOL_TABLE</a></span></code>
167<div class="block">The sorted table of all possible symbols.</div>
168</td>
169</tr>
170</table>
171</li>
172</ul>
173<!-- ========== METHOD SUMMARY =========== -->
174<ul class="blockList">
175<li class="blockList"><a name="method.summary">
176<!--   -->
177</a>
178<h3>Method Summary</h3>
179<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
180<caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd">&nbsp;</span></span><span id="t1" class="tableTab"><span><a href="javascript:show(1);">Static Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t6" class="tableTab"><span><a href="javascript:show(32);">Deprecated Methods</a></span><span class="tabEnd">&nbsp;</span></span></caption>
181<tr>
182<th class="colFirst" scope="col">Modifier and Type</th>
183<th class="colLast" scope="col">Method and Description</th>
184</tr>
185<tr id="i0" class="altColor">
186<td class="colFirst"><code>static int</code></td>
187<td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/google/zxing/pdf417/PDF417Common.html#getBitCountSum-int:A-">getBitCountSum</a></span>(int[]&nbsp;moduleBitCount)</code>
188<div class="block"><span class="deprecatedLabel">Deprecated.</span>&nbsp;
189<div class="block"><span class="deprecationComment">call <a href="../../../../com/google/zxing/common/detector/MathUtils.html#sum-int:A-"><code>MathUtils.sum(int[])</code></a></span></div>
190</div>
191</td>
192</tr>
193<tr id="i1" class="rowColor">
194<td class="colFirst"><code>static int</code></td>
195<td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/google/zxing/pdf417/PDF417Common.html#getCodeword-int-">getCodeword</a></span>(int&nbsp;symbol)</code>&nbsp;</td>
196</tr>
197<tr id="i2" class="altColor">
198<td class="colFirst"><code>static int[]</code></td>
199<td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/google/zxing/pdf417/PDF417Common.html#toIntArray-java.util.Collection-">toIntArray</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/util/Collection.html?is-external=true" title="class or interface in java.util">Collection</a>&lt;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Integer.html?is-external=true" title="class or interface in java.lang">Integer</a>&gt;&nbsp;list)</code>&nbsp;</td>
200</tr>
201</table>
202<ul class="blockList">
203<li class="blockList"><a name="methods.inherited.from.class.java.lang.Object">
204<!--   -->
205</a>
206<h3>Methods inherited from class&nbsp;java.lang.<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></h3>
207<code><a href="https://docs.oracle.com/javase/8/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/8/docs/api/java/lang/Object.html?is-external=true#equals-java.lang.Object-" title="class or interface in java.lang">equals</a>, <a href="https://docs.oracle.com/javase/8/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/8/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/8/docs/api/java/lang/Object.html?is-external=true#hashCode--" title="class or interface in java.lang">hashCode</a>, <a href="https://docs.oracle.com/javase/8/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/8/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/8/docs/api/java/lang/Object.html?is-external=true#toString--" title="class or interface in java.lang">toString</a>, <a href="https://docs.oracle.com/javase/8/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/8/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/8/docs/api/java/lang/Object.html?is-external=true#wait-long-int-" title="class or interface in java.lang">wait</a></code></li>
208</ul>
209</li>
210</ul>
211</li>
212</ul>
213</div>
214<div class="details">
215<ul class="blockList">
216<li class="blockList">
217<!-- ============ FIELD DETAIL =========== -->
218<ul class="blockList">
219<li class="blockList"><a name="field.detail">
220<!--   -->
221</a>
222<h3>Field Detail</h3>
223<a name="NUMBER_OF_CODEWORDS">
224<!--   -->
225</a>
226<ul class="blockList">
227<li class="blockList">
228<h4>NUMBER_OF_CODEWORDS</h4>
229<pre>public static final&nbsp;int NUMBER_OF_CODEWORDS</pre>
230<dl>
231<dt><span class="seeLabel">See Also:</span></dt>
232<dd><a href="../../../../constant-values.html#com.google.zxing.pdf417.PDF417Common.NUMBER_OF_CODEWORDS">Constant Field Values</a></dd>
233</dl>
234</li>
235</ul>
236<a name="MAX_CODEWORDS_IN_BARCODE">
237<!--   -->
238</a>
239<ul class="blockList">
240<li class="blockList">
241<h4>MAX_CODEWORDS_IN_BARCODE</h4>
242<pre>public static final&nbsp;int MAX_CODEWORDS_IN_BARCODE</pre>
243<dl>
244<dt><span class="seeLabel">See Also:</span></dt>
245<dd><a href="../../../../constant-values.html#com.google.zxing.pdf417.PDF417Common.MAX_CODEWORDS_IN_BARCODE">Constant Field Values</a></dd>
246</dl>
247</li>
248</ul>
249<a name="MIN_ROWS_IN_BARCODE">
250<!--   -->
251</a>
252<ul class="blockList">
253<li class="blockList">
254<h4>MIN_ROWS_IN_BARCODE</h4>
255<pre>public static final&nbsp;int MIN_ROWS_IN_BARCODE</pre>
256<dl>
257<dt><span class="seeLabel">See Also:</span></dt>
258<dd><a href="../../../../constant-values.html#com.google.zxing.pdf417.PDF417Common.MIN_ROWS_IN_BARCODE">Constant Field Values</a></dd>
259</dl>
260</li>
261</ul>
262<a name="MAX_ROWS_IN_BARCODE">
263<!--   -->
264</a>
265<ul class="blockList">
266<li class="blockList">
267<h4>MAX_ROWS_IN_BARCODE</h4>
268<pre>public static final&nbsp;int MAX_ROWS_IN_BARCODE</pre>
269<dl>
270<dt><span class="seeLabel">See Also:</span></dt>
271<dd><a href="../../../../constant-values.html#com.google.zxing.pdf417.PDF417Common.MAX_ROWS_IN_BARCODE">Constant Field Values</a></dd>
272</dl>
273</li>
274</ul>
275<a name="MODULES_IN_CODEWORD">
276<!--   -->
277</a>
278<ul class="blockList">
279<li class="blockList">
280<h4>MODULES_IN_CODEWORD</h4>
281<pre>public static final&nbsp;int MODULES_IN_CODEWORD</pre>
282<dl>
283<dt><span class="seeLabel">See Also:</span></dt>
284<dd><a href="../../../../constant-values.html#com.google.zxing.pdf417.PDF417Common.MODULES_IN_CODEWORD">Constant Field Values</a></dd>
285</dl>
286</li>
287</ul>
288<a name="MODULES_IN_STOP_PATTERN">
289<!--   -->
290</a>
291<ul class="blockList">
292<li class="blockList">
293<h4>MODULES_IN_STOP_PATTERN</h4>
294<pre>public static final&nbsp;int MODULES_IN_STOP_PATTERN</pre>
295<dl>
296<dt><span class="seeLabel">See Also:</span></dt>
297<dd><a href="../../../../constant-values.html#com.google.zxing.pdf417.PDF417Common.MODULES_IN_STOP_PATTERN">Constant Field Values</a></dd>
298</dl>
299</li>
300</ul>
301<a name="BARS_IN_MODULE">
302<!--   -->
303</a>
304<ul class="blockList">
305<li class="blockList">
306<h4>BARS_IN_MODULE</h4>
307<pre>public static final&nbsp;int BARS_IN_MODULE</pre>
308<dl>
309<dt><span class="seeLabel">See Also:</span></dt>
310<dd><a href="../../../../constant-values.html#com.google.zxing.pdf417.PDF417Common.BARS_IN_MODULE">Constant Field Values</a></dd>
311</dl>
312</li>
313</ul>
314<a name="SYMBOL_TABLE">
315<!--   -->
316</a>
317<ul class="blockListLast">
318<li class="blockList">
319<h4>SYMBOL_TABLE</h4>
320<pre>public static final&nbsp;int[] SYMBOL_TABLE</pre>
321<div class="block">The sorted table of all possible symbols. Extracted from the PDF417
322 specification. The index of a symbol in this table corresponds to the
323 index into the codeword table.</div>
324</li>
325</ul>
326</li>
327</ul>
328<!-- ============ METHOD DETAIL ========== -->
329<ul class="blockList">
330<li class="blockList"><a name="method.detail">
331<!--   -->
332</a>
333<h3>Method Detail</h3>
334<a name="getBitCountSum-int:A-">
335<!--   -->
336</a>
337<ul class="blockList">
338<li class="blockList">
339<h4>getBitCountSum</h4>
340<pre><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Deprecated.html?is-external=true" title="class or interface in java.lang">@Deprecated</a>
341public static&nbsp;int&nbsp;getBitCountSum(int[]&nbsp;moduleBitCount)</pre>
342<div class="block"><span class="deprecatedLabel">Deprecated.</span>&nbsp;<span class="deprecationComment">call <a href="../../../../com/google/zxing/common/detector/MathUtils.html#sum-int:A-"><code>MathUtils.sum(int[])</code></a></span></div>
343<dl>
344<dt><span class="paramLabel">Parameters:</span></dt>
345<dd><code>moduleBitCount</code> - values to sum</dd>
346<dt><span class="returnLabel">Returns:</span></dt>
347<dd>sum of values</dd>
348</dl>
349</li>
350</ul>
351<a name="toIntArray-java.util.Collection-">
352<!--   -->
353</a>
354<ul class="blockList">
355<li class="blockList">
356<h4>toIntArray</h4>
357<pre>public static&nbsp;int[]&nbsp;toIntArray(<a href="https://docs.oracle.com/javase/8/docs/api/java/util/Collection.html?is-external=true" title="class or interface in java.util">Collection</a>&lt;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Integer.html?is-external=true" title="class or interface in java.lang">Integer</a>&gt;&nbsp;list)</pre>
358</li>
359</ul>
360<a name="getCodeword-int-">
361<!--   -->
362</a>
363<ul class="blockListLast">
364<li class="blockList">
365<h4>getCodeword</h4>
366<pre>public static&nbsp;int&nbsp;getCodeword(int&nbsp;symbol)</pre>
367<dl>
368<dt><span class="paramLabel">Parameters:</span></dt>
369<dd><code>symbol</code> - encoded symbol to translate to a codeword</dd>
370<dt><span class="returnLabel">Returns:</span></dt>
371<dd>the codeword corresponding to the symbol.</dd>
372</dl>
373</li>
374</ul>
375</li>
376</ul>
377</li>
378</ul>
379</div>
380</div>
381<!-- ========= END OF CLASS DATA ========= -->
382<!-- ======= START OF BOTTOM NAVBAR ====== -->
383<div class="bottomNav"><a name="navbar.bottom">
384<!--   -->
385</a>
386<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
387<a name="navbar.bottom.firstrow">
388<!--   -->
389</a>
390<ul class="navList" title="Navigation">
391<li><a href="../../../../overview-summary.html">Overview</a></li>
392<li><a href="package-summary.html">Package</a></li>
393<li class="navBarCell1Rev">Class</li>
394<li><a href="class-use/PDF417Common.html">Use</a></li>
395<li><a href="package-tree.html">Tree</a></li>
396<li><a href="../../../../deprecated-list.html">Deprecated</a></li>
397<li><a href="../../../../index-all.html">Index</a></li>
398<li><a href="../../../../help-doc.html">Help</a></li>
399</ul>
400</div>
401<div class="subNav">
402<ul class="navList">
403<li>Prev&nbsp;Class</li>
404<li><a href="../../../../com/google/zxing/pdf417/PDF417Reader.html" title="class in com.google.zxing.pdf417"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
405</ul>
406<ul class="navList">
407<li><a href="../../../../index.html?com/google/zxing/pdf417/PDF417Common.html" target="_top">Frames</a></li>
408<li><a href="PDF417Common.html" target="_top">No&nbsp;Frames</a></li>
409</ul>
410<ul class="navList" id="allclasses_navbar_bottom">
411<li><a href="../../../../allclasses-noframe.html">All&nbsp;Classes</a></li>
412</ul>
413<div>
414<script type="text/javascript"><!--
415  allClassesLink = document.getElementById("allclasses_navbar_bottom");
416  if(window==top) {
417    allClassesLink.style.display = "block";
418  }
419  else {
420    allClassesLink.style.display = "none";
421  }
422  //-->
423</script>
424</div>
425<div>
426<ul class="subNavList">
427<li>Summary:&nbsp;</li>
428<li>Nested&nbsp;|&nbsp;</li>
429<li><a href="#field.summary">Field</a>&nbsp;|&nbsp;</li>
430<li>Constr&nbsp;|&nbsp;</li>
431<li><a href="#method.summary">Method</a></li>
432</ul>
433<ul class="subNavList">
434<li>Detail:&nbsp;</li>
435<li><a href="#field.detail">Field</a>&nbsp;|&nbsp;</li>
436<li>Constr&nbsp;|&nbsp;</li>
437<li><a href="#method.detail">Method</a></li>
438</ul>
439</div>
440<a name="skip.navbar.bottom">
441<!--   -->
442</a></div>
443<!-- ======== END OF BOTTOM NAVBAR ======= -->
444<p class="legalCopy"><small>Copyright &#169; 2007&#x2013;2022. All rights reserved.</small></p>
445</body>
446</html>
447