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>ECIEncoderSet (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="ECIEncoderSet (ZXing 3.5.1 API)"; 16 } 17 } 18 catch(err) { 19 } 20//--> 21var methods = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":10,"i5":10,"i6":10,"i7":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/ECIEncoderSet.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/common/DetectorResult.html" title="class in com.google.zxing.common"><span class="typeNameLink">Prev Class</span></a></li> 53<li><a href="../../../../com/google/zxing/common/ECIInput.html" title="interface in com.google.zxing.common"><span class="typeNameLink">Next Class</span></a></li> 54</ul> 55<ul class="navList"> 56<li><a href="../../../../index.html?com/google/zxing/common/ECIEncoderSet.html" target="_top">Frames</a></li> 57<li><a href="ECIEncoderSet.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.common</div> 96<h2 title="Class ECIEncoderSet" class="title">Class ECIEncoderSet</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.common.ECIEncoderSet</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">ECIEncoderSet</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<div class="block">Set of CharsetEncoders for a given input string 115 116 Invariants: 117 - The list contains only encoders from CharacterSetECI (list is shorter then the list of encoders available on 118 the platform for which ECI values are defined). 119 - The list contains encoders at least one encoder for every character in the input. 120 - The first encoder in the list is always the ISO-8859-1 encoder even of no character in the input can be encoded 121 by it. 122 - If the input contains a character that is not in ISO-8859-1 then the last two entries in the list will be the 123 UTF-8 encoder and the UTF-16BE encoder.</div> 124<dl> 125<dt><span class="simpleTagLabel">Author:</span></dt> 126<dd>Alex Geller</dd> 127</dl> 128</li> 129</ul> 130</div> 131<div class="summary"> 132<ul class="blockList"> 133<li class="blockList"> 134<!-- ======== CONSTRUCTOR SUMMARY ======== --> 135<ul class="blockList"> 136<li class="blockList"><a name="constructor.summary"> 137<!-- --> 138</a> 139<h3>Constructor Summary</h3> 140<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation"> 141<caption><span>Constructors</span><span class="tabEnd"> </span></caption> 142<tr> 143<th class="colOne" scope="col">Constructor and Description</th> 144</tr> 145<tr class="altColor"> 146<td class="colOne"><code><span class="memberNameLink"><a href="../../../../com/google/zxing/common/ECIEncoderSet.html#ECIEncoderSet-java.lang.String-java.nio.charset.Charset-int-">ECIEncoderSet</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> stringToEncode, 147 <a href="https://docs.oracle.com/javase/8/docs/api/java/nio/charset/Charset.html?is-external=true" title="class or interface in java.nio.charset">Charset</a> priorityCharset, 148 int fnc1)</code> 149<div class="block">Constructs an encoder set</div> 150</td> 151</tr> 152</table> 153</li> 154</ul> 155<!-- ========== METHOD SUMMARY =========== --> 156<ul class="blockList"> 157<li class="blockList"><a name="method.summary"> 158<!-- --> 159</a> 160<h3>Method Summary</h3> 161<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation"> 162<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> 163<tr> 164<th class="colFirst" scope="col">Modifier and Type</th> 165<th class="colLast" scope="col">Method and Description</th> 166</tr> 167<tr id="i0" class="altColor"> 168<td class="colFirst"><code>boolean</code></td> 169<td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/google/zxing/common/ECIEncoderSet.html#canEncode-char-int-">canEncode</a></span>(char c, 170 int encoderIndex)</code> </td> 171</tr> 172<tr id="i1" class="rowColor"> 173<td class="colFirst"><code>byte[]</code></td> 174<td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/google/zxing/common/ECIEncoderSet.html#encode-char-int-">encode</a></span>(char c, 175 int encoderIndex)</code> </td> 176</tr> 177<tr id="i2" class="altColor"> 178<td class="colFirst"><code>byte[]</code></td> 179<td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/google/zxing/common/ECIEncoderSet.html#encode-java.lang.String-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> s, 180 int encoderIndex)</code> </td> 181</tr> 182<tr id="i3" class="rowColor"> 183<td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/nio/charset/Charset.html?is-external=true" title="class or interface in java.nio.charset">Charset</a></code></td> 184<td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/google/zxing/common/ECIEncoderSet.html#getCharset-int-">getCharset</a></span>(int index)</code> </td> 185</tr> 186<tr id="i4" class="altColor"> 187<td class="colFirst"><code><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></code></td> 188<td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/google/zxing/common/ECIEncoderSet.html#getCharsetName-int-">getCharsetName</a></span>(int index)</code> </td> 189</tr> 190<tr id="i5" class="rowColor"> 191<td class="colFirst"><code>int</code></td> 192<td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/google/zxing/common/ECIEncoderSet.html#getECIValue-int-">getECIValue</a></span>(int encoderIndex)</code> </td> 193</tr> 194<tr id="i6" class="altColor"> 195<td class="colFirst"><code>int</code></td> 196<td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/google/zxing/common/ECIEncoderSet.html#getPriorityEncoderIndex--">getPriorityEncoderIndex</a></span>()</code> </td> 197</tr> 198<tr id="i7" class="rowColor"> 199<td class="colFirst"><code>int</code></td> 200<td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/google/zxing/common/ECIEncoderSet.html#length--">length</a></span>()</code> </td> 201</tr> 202</table> 203<ul class="blockList"> 204<li class="blockList"><a name="methods.inherited.from.class.java.lang.Object"> 205<!-- --> 206</a> 207<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> 208<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> 209</ul> 210</li> 211</ul> 212</li> 213</ul> 214</div> 215<div class="details"> 216<ul class="blockList"> 217<li class="blockList"> 218<!-- ========= CONSTRUCTOR DETAIL ======== --> 219<ul class="blockList"> 220<li class="blockList"><a name="constructor.detail"> 221<!-- --> 222</a> 223<h3>Constructor Detail</h3> 224<a name="ECIEncoderSet-java.lang.String-java.nio.charset.Charset-int-"> 225<!-- --> 226</a> 227<ul class="blockListLast"> 228<li class="blockList"> 229<h4>ECIEncoderSet</h4> 230<pre>public ECIEncoderSet(<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> stringToEncode, 231 <a href="https://docs.oracle.com/javase/8/docs/api/java/nio/charset/Charset.html?is-external=true" title="class or interface in java.nio.charset">Charset</a> priorityCharset, 232 int fnc1)</pre> 233<div class="block">Constructs an encoder set</div> 234<dl> 235<dt><span class="paramLabel">Parameters:</span></dt> 236<dd><code>stringToEncode</code> - the string that needs to be encoded</dd> 237<dd><code>priorityCharset</code> - The preferred <a href="https://docs.oracle.com/javase/8/docs/api/java/nio/charset/Charset.html?is-external=true" title="class or interface in java.nio.charset"><code>Charset</code></a> or null.</dd> 238<dd><code>fnc1</code> - fnc1 denotes the character in the input that represents the FNC1 character or -1 for a non-GS1 bar 239 code. When specified, it is considered an error to pass it as argument to the methods canEncode() or encode().</dd> 240</dl> 241</li> 242</ul> 243</li> 244</ul> 245<!-- ============ METHOD DETAIL ========== --> 246<ul class="blockList"> 247<li class="blockList"><a name="method.detail"> 248<!-- --> 249</a> 250<h3>Method Detail</h3> 251<a name="length--"> 252<!-- --> 253</a> 254<ul class="blockList"> 255<li class="blockList"> 256<h4>length</h4> 257<pre>public int length()</pre> 258</li> 259</ul> 260<a name="getCharsetName-int-"> 261<!-- --> 262</a> 263<ul class="blockList"> 264<li class="blockList"> 265<h4>getCharsetName</h4> 266<pre>public <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> getCharsetName(int index)</pre> 267</li> 268</ul> 269<a name="getCharset-int-"> 270<!-- --> 271</a> 272<ul class="blockList"> 273<li class="blockList"> 274<h4>getCharset</h4> 275<pre>public <a href="https://docs.oracle.com/javase/8/docs/api/java/nio/charset/Charset.html?is-external=true" title="class or interface in java.nio.charset">Charset</a> getCharset(int index)</pre> 276</li> 277</ul> 278<a name="getECIValue-int-"> 279<!-- --> 280</a> 281<ul class="blockList"> 282<li class="blockList"> 283<h4>getECIValue</h4> 284<pre>public int getECIValue(int encoderIndex)</pre> 285</li> 286</ul> 287<a name="getPriorityEncoderIndex--"> 288<!-- --> 289</a> 290<ul class="blockList"> 291<li class="blockList"> 292<h4>getPriorityEncoderIndex</h4> 293<pre>public int getPriorityEncoderIndex()</pre> 294</li> 295</ul> 296<a name="canEncode-char-int-"> 297<!-- --> 298</a> 299<ul class="blockList"> 300<li class="blockList"> 301<h4>canEncode</h4> 302<pre>public boolean canEncode(char c, 303 int encoderIndex)</pre> 304</li> 305</ul> 306<a name="encode-char-int-"> 307<!-- --> 308</a> 309<ul class="blockList"> 310<li class="blockList"> 311<h4>encode</h4> 312<pre>public byte[] encode(char c, 313 int encoderIndex)</pre> 314</li> 315</ul> 316<a name="encode-java.lang.String-int-"> 317<!-- --> 318</a> 319<ul class="blockListLast"> 320<li class="blockList"> 321<h4>encode</h4> 322<pre>public byte[] 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> s, 323 int encoderIndex)</pre> 324</li> 325</ul> 326</li> 327</ul> 328</li> 329</ul> 330</div> 331</div> 332<!-- ========= END OF CLASS DATA ========= --> 333<!-- ======= START OF BOTTOM NAVBAR ====== --> 334<div class="bottomNav"><a name="navbar.bottom"> 335<!-- --> 336</a> 337<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div> 338<a name="navbar.bottom.firstrow"> 339<!-- --> 340</a> 341<ul class="navList" title="Navigation"> 342<li><a href="../../../../overview-summary.html">Overview</a></li> 343<li><a href="package-summary.html">Package</a></li> 344<li class="navBarCell1Rev">Class</li> 345<li><a href="class-use/ECIEncoderSet.html">Use</a></li> 346<li><a href="package-tree.html">Tree</a></li> 347<li><a href="../../../../deprecated-list.html">Deprecated</a></li> 348<li><a href="../../../../index-all.html">Index</a></li> 349<li><a href="../../../../help-doc.html">Help</a></li> 350</ul> 351</div> 352<div class="subNav"> 353<ul class="navList"> 354<li><a href="../../../../com/google/zxing/common/DetectorResult.html" title="class in com.google.zxing.common"><span class="typeNameLink">Prev Class</span></a></li> 355<li><a href="../../../../com/google/zxing/common/ECIInput.html" title="interface in com.google.zxing.common"><span class="typeNameLink">Next Class</span></a></li> 356</ul> 357<ul class="navList"> 358<li><a href="../../../../index.html?com/google/zxing/common/ECIEncoderSet.html" target="_top">Frames</a></li> 359<li><a href="ECIEncoderSet.html" target="_top">No Frames</a></li> 360</ul> 361<ul class="navList" id="allclasses_navbar_bottom"> 362<li><a href="../../../../allclasses-noframe.html">All Classes</a></li> 363</ul> 364<div> 365<script type="text/javascript"><!-- 366 allClassesLink = document.getElementById("allclasses_navbar_bottom"); 367 if(window==top) { 368 allClassesLink.style.display = "block"; 369 } 370 else { 371 allClassesLink.style.display = "none"; 372 } 373 //--> 374</script> 375</div> 376<div> 377<ul class="subNavList"> 378<li>Summary: </li> 379<li>Nested | </li> 380<li>Field | </li> 381<li><a href="#constructor.summary">Constr</a> | </li> 382<li><a href="#method.summary">Method</a></li> 383</ul> 384<ul class="subNavList"> 385<li>Detail: </li> 386<li>Field | </li> 387<li><a href="#constructor.detail">Constr</a> | </li> 388<li><a href="#method.detail">Method</a></li> 389</ul> 390</div> 391<a name="skip.navbar.bottom"> 392<!-- --> 393</a></div> 394<!-- ======== END OF BOTTOM NAVBAR ======= --> 395<p class="legalCopy"><small>Copyright © 2007–2022. All rights reserved.</small></p> 396</body> 397</html> 398