xref: /aosp_15_r20/external/zxing/docs/apidocs/com/google/zxing/oned/UPCEWriter.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>UPCEWriter (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="UPCEWriter (ZXing 3.5.1 API)";
16        }
17    }
18    catch(err) {
19    }
20//-->
21var methods = {"i0":10,"i1":10};
22var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],8:["t4","Concrete 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/UPCEWriter.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><a href="../../../../com/google/zxing/oned/UPCEReader.html" title="class in com.google.zxing.oned"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
53<li>Next&nbsp;Class</li>
54</ul>
55<ul class="navList">
56<li><a href="../../../../index.html?com/google/zxing/oned/UPCEWriter.html" target="_top">Frames</a></li>
57<li><a href="UPCEWriter.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>Field&nbsp;|&nbsp;</li>
79<li><a href="#constructor.summary">Constr</a>&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>Field&nbsp;|&nbsp;</li>
85<li><a href="#constructor.detail">Constr</a>&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.oned</div>
96<h2 title="Class UPCEWriter" class="title">Class UPCEWriter</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><a href="../../../../com/google/zxing/oned/OneDimensionalCodeWriter.html" title="class in com.google.zxing.oned">com.google.zxing.oned.OneDimensionalCodeWriter</a></li>
104<li>
105<ul class="inheritance">
106<li><a href="../../../../com/google/zxing/oned/UPCEANWriter.html" title="class in com.google.zxing.oned">com.google.zxing.oned.UPCEANWriter</a></li>
107<li>
108<ul class="inheritance">
109<li>com.google.zxing.oned.UPCEWriter</li>
110</ul>
111</li>
112</ul>
113</li>
114</ul>
115</li>
116</ul>
117<div class="description">
118<ul class="blockList">
119<li class="blockList">
120<dl>
121<dt>All Implemented Interfaces:</dt>
122<dd><a href="../../../../com/google/zxing/Writer.html" title="interface in com.google.zxing">Writer</a></dd>
123</dl>
124<hr>
125<br>
126<pre>public final class <span class="typeNameLabel">UPCEWriter</span>
127extends <a href="../../../../com/google/zxing/oned/UPCEANWriter.html" title="class in com.google.zxing.oned">UPCEANWriter</a></pre>
128<div class="block">This object renders an UPC-E code as a <a href="../../../../com/google/zxing/common/BitMatrix.html" title="class in com.google.zxing.common"><code>BitMatrix</code></a>.</div>
129<dl>
130<dt><span class="simpleTagLabel">Author:</span></dt>
131<dd>[email protected] (RX)</dd>
132</dl>
133</li>
134</ul>
135</div>
136<div class="summary">
137<ul class="blockList">
138<li class="blockList">
139<!-- ======== CONSTRUCTOR SUMMARY ======== -->
140<ul class="blockList">
141<li class="blockList"><a name="constructor.summary">
142<!--   -->
143</a>
144<h3>Constructor Summary</h3>
145<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation">
146<caption><span>Constructors</span><span class="tabEnd">&nbsp;</span></caption>
147<tr>
148<th class="colOne" scope="col">Constructor and Description</th>
149</tr>
150<tr class="altColor">
151<td class="colOne"><code><span class="memberNameLink"><a href="../../../../com/google/zxing/oned/UPCEWriter.html#UPCEWriter--">UPCEWriter</a></span>()</code>&nbsp;</td>
152</tr>
153</table>
154</li>
155</ul>
156<!-- ========== METHOD SUMMARY =========== -->
157<ul class="blockList">
158<li class="blockList"><a name="method.summary">
159<!--   -->
160</a>
161<h3>Method Summary</h3>
162<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
163<caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd">&nbsp;</span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance 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></caption>
164<tr>
165<th class="colFirst" scope="col">Modifier and Type</th>
166<th class="colLast" scope="col">Method and Description</th>
167</tr>
168<tr id="i0" class="altColor">
169<td class="colFirst"><code>boolean[]</code></td>
170<td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/google/zxing/oned/UPCEWriter.html#encode-java.lang.String-">encode</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;contents)</code>
171<div class="block">Encode the contents to boolean array expression of one-dimensional barcode.</div>
172</td>
173</tr>
174<tr id="i1" class="rowColor">
175<td class="colFirst"><code>protected <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="../../../../com/google/zxing/BarcodeFormat.html" title="enum in com.google.zxing">BarcodeFormat</a>&gt;</code></td>
176<td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/google/zxing/oned/UPCEWriter.html#getSupportedWriteFormats--">getSupportedWriteFormats</a></span>()</code>&nbsp;</td>
177</tr>
178</table>
179<ul class="blockList">
180<li class="blockList"><a name="methods.inherited.from.class.com.google.zxing.oned.UPCEANWriter">
181<!--   -->
182</a>
183<h3>Methods inherited from class&nbsp;com.google.zxing.oned.<a href="../../../../com/google/zxing/oned/UPCEANWriter.html" title="class in com.google.zxing.oned">UPCEANWriter</a></h3>
184<code><a href="../../../../com/google/zxing/oned/UPCEANWriter.html#getDefaultMargin--">getDefaultMargin</a></code></li>
185</ul>
186<ul class="blockList">
187<li class="blockList"><a name="methods.inherited.from.class.com.google.zxing.oned.OneDimensionalCodeWriter">
188<!--   -->
189</a>
190<h3>Methods inherited from class&nbsp;com.google.zxing.oned.<a href="../../../../com/google/zxing/oned/OneDimensionalCodeWriter.html" title="class in com.google.zxing.oned">OneDimensionalCodeWriter</a></h3>
191<code><a href="../../../../com/google/zxing/oned/OneDimensionalCodeWriter.html#appendPattern-boolean:A-int-int:A-boolean-">appendPattern</a>, <a href="../../../../com/google/zxing/oned/OneDimensionalCodeWriter.html#checkNumeric-java.lang.String-">checkNumeric</a>, <a href="../../../../com/google/zxing/oned/OneDimensionalCodeWriter.html#encode-java.lang.String-com.google.zxing.BarcodeFormat-int-int-">encode</a>, <a href="../../../../com/google/zxing/oned/OneDimensionalCodeWriter.html#encode-java.lang.String-com.google.zxing.BarcodeFormat-int-int-java.util.Map-">encode</a>, <a href="../../../../com/google/zxing/oned/OneDimensionalCodeWriter.html#encode-java.lang.String-java.util.Map-">encode</a></code></li>
192</ul>
193<ul class="blockList">
194<li class="blockList"><a name="methods.inherited.from.class.java.lang.Object">
195<!--   -->
196</a>
197<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>
198<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>
199</ul>
200</li>
201</ul>
202</li>
203</ul>
204</div>
205<div class="details">
206<ul class="blockList">
207<li class="blockList">
208<!-- ========= CONSTRUCTOR DETAIL ======== -->
209<ul class="blockList">
210<li class="blockList"><a name="constructor.detail">
211<!--   -->
212</a>
213<h3>Constructor Detail</h3>
214<a name="UPCEWriter--">
215<!--   -->
216</a>
217<ul class="blockListLast">
218<li class="blockList">
219<h4>UPCEWriter</h4>
220<pre>public&nbsp;UPCEWriter()</pre>
221</li>
222</ul>
223</li>
224</ul>
225<!-- ============ METHOD DETAIL ========== -->
226<ul class="blockList">
227<li class="blockList"><a name="method.detail">
228<!--   -->
229</a>
230<h3>Method Detail</h3>
231<a name="getSupportedWriteFormats--">
232<!--   -->
233</a>
234<ul class="blockList">
235<li class="blockList">
236<h4>getSupportedWriteFormats</h4>
237<pre>protected&nbsp;<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="../../../../com/google/zxing/BarcodeFormat.html" title="enum in com.google.zxing">BarcodeFormat</a>&gt;&nbsp;getSupportedWriteFormats()</pre>
238<dl>
239<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
240<dd><code><a href="../../../../com/google/zxing/oned/OneDimensionalCodeWriter.html#getSupportedWriteFormats--">getSupportedWriteFormats</a></code>&nbsp;in class&nbsp;<code><a href="../../../../com/google/zxing/oned/OneDimensionalCodeWriter.html" title="class in com.google.zxing.oned">OneDimensionalCodeWriter</a></code></dd>
241</dl>
242</li>
243</ul>
244<a name="encode-java.lang.String-">
245<!--   -->
246</a>
247<ul class="blockListLast">
248<li class="blockList">
249<h4>encode</h4>
250<pre>public&nbsp;boolean[]&nbsp;encode(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;contents)</pre>
251<div class="block"><span class="descfrmTypeLabel">Description copied from class:&nbsp;<code><a href="../../../../com/google/zxing/oned/OneDimensionalCodeWriter.html#encode-java.lang.String-">OneDimensionalCodeWriter</a></code></span></div>
252<div class="block">Encode the contents to boolean array expression of one-dimensional barcode.
253 Start code and end code should be included in result, and side margins should not be included.</div>
254<dl>
255<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
256<dd><code><a href="../../../../com/google/zxing/oned/OneDimensionalCodeWriter.html#encode-java.lang.String-">encode</a></code>&nbsp;in class&nbsp;<code><a href="../../../../com/google/zxing/oned/OneDimensionalCodeWriter.html" title="class in com.google.zxing.oned">OneDimensionalCodeWriter</a></code></dd>
257<dt><span class="paramLabel">Parameters:</span></dt>
258<dd><code>contents</code> - barcode contents to encode</dd>
259<dt><span class="returnLabel">Returns:</span></dt>
260<dd>a <code>boolean[]</code> of horizontal pixels (false = white, true = black)</dd>
261</dl>
262</li>
263</ul>
264</li>
265</ul>
266</li>
267</ul>
268</div>
269</div>
270<!-- ========= END OF CLASS DATA ========= -->
271<!-- ======= START OF BOTTOM NAVBAR ====== -->
272<div class="bottomNav"><a name="navbar.bottom">
273<!--   -->
274</a>
275<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
276<a name="navbar.bottom.firstrow">
277<!--   -->
278</a>
279<ul class="navList" title="Navigation">
280<li><a href="../../../../overview-summary.html">Overview</a></li>
281<li><a href="package-summary.html">Package</a></li>
282<li class="navBarCell1Rev">Class</li>
283<li><a href="class-use/UPCEWriter.html">Use</a></li>
284<li><a href="package-tree.html">Tree</a></li>
285<li><a href="../../../../deprecated-list.html">Deprecated</a></li>
286<li><a href="../../../../index-all.html">Index</a></li>
287<li><a href="../../../../help-doc.html">Help</a></li>
288</ul>
289</div>
290<div class="subNav">
291<ul class="navList">
292<li><a href="../../../../com/google/zxing/oned/UPCEReader.html" title="class in com.google.zxing.oned"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
293<li>Next&nbsp;Class</li>
294</ul>
295<ul class="navList">
296<li><a href="../../../../index.html?com/google/zxing/oned/UPCEWriter.html" target="_top">Frames</a></li>
297<li><a href="UPCEWriter.html" target="_top">No&nbsp;Frames</a></li>
298</ul>
299<ul class="navList" id="allclasses_navbar_bottom">
300<li><a href="../../../../allclasses-noframe.html">All&nbsp;Classes</a></li>
301</ul>
302<div>
303<script type="text/javascript"><!--
304  allClassesLink = document.getElementById("allclasses_navbar_bottom");
305  if(window==top) {
306    allClassesLink.style.display = "block";
307  }
308  else {
309    allClassesLink.style.display = "none";
310  }
311  //-->
312</script>
313</div>
314<div>
315<ul class="subNavList">
316<li>Summary:&nbsp;</li>
317<li>Nested&nbsp;|&nbsp;</li>
318<li>Field&nbsp;|&nbsp;</li>
319<li><a href="#constructor.summary">Constr</a>&nbsp;|&nbsp;</li>
320<li><a href="#method.summary">Method</a></li>
321</ul>
322<ul class="subNavList">
323<li>Detail:&nbsp;</li>
324<li>Field&nbsp;|&nbsp;</li>
325<li><a href="#constructor.detail">Constr</a>&nbsp;|&nbsp;</li>
326<li><a href="#method.detail">Method</a></li>
327</ul>
328</div>
329<a name="skip.navbar.bottom">
330<!--   -->
331</a></div>
332<!-- ======== END OF BOTTOM NAVBAR ======= -->
333<p class="legalCopy"><small>Copyright &#169; 2007&#x2013;2022. All rights reserved.</small></p>
334</body>
335</html>
336