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