1*513427e3STreehugger Robot<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> 2*513427e3STreehugger Robot<!-- NewPage --> 3*513427e3STreehugger Robot<html lang="en"> 4*513427e3STreehugger Robot<head> 5*513427e3STreehugger Robot<!-- Generated by javadoc --> 6*513427e3STreehugger Robot<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> 7*513427e3STreehugger Robot<title>API Help (ZXing 3.5.1 API)</title> 8*513427e3STreehugger Robot<link rel="stylesheet" type="text/css" href="stylesheet.css" title="Style"> 9*513427e3STreehugger Robot<script type="text/javascript" src="script.js"></script> 10*513427e3STreehugger Robot</head> 11*513427e3STreehugger Robot<body> 12*513427e3STreehugger Robot<script type="text/javascript"><!-- 13*513427e3STreehugger Robot try { 14*513427e3STreehugger Robot if (location.href.indexOf('is-external=true') == -1) { 15*513427e3STreehugger Robot parent.document.title="API Help (ZXing 3.5.1 API)"; 16*513427e3STreehugger Robot } 17*513427e3STreehugger Robot } 18*513427e3STreehugger Robot catch(err) { 19*513427e3STreehugger Robot } 20*513427e3STreehugger Robot//--> 21*513427e3STreehugger Robot</script> 22*513427e3STreehugger Robot<noscript> 23*513427e3STreehugger Robot<div>JavaScript is disabled on your browser.</div> 24*513427e3STreehugger Robot</noscript> 25*513427e3STreehugger Robot<!-- ========= START OF TOP NAVBAR ======= --> 26*513427e3STreehugger Robot<div class="topNav"><a name="navbar.top"> 27*513427e3STreehugger Robot<!-- --> 28*513427e3STreehugger Robot</a> 29*513427e3STreehugger Robot<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div> 30*513427e3STreehugger Robot<a name="navbar.top.firstrow"> 31*513427e3STreehugger Robot<!-- --> 32*513427e3STreehugger Robot</a> 33*513427e3STreehugger Robot<ul class="navList" title="Navigation"> 34*513427e3STreehugger Robot<li><a href="overview-summary.html">Overview</a></li> 35*513427e3STreehugger Robot<li>Package</li> 36*513427e3STreehugger Robot<li>Class</li> 37*513427e3STreehugger Robot<li>Use</li> 38*513427e3STreehugger Robot<li><a href="overview-tree.html">Tree</a></li> 39*513427e3STreehugger Robot<li><a href="deprecated-list.html">Deprecated</a></li> 40*513427e3STreehugger Robot<li><a href="index-all.html">Index</a></li> 41*513427e3STreehugger Robot<li class="navBarCell1Rev">Help</li> 42*513427e3STreehugger Robot</ul> 43*513427e3STreehugger Robot</div> 44*513427e3STreehugger Robot<div class="subNav"> 45*513427e3STreehugger Robot<ul class="navList"> 46*513427e3STreehugger Robot<li>Prev</li> 47*513427e3STreehugger Robot<li>Next</li> 48*513427e3STreehugger Robot</ul> 49*513427e3STreehugger Robot<ul class="navList"> 50*513427e3STreehugger Robot<li><a href="index.html?help-doc.html" target="_top">Frames</a></li> 51*513427e3STreehugger Robot<li><a href="help-doc.html" target="_top">No Frames</a></li> 52*513427e3STreehugger Robot</ul> 53*513427e3STreehugger Robot<ul class="navList" id="allclasses_navbar_top"> 54*513427e3STreehugger Robot<li><a href="allclasses-noframe.html">All Classes</a></li> 55*513427e3STreehugger Robot</ul> 56*513427e3STreehugger Robot<div> 57*513427e3STreehugger Robot<script type="text/javascript"><!-- 58*513427e3STreehugger Robot allClassesLink = document.getElementById("allclasses_navbar_top"); 59*513427e3STreehugger Robot if(window==top) { 60*513427e3STreehugger Robot allClassesLink.style.display = "block"; 61*513427e3STreehugger Robot } 62*513427e3STreehugger Robot else { 63*513427e3STreehugger Robot allClassesLink.style.display = "none"; 64*513427e3STreehugger Robot } 65*513427e3STreehugger Robot //--> 66*513427e3STreehugger Robot</script> 67*513427e3STreehugger Robot</div> 68*513427e3STreehugger Robot<a name="skip.navbar.top"> 69*513427e3STreehugger Robot<!-- --> 70*513427e3STreehugger Robot</a></div> 71*513427e3STreehugger Robot<!-- ========= END OF TOP NAVBAR ========= --> 72*513427e3STreehugger Robot<div class="header"> 73*513427e3STreehugger Robot<h1 class="title">How This API Document Is Organized</h1> 74*513427e3STreehugger Robot<div class="subTitle">This API (Application Programming Interface) document has pages corresponding to the items in the navigation bar, described as follows.</div> 75*513427e3STreehugger Robot</div> 76*513427e3STreehugger Robot<div class="contentContainer"> 77*513427e3STreehugger Robot<ul class="blockList"> 78*513427e3STreehugger Robot<li class="blockList"> 79*513427e3STreehugger Robot<h2>Overview</h2> 80*513427e3STreehugger Robot<p>The <a href="overview-summary.html">Overview</a> page is the front page of this API document and provides a list of all packages with a summary for each. This page can also contain an overall description of the set of packages.</p> 81*513427e3STreehugger Robot</li> 82*513427e3STreehugger Robot<li class="blockList"> 83*513427e3STreehugger Robot<h2>Package</h2> 84*513427e3STreehugger Robot<p>Each package has a page that contains a list of its classes and interfaces, with a summary for each. This page can contain six categories:</p> 85*513427e3STreehugger Robot<ul> 86*513427e3STreehugger Robot<li>Interfaces (italic)</li> 87*513427e3STreehugger Robot<li>Classes</li> 88*513427e3STreehugger Robot<li>Enums</li> 89*513427e3STreehugger Robot<li>Exceptions</li> 90*513427e3STreehugger Robot<li>Errors</li> 91*513427e3STreehugger Robot<li>Annotation Types</li> 92*513427e3STreehugger Robot</ul> 93*513427e3STreehugger Robot</li> 94*513427e3STreehugger Robot<li class="blockList"> 95*513427e3STreehugger Robot<h2>Class/Interface</h2> 96*513427e3STreehugger Robot<p>Each class, interface, nested class and nested interface has its own separate page. Each of these pages has three sections consisting of a class/interface description, summary tables, and detailed member descriptions:</p> 97*513427e3STreehugger Robot<ul> 98*513427e3STreehugger Robot<li>Class inheritance diagram</li> 99*513427e3STreehugger Robot<li>Direct Subclasses</li> 100*513427e3STreehugger Robot<li>All Known Subinterfaces</li> 101*513427e3STreehugger Robot<li>All Known Implementing Classes</li> 102*513427e3STreehugger Robot<li>Class/interface declaration</li> 103*513427e3STreehugger Robot<li>Class/interface description</li> 104*513427e3STreehugger Robot</ul> 105*513427e3STreehugger Robot<ul> 106*513427e3STreehugger Robot<li>Nested Class Summary</li> 107*513427e3STreehugger Robot<li>Field Summary</li> 108*513427e3STreehugger Robot<li>Constructor Summary</li> 109*513427e3STreehugger Robot<li>Method Summary</li> 110*513427e3STreehugger Robot</ul> 111*513427e3STreehugger Robot<ul> 112*513427e3STreehugger Robot<li>Field Detail</li> 113*513427e3STreehugger Robot<li>Constructor Detail</li> 114*513427e3STreehugger Robot<li>Method Detail</li> 115*513427e3STreehugger Robot</ul> 116*513427e3STreehugger Robot<p>Each summary entry contains the first sentence from the detailed description for that item. The summary entries are alphabetical, while the detailed descriptions are in the order they appear in the source code. This preserves the logical groupings established by the programmer.</p> 117*513427e3STreehugger Robot</li> 118*513427e3STreehugger Robot<li class="blockList"> 119*513427e3STreehugger Robot<h2>Annotation Type</h2> 120*513427e3STreehugger Robot<p>Each annotation type has its own separate page with the following sections:</p> 121*513427e3STreehugger Robot<ul> 122*513427e3STreehugger Robot<li>Annotation Type declaration</li> 123*513427e3STreehugger Robot<li>Annotation Type description</li> 124*513427e3STreehugger Robot<li>Required Element Summary</li> 125*513427e3STreehugger Robot<li>Optional Element Summary</li> 126*513427e3STreehugger Robot<li>Element Detail</li> 127*513427e3STreehugger Robot</ul> 128*513427e3STreehugger Robot</li> 129*513427e3STreehugger Robot<li class="blockList"> 130*513427e3STreehugger Robot<h2>Enum</h2> 131*513427e3STreehugger Robot<p>Each enum has its own separate page with the following sections:</p> 132*513427e3STreehugger Robot<ul> 133*513427e3STreehugger Robot<li>Enum declaration</li> 134*513427e3STreehugger Robot<li>Enum description</li> 135*513427e3STreehugger Robot<li>Enum Constant Summary</li> 136*513427e3STreehugger Robot<li>Enum Constant Detail</li> 137*513427e3STreehugger Robot</ul> 138*513427e3STreehugger Robot</li> 139*513427e3STreehugger Robot<li class="blockList"> 140*513427e3STreehugger Robot<h2>Use</h2> 141*513427e3STreehugger Robot<p>Each documented package, class and interface has its own Use page. This page describes what packages, classes, methods, constructors and fields use any part of the given class or package. Given a class or interface A, its Use page includes subclasses of A, fields declared as A, methods that return A, and methods and constructors with parameters of type A. You can access this page by first going to the package, class or interface, then clicking on the "Use" link in the navigation bar.</p> 142*513427e3STreehugger Robot</li> 143*513427e3STreehugger Robot<li class="blockList"> 144*513427e3STreehugger Robot<h2>Tree (Class Hierarchy)</h2> 145*513427e3STreehugger Robot<p>There is a <a href="overview-tree.html">Class Hierarchy</a> page for all packages, plus a hierarchy for each package. Each hierarchy page contains a list of classes and a list of interfaces. The classes are organized by inheritance structure starting with <code>java.lang.Object</code>. The interfaces do not inherit from <code>java.lang.Object</code>.</p> 146*513427e3STreehugger Robot<ul> 147*513427e3STreehugger Robot<li>When viewing the Overview page, clicking on "Tree" displays the hierarchy for all packages.</li> 148*513427e3STreehugger Robot<li>When viewing a particular package, class or interface page, clicking "Tree" displays the hierarchy for only that package.</li> 149*513427e3STreehugger Robot</ul> 150*513427e3STreehugger Robot</li> 151*513427e3STreehugger Robot<li class="blockList"> 152*513427e3STreehugger Robot<h2>Deprecated API</h2> 153*513427e3STreehugger Robot<p>The <a href="deprecated-list.html">Deprecated API</a> page lists all of the API that have been deprecated. A deprecated API is not recommended for use, generally due to improvements, and a replacement API is usually given. Deprecated APIs may be removed in future implementations.</p> 154*513427e3STreehugger Robot</li> 155*513427e3STreehugger Robot<li class="blockList"> 156*513427e3STreehugger Robot<h2>Index</h2> 157*513427e3STreehugger Robot<p>The <a href="index-all.html">Index</a> contains an alphabetic list of all classes, interfaces, constructors, methods, and fields.</p> 158*513427e3STreehugger Robot</li> 159*513427e3STreehugger Robot<li class="blockList"> 160*513427e3STreehugger Robot<h2>Prev/Next</h2> 161*513427e3STreehugger Robot<p>These links take you to the next or previous class, interface, package, or related page.</p> 162*513427e3STreehugger Robot</li> 163*513427e3STreehugger Robot<li class="blockList"> 164*513427e3STreehugger Robot<h2>Frames/No Frames</h2> 165*513427e3STreehugger Robot<p>These links show and hide the HTML frames. All pages are available with or without frames.</p> 166*513427e3STreehugger Robot</li> 167*513427e3STreehugger Robot<li class="blockList"> 168*513427e3STreehugger Robot<h2>All Classes</h2> 169*513427e3STreehugger Robot<p>The <a href="allclasses-noframe.html">All Classes</a> link shows all classes and interfaces except non-static nested types.</p> 170*513427e3STreehugger Robot</li> 171*513427e3STreehugger Robot<li class="blockList"> 172*513427e3STreehugger Robot<h2>Serialized Form</h2> 173*513427e3STreehugger Robot<p>Each serializable or externalizable class has a description of its serialization fields and methods. This information is of interest to re-implementors, not to developers using the API. While there is no link in the navigation bar, you can get to this information by going to any serialized class and clicking "Serialized Form" in the "See also" section of the class description.</p> 174*513427e3STreehugger Robot</li> 175*513427e3STreehugger Robot<li class="blockList"> 176*513427e3STreehugger Robot<h2>Constant Field Values</h2> 177*513427e3STreehugger Robot<p>The <a href="constant-values.html">Constant Field Values</a> page lists the static final fields and their values.</p> 178*513427e3STreehugger Robot</li> 179*513427e3STreehugger Robot</ul> 180*513427e3STreehugger Robot<span class="emphasizedPhrase">This help file applies to API documentation generated using the standard doclet.</span></div> 181*513427e3STreehugger Robot<!-- ======= START OF BOTTOM NAVBAR ====== --> 182*513427e3STreehugger Robot<div class="bottomNav"><a name="navbar.bottom"> 183*513427e3STreehugger Robot<!-- --> 184*513427e3STreehugger Robot</a> 185*513427e3STreehugger Robot<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div> 186*513427e3STreehugger Robot<a name="navbar.bottom.firstrow"> 187*513427e3STreehugger Robot<!-- --> 188*513427e3STreehugger Robot</a> 189*513427e3STreehugger Robot<ul class="navList" title="Navigation"> 190*513427e3STreehugger Robot<li><a href="overview-summary.html">Overview</a></li> 191*513427e3STreehugger Robot<li>Package</li> 192*513427e3STreehugger Robot<li>Class</li> 193*513427e3STreehugger Robot<li>Use</li> 194*513427e3STreehugger Robot<li><a href="overview-tree.html">Tree</a></li> 195*513427e3STreehugger Robot<li><a href="deprecated-list.html">Deprecated</a></li> 196*513427e3STreehugger Robot<li><a href="index-all.html">Index</a></li> 197*513427e3STreehugger Robot<li class="navBarCell1Rev">Help</li> 198*513427e3STreehugger Robot</ul> 199*513427e3STreehugger Robot</div> 200*513427e3STreehugger Robot<div class="subNav"> 201*513427e3STreehugger Robot<ul class="navList"> 202*513427e3STreehugger Robot<li>Prev</li> 203*513427e3STreehugger Robot<li>Next</li> 204*513427e3STreehugger Robot</ul> 205*513427e3STreehugger Robot<ul class="navList"> 206*513427e3STreehugger Robot<li><a href="index.html?help-doc.html" target="_top">Frames</a></li> 207*513427e3STreehugger Robot<li><a href="help-doc.html" target="_top">No Frames</a></li> 208*513427e3STreehugger Robot</ul> 209*513427e3STreehugger Robot<ul class="navList" id="allclasses_navbar_bottom"> 210*513427e3STreehugger Robot<li><a href="allclasses-noframe.html">All Classes</a></li> 211*513427e3STreehugger Robot</ul> 212*513427e3STreehugger Robot<div> 213*513427e3STreehugger Robot<script type="text/javascript"><!-- 214*513427e3STreehugger Robot allClassesLink = document.getElementById("allclasses_navbar_bottom"); 215*513427e3STreehugger Robot if(window==top) { 216*513427e3STreehugger Robot allClassesLink.style.display = "block"; 217*513427e3STreehugger Robot } 218*513427e3STreehugger Robot else { 219*513427e3STreehugger Robot allClassesLink.style.display = "none"; 220*513427e3STreehugger Robot } 221*513427e3STreehugger Robot //--> 222*513427e3STreehugger Robot</script> 223*513427e3STreehugger Robot</div> 224*513427e3STreehugger Robot<a name="skip.navbar.bottom"> 225*513427e3STreehugger Robot<!-- --> 226*513427e3STreehugger Robot</a></div> 227*513427e3STreehugger Robot<!-- ======== END OF BOTTOM NAVBAR ======= --> 228*513427e3STreehugger Robot<p class="legalCopy"><small>Copyright © 2007–2022. All rights reserved.</small></p> 229*513427e3STreehugger Robot</body> 230*513427e3STreehugger Robot</html> 231