1*b596130cSAndroid Build Coastguard Worker<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> 2*b596130cSAndroid Build Coastguard Worker<!-- NewPage --> 3*b596130cSAndroid Build Coastguard Worker<html lang="en"> 4*b596130cSAndroid Build Coastguard Worker<head> 5*b596130cSAndroid Build Coastguard Worker<!-- Generated by javadoc --> 6*b596130cSAndroid Build Coastguard Worker<title>API Help (library 3.10.0 API)</title> 7*b596130cSAndroid Build Coastguard Worker<link rel="stylesheet" type="text/css" href="stylesheet.css" title="Style"> 8*b596130cSAndroid Build Coastguard Worker<script type="text/javascript" src="script.js"></script> 9*b596130cSAndroid Build Coastguard Worker</head> 10*b596130cSAndroid Build Coastguard Worker<body> 11*b596130cSAndroid Build Coastguard Worker<script type="text/javascript"><!-- 12*b596130cSAndroid Build Coastguard Worker try { 13*b596130cSAndroid Build Coastguard Worker if (location.href.indexOf('is-external=true') == -1) { 14*b596130cSAndroid Build Coastguard Worker parent.document.title="API Help (library 3.10.0 API)"; 15*b596130cSAndroid Build Coastguard Worker } 16*b596130cSAndroid Build Coastguard Worker } 17*b596130cSAndroid Build Coastguard Worker catch(err) { 18*b596130cSAndroid Build Coastguard Worker } 19*b596130cSAndroid Build Coastguard Worker//--> 20*b596130cSAndroid Build Coastguard Worker</script> 21*b596130cSAndroid Build Coastguard Worker<noscript> 22*b596130cSAndroid Build Coastguard Worker<div>JavaScript is disabled on your browser.</div> 23*b596130cSAndroid Build Coastguard Worker</noscript> 24*b596130cSAndroid Build Coastguard Worker<!-- ========= START OF TOP NAVBAR ======= --> 25*b596130cSAndroid Build Coastguard Worker<div class="topNav"><a name="navbar.top"> 26*b596130cSAndroid Build Coastguard Worker<!-- --> 27*b596130cSAndroid Build Coastguard Worker</a> 28*b596130cSAndroid Build Coastguard Worker<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div> 29*b596130cSAndroid Build Coastguard Worker<a name="navbar.top.firstrow"> 30*b596130cSAndroid Build Coastguard Worker<!-- --> 31*b596130cSAndroid Build Coastguard Worker</a> 32*b596130cSAndroid Build Coastguard Worker<ul class="navList" title="Navigation"> 33*b596130cSAndroid Build Coastguard Worker<li><a href="overview-summary.html">Overview</a></li> 34*b596130cSAndroid Build Coastguard Worker<li>Package</li> 35*b596130cSAndroid Build Coastguard Worker<li>Class</li> 36*b596130cSAndroid Build Coastguard Worker<li><a href="overview-tree.html">Tree</a></li> 37*b596130cSAndroid Build Coastguard Worker<li><a href="deprecated-list.html">Deprecated</a></li> 38*b596130cSAndroid Build Coastguard Worker<li><a href="index-all.html">Index</a></li> 39*b596130cSAndroid Build Coastguard Worker<li class="navBarCell1Rev">Help</li> 40*b596130cSAndroid Build Coastguard Worker</ul> 41*b596130cSAndroid Build Coastguard Worker</div> 42*b596130cSAndroid Build Coastguard Worker<div class="subNav"> 43*b596130cSAndroid Build Coastguard Worker<ul class="navList"> 44*b596130cSAndroid Build Coastguard Worker<li>Prev</li> 45*b596130cSAndroid Build Coastguard Worker<li>Next</li> 46*b596130cSAndroid Build Coastguard Worker</ul> 47*b596130cSAndroid Build Coastguard Worker<ul class="navList"> 48*b596130cSAndroid Build Coastguard Worker<li><a href="index.html?help-doc.html" target="_top">Frames</a></li> 49*b596130cSAndroid Build Coastguard Worker<li><a href="help-doc.html" target="_top">No Frames</a></li> 50*b596130cSAndroid Build Coastguard Worker</ul> 51*b596130cSAndroid Build Coastguard Worker<ul class="navList" id="allclasses_navbar_top"> 52*b596130cSAndroid Build Coastguard Worker<li><a href="allclasses-noframe.html">All Classes</a></li> 53*b596130cSAndroid Build Coastguard Worker</ul> 54*b596130cSAndroid Build Coastguard Worker<div> 55*b596130cSAndroid Build Coastguard Worker<script type="text/javascript"><!-- 56*b596130cSAndroid Build Coastguard Worker allClassesLink = document.getElementById("allclasses_navbar_top"); 57*b596130cSAndroid Build Coastguard Worker if(window==top) { 58*b596130cSAndroid Build Coastguard Worker allClassesLink.style.display = "block"; 59*b596130cSAndroid Build Coastguard Worker } 60*b596130cSAndroid Build Coastguard Worker else { 61*b596130cSAndroid Build Coastguard Worker allClassesLink.style.display = "none"; 62*b596130cSAndroid Build Coastguard Worker } 63*b596130cSAndroid Build Coastguard Worker //--> 64*b596130cSAndroid Build Coastguard Worker</script> 65*b596130cSAndroid Build Coastguard Worker</div> 66*b596130cSAndroid Build Coastguard Worker<a name="skip.navbar.top"> 67*b596130cSAndroid Build Coastguard Worker<!-- --> 68*b596130cSAndroid Build Coastguard Worker</a></div> 69*b596130cSAndroid Build Coastguard Worker<!-- ========= END OF TOP NAVBAR ========= --> 70*b596130cSAndroid Build Coastguard Worker<div class="header"> 71*b596130cSAndroid Build Coastguard Worker<h1 class="title">How This API Document Is Organized</h1> 72*b596130cSAndroid Build Coastguard Worker<div class="subTitle">This API (Application Programming Interface) document has pages corresponding to the items in the navigation bar, described as follows.</div> 73*b596130cSAndroid Build Coastguard Worker</div> 74*b596130cSAndroid Build Coastguard Worker<div class="contentContainer"> 75*b596130cSAndroid Build Coastguard Worker<ul class="blockList"> 76*b596130cSAndroid Build Coastguard Worker<li class="blockList"> 77*b596130cSAndroid Build Coastguard Worker<h2>Overview</h2> 78*b596130cSAndroid Build Coastguard Worker<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> 79*b596130cSAndroid Build Coastguard Worker</li> 80*b596130cSAndroid Build Coastguard Worker<li class="blockList"> 81*b596130cSAndroid Build Coastguard Worker<h2>Package</h2> 82*b596130cSAndroid Build Coastguard Worker<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> 83*b596130cSAndroid Build Coastguard Worker<ul> 84*b596130cSAndroid Build Coastguard Worker<li>Interfaces (italic)</li> 85*b596130cSAndroid Build Coastguard Worker<li>Classes</li> 86*b596130cSAndroid Build Coastguard Worker<li>Enums</li> 87*b596130cSAndroid Build Coastguard Worker<li>Exceptions</li> 88*b596130cSAndroid Build Coastguard Worker<li>Errors</li> 89*b596130cSAndroid Build Coastguard Worker<li>Annotation Types</li> 90*b596130cSAndroid Build Coastguard Worker</ul> 91*b596130cSAndroid Build Coastguard Worker</li> 92*b596130cSAndroid Build Coastguard Worker<li class="blockList"> 93*b596130cSAndroid Build Coastguard Worker<h2>Class/Interface</h2> 94*b596130cSAndroid Build Coastguard Worker<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> 95*b596130cSAndroid Build Coastguard Worker<ul> 96*b596130cSAndroid Build Coastguard Worker<li>Class inheritance diagram</li> 97*b596130cSAndroid Build Coastguard Worker<li>Direct Subclasses</li> 98*b596130cSAndroid Build Coastguard Worker<li>All Known Subinterfaces</li> 99*b596130cSAndroid Build Coastguard Worker<li>All Known Implementing Classes</li> 100*b596130cSAndroid Build Coastguard Worker<li>Class/interface declaration</li> 101*b596130cSAndroid Build Coastguard Worker<li>Class/interface description</li> 102*b596130cSAndroid Build Coastguard Worker</ul> 103*b596130cSAndroid Build Coastguard Worker<ul> 104*b596130cSAndroid Build Coastguard Worker<li>Nested Class Summary</li> 105*b596130cSAndroid Build Coastguard Worker<li>Field Summary</li> 106*b596130cSAndroid Build Coastguard Worker<li>Constructor Summary</li> 107*b596130cSAndroid Build Coastguard Worker<li>Method Summary</li> 108*b596130cSAndroid Build Coastguard Worker</ul> 109*b596130cSAndroid Build Coastguard Worker<ul> 110*b596130cSAndroid Build Coastguard Worker<li>Field Detail</li> 111*b596130cSAndroid Build Coastguard Worker<li>Constructor Detail</li> 112*b596130cSAndroid Build Coastguard Worker<li>Method Detail</li> 113*b596130cSAndroid Build Coastguard Worker</ul> 114*b596130cSAndroid Build Coastguard Worker<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> 115*b596130cSAndroid Build Coastguard Worker</li> 116*b596130cSAndroid Build Coastguard Worker<li class="blockList"> 117*b596130cSAndroid Build Coastguard Worker<h2>Annotation Type</h2> 118*b596130cSAndroid Build Coastguard Worker<p>Each annotation type has its own separate page with the following sections:</p> 119*b596130cSAndroid Build Coastguard Worker<ul> 120*b596130cSAndroid Build Coastguard Worker<li>Annotation Type declaration</li> 121*b596130cSAndroid Build Coastguard Worker<li>Annotation Type description</li> 122*b596130cSAndroid Build Coastguard Worker<li>Required Element Summary</li> 123*b596130cSAndroid Build Coastguard Worker<li>Optional Element Summary</li> 124*b596130cSAndroid Build Coastguard Worker<li>Element Detail</li> 125*b596130cSAndroid Build Coastguard Worker</ul> 126*b596130cSAndroid Build Coastguard Worker</li> 127*b596130cSAndroid Build Coastguard Worker<li class="blockList"> 128*b596130cSAndroid Build Coastguard Worker<h2>Enum</h2> 129*b596130cSAndroid Build Coastguard Worker<p>Each enum has its own separate page with the following sections:</p> 130*b596130cSAndroid Build Coastguard Worker<ul> 131*b596130cSAndroid Build Coastguard Worker<li>Enum declaration</li> 132*b596130cSAndroid Build Coastguard Worker<li>Enum description</li> 133*b596130cSAndroid Build Coastguard Worker<li>Enum Constant Summary</li> 134*b596130cSAndroid Build Coastguard Worker<li>Enum Constant Detail</li> 135*b596130cSAndroid Build Coastguard Worker</ul> 136*b596130cSAndroid Build Coastguard Worker</li> 137*b596130cSAndroid Build Coastguard Worker<li class="blockList"> 138*b596130cSAndroid Build Coastguard Worker<h2>Tree (Class Hierarchy)</h2> 139*b596130cSAndroid Build Coastguard Worker<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> 140*b596130cSAndroid Build Coastguard Worker<ul> 141*b596130cSAndroid Build Coastguard Worker<li>When viewing the Overview page, clicking on "Tree" displays the hierarchy for all packages.</li> 142*b596130cSAndroid Build Coastguard Worker<li>When viewing a particular package, class or interface page, clicking "Tree" displays the hierarchy for only that package.</li> 143*b596130cSAndroid Build Coastguard Worker</ul> 144*b596130cSAndroid Build Coastguard Worker</li> 145*b596130cSAndroid Build Coastguard Worker<li class="blockList"> 146*b596130cSAndroid Build Coastguard Worker<h2>Deprecated API</h2> 147*b596130cSAndroid Build Coastguard Worker<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> 148*b596130cSAndroid Build Coastguard Worker</li> 149*b596130cSAndroid Build Coastguard Worker<li class="blockList"> 150*b596130cSAndroid Build Coastguard Worker<h2>Index</h2> 151*b596130cSAndroid Build Coastguard Worker<p>The <a href="index-all.html">Index</a> contains an alphabetic list of all classes, interfaces, constructors, methods, and fields.</p> 152*b596130cSAndroid Build Coastguard Worker</li> 153*b596130cSAndroid Build Coastguard Worker<li class="blockList"> 154*b596130cSAndroid Build Coastguard Worker<h2>Prev/Next</h2> 155*b596130cSAndroid Build Coastguard Worker<p>These links take you to the next or previous class, interface, package, or related page.</p> 156*b596130cSAndroid Build Coastguard Worker</li> 157*b596130cSAndroid Build Coastguard Worker<li class="blockList"> 158*b596130cSAndroid Build Coastguard Worker<h2>Frames/No Frames</h2> 159*b596130cSAndroid Build Coastguard Worker<p>These links show and hide the HTML frames. All pages are available with or without frames.</p> 160*b596130cSAndroid Build Coastguard Worker</li> 161*b596130cSAndroid Build Coastguard Worker<li class="blockList"> 162*b596130cSAndroid Build Coastguard Worker<h2>All Classes</h2> 163*b596130cSAndroid Build Coastguard Worker<p>The <a href="allclasses-noframe.html">All Classes</a> link shows all classes and interfaces except non-static nested types.</p> 164*b596130cSAndroid Build Coastguard Worker</li> 165*b596130cSAndroid Build Coastguard Worker<li class="blockList"> 166*b596130cSAndroid Build Coastguard Worker<h2>Serialized Form</h2> 167*b596130cSAndroid Build Coastguard Worker<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> 168*b596130cSAndroid Build Coastguard Worker</li> 169*b596130cSAndroid Build Coastguard Worker<li class="blockList"> 170*b596130cSAndroid Build Coastguard Worker<h2>Constant Field Values</h2> 171*b596130cSAndroid Build Coastguard Worker<p>The <a href="constant-values.html">Constant Field Values</a> page lists the static final fields and their values.</p> 172*b596130cSAndroid Build Coastguard Worker</li> 173*b596130cSAndroid Build Coastguard Worker</ul> 174*b596130cSAndroid Build Coastguard Worker<span class="emphasizedPhrase">This help file applies to API documentation generated using the standard doclet.</span></div> 175*b596130cSAndroid Build Coastguard Worker<!-- ======= START OF BOTTOM NAVBAR ====== --> 176*b596130cSAndroid Build Coastguard Worker<div class="bottomNav"><a name="navbar.bottom"> 177*b596130cSAndroid Build Coastguard Worker<!-- --> 178*b596130cSAndroid Build Coastguard Worker</a> 179*b596130cSAndroid Build Coastguard Worker<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div> 180*b596130cSAndroid Build Coastguard Worker<a name="navbar.bottom.firstrow"> 181*b596130cSAndroid Build Coastguard Worker<!-- --> 182*b596130cSAndroid Build Coastguard Worker</a> 183*b596130cSAndroid Build Coastguard Worker<ul class="navList" title="Navigation"> 184*b596130cSAndroid Build Coastguard Worker<li><a href="overview-summary.html">Overview</a></li> 185*b596130cSAndroid Build Coastguard Worker<li>Package</li> 186*b596130cSAndroid Build Coastguard Worker<li>Class</li> 187*b596130cSAndroid Build Coastguard Worker<li><a href="overview-tree.html">Tree</a></li> 188*b596130cSAndroid Build Coastguard Worker<li><a href="deprecated-list.html">Deprecated</a></li> 189*b596130cSAndroid Build Coastguard Worker<li><a href="index-all.html">Index</a></li> 190*b596130cSAndroid Build Coastguard Worker<li class="navBarCell1Rev">Help</li> 191*b596130cSAndroid Build Coastguard Worker</ul> 192*b596130cSAndroid Build Coastguard Worker</div> 193*b596130cSAndroid Build Coastguard Worker<div class="subNav"> 194*b596130cSAndroid Build Coastguard Worker<ul class="navList"> 195*b596130cSAndroid Build Coastguard Worker<li>Prev</li> 196*b596130cSAndroid Build Coastguard Worker<li>Next</li> 197*b596130cSAndroid Build Coastguard Worker</ul> 198*b596130cSAndroid Build Coastguard Worker<ul class="navList"> 199*b596130cSAndroid Build Coastguard Worker<li><a href="index.html?help-doc.html" target="_top">Frames</a></li> 200*b596130cSAndroid Build Coastguard Worker<li><a href="help-doc.html" target="_top">No Frames</a></li> 201*b596130cSAndroid Build Coastguard Worker</ul> 202*b596130cSAndroid Build Coastguard Worker<ul class="navList" id="allclasses_navbar_bottom"> 203*b596130cSAndroid Build Coastguard Worker<li><a href="allclasses-noframe.html">All Classes</a></li> 204*b596130cSAndroid Build Coastguard Worker</ul> 205*b596130cSAndroid Build Coastguard Worker<div> 206*b596130cSAndroid Build Coastguard Worker<script type="text/javascript"><!-- 207*b596130cSAndroid Build Coastguard Worker allClassesLink = document.getElementById("allclasses_navbar_bottom"); 208*b596130cSAndroid Build Coastguard Worker if(window==top) { 209*b596130cSAndroid Build Coastguard Worker allClassesLink.style.display = "block"; 210*b596130cSAndroid Build Coastguard Worker } 211*b596130cSAndroid Build Coastguard Worker else { 212*b596130cSAndroid Build Coastguard Worker allClassesLink.style.display = "none"; 213*b596130cSAndroid Build Coastguard Worker } 214*b596130cSAndroid Build Coastguard Worker //--> 215*b596130cSAndroid Build Coastguard Worker</script> 216*b596130cSAndroid Build Coastguard Worker</div> 217*b596130cSAndroid Build Coastguard Worker<a name="skip.navbar.bottom"> 218*b596130cSAndroid Build Coastguard Worker<!-- --> 219*b596130cSAndroid Build Coastguard Worker</a></div> 220*b596130cSAndroid Build Coastguard Worker<!-- ======== END OF BOTTOM NAVBAR ======= --> 221*b596130cSAndroid Build Coastguard Worker</body> 222*b596130cSAndroid Build Coastguard Worker</html> 223