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