xref: /aosp_15_r20/external/junit-params/apidocs/junitparams/Parameters.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>Parameters (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="Parameters (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><a href="package-summary.html">Package</a></li>
37*b2c653efSSorin Basca<li class="navBarCell1Rev">Class</li>
38*b2c653efSSorin Basca<li><a href="class-use/Parameters.html">Use</a></li>
39*b2c653efSSorin Basca<li><a href="package-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><a href="../help-doc.html">Help</a></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><a href="../junitparams/JUnitParamsRunner.html" title="class in junitparams"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
48*b2c653efSSorin Basca<li>Next&nbsp;Class</li>
49*b2c653efSSorin Basca</ul>
50*b2c653efSSorin Basca<ul class="navList">
51*b2c653efSSorin Basca<li><a href="../index.html?junitparams/Parameters.html" target="_top">Frames</a></li>
52*b2c653efSSorin Basca<li><a href="Parameters.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<div>
70*b2c653efSSorin Basca<ul class="subNavList">
71*b2c653efSSorin Basca<li>Summary:&nbsp;</li>
72*b2c653efSSorin Basca<li>Field&nbsp;|&nbsp;</li>
73*b2c653efSSorin Basca<li>Required&nbsp;|&nbsp;</li>
74*b2c653efSSorin Basca<li><a href="#annotation.type.optional.element.summary">Optional</a></li>
75*b2c653efSSorin Basca</ul>
76*b2c653efSSorin Basca<ul class="subNavList">
77*b2c653efSSorin Basca<li>Detail:&nbsp;</li>
78*b2c653efSSorin Basca<li>Field&nbsp;|&nbsp;</li>
79*b2c653efSSorin Basca<li><a href="#annotation.type.element.detail">Element</a></li>
80*b2c653efSSorin Basca</ul>
81*b2c653efSSorin Basca</div>
82*b2c653efSSorin Basca<a name="skip.navbar.top">
83*b2c653efSSorin Basca<!--   -->
84*b2c653efSSorin Basca</a></div>
85*b2c653efSSorin Basca<!-- ========= END OF TOP NAVBAR ========= -->
86*b2c653efSSorin Basca<!-- ======== START OF CLASS DATA ======== -->
87*b2c653efSSorin Basca<div class="header">
88*b2c653efSSorin Basca<div class="subTitle">junitparams</div>
89*b2c653efSSorin Basca<h2 title="Annotation Type Parameters" class="title">Annotation Type Parameters</h2>
90*b2c653efSSorin Basca</div>
91*b2c653efSSorin Basca<div class="contentContainer">
92*b2c653efSSorin Basca<div class="description">
93*b2c653efSSorin Basca<ul class="blockList">
94*b2c653efSSorin Basca<li class="blockList">
95*b2c653efSSorin Basca<hr>
96*b2c653efSSorin Basca<br>
97*b2c653efSSorin Basca<pre><a href="http://docs.oracle.com/javase/6/docs/api/java/lang/annotation/Retention.html?is-external=true" title="class or interface in java.lang.annotation">@Retention</a>(<a href="http://docs.oracle.com/javase/6/docs/api/java/lang/annotation/Retention.html?is-external=true#value--" title="class or interface in java.lang.annotation">value</a>=<a href="http://docs.oracle.com/javase/6/docs/api/java/lang/annotation/RetentionPolicy.html?is-external=true#RUNTIME" title="class or interface in java.lang.annotation">RUNTIME</a>)
98*b2c653efSSorin Bascapublic @interface <span class="memberNameLabel">Parameters</span></pre>
99*b2c653efSSorin Basca<div class="block">THE annotation for the test parameters. Use it to say that a method takes
100*b2c653efSSorin Basca some parameters and define how to obtain them.</div>
101*b2c653efSSorin Basca<dl>
102*b2c653efSSorin Basca<dt><span class="simpleTagLabel">Author:</span></dt>
103*b2c653efSSorin Basca<dd>Pawel Lipinski</dd>
104*b2c653efSSorin Basca</dl>
105*b2c653efSSorin Basca</li>
106*b2c653efSSorin Basca</ul>
107*b2c653efSSorin Basca</div>
108*b2c653efSSorin Basca<div class="summary">
109*b2c653efSSorin Basca<ul class="blockList">
110*b2c653efSSorin Basca<li class="blockList">
111*b2c653efSSorin Basca<!-- =========== ANNOTATION TYPE OPTIONAL MEMBER SUMMARY =========== -->
112*b2c653efSSorin Basca<ul class="blockList">
113*b2c653efSSorin Basca<li class="blockList"><a name="annotation.type.optional.element.summary">
114*b2c653efSSorin Basca<!--   -->
115*b2c653efSSorin Basca</a>
116*b2c653efSSorin Basca<h3>Optional Element Summary</h3>
117*b2c653efSSorin Basca<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Optional Element Summary table, listing optional elements, and an explanation">
118*b2c653efSSorin Basca<caption><span>Optional Elements</span><span class="tabEnd">&nbsp;</span></caption>
119*b2c653efSSorin Basca<tr>
120*b2c653efSSorin Basca<th class="colFirst" scope="col">Modifier and Type</th>
121*b2c653efSSorin Basca<th class="colLast" scope="col">Optional Element and Description</th>
122*b2c653efSSorin Basca</tr>
123*b2c653efSSorin Basca<tr class="altColor">
124*b2c653efSSorin Basca<td class="colFirst"><code><a href="http://docs.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td>
125*b2c653efSSorin Basca<td class="colLast"><code><span class="memberNameLink"><a href="../junitparams/Parameters.html#method--">method</a></span></code>
126*b2c653efSSorin Basca<div class="block">Parameter values returned by a method within the test class.</div>
127*b2c653efSSorin Basca</td>
128*b2c653efSSorin Basca</tr>
129*b2c653efSSorin Basca<tr class="rowColor">
130*b2c653efSSorin Basca<td class="colFirst"><code><a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a>&lt;?&gt;</code></td>
131*b2c653efSSorin Basca<td class="colLast"><code><span class="memberNameLink"><a href="../junitparams/Parameters.html#source--">source</a></span></code>
132*b2c653efSSorin Basca<div class="block">Parameter values defined externally.</div>
133*b2c653efSSorin Basca</td>
134*b2c653efSSorin Basca</tr>
135*b2c653efSSorin Basca<tr class="altColor">
136*b2c653efSSorin Basca<td class="colFirst"><code><a href="http://docs.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>[]</code></td>
137*b2c653efSSorin Basca<td class="colLast"><code><span class="memberNameLink"><a href="../junitparams/Parameters.html#value--">value</a></span></code>
138*b2c653efSSorin Basca<div class="block">Parameter values defined as a String array.</div>
139*b2c653efSSorin Basca</td>
140*b2c653efSSorin Basca</tr>
141*b2c653efSSorin Basca</table>
142*b2c653efSSorin Basca</li>
143*b2c653efSSorin Basca</ul>
144*b2c653efSSorin Basca</li>
145*b2c653efSSorin Basca</ul>
146*b2c653efSSorin Basca</div>
147*b2c653efSSorin Basca<div class="details">
148*b2c653efSSorin Basca<ul class="blockList">
149*b2c653efSSorin Basca<li class="blockList">
150*b2c653efSSorin Basca<!-- ============ ANNOTATION TYPE MEMBER DETAIL =========== -->
151*b2c653efSSorin Basca<ul class="blockList">
152*b2c653efSSorin Basca<li class="blockList"><a name="annotation.type.element.detail">
153*b2c653efSSorin Basca<!--   -->
154*b2c653efSSorin Basca</a>
155*b2c653efSSorin Basca<h3>Element Detail</h3>
156*b2c653efSSorin Basca<a name="value--">
157*b2c653efSSorin Basca<!--   -->
158*b2c653efSSorin Basca</a>
159*b2c653efSSorin Basca<ul class="blockList">
160*b2c653efSSorin Basca<li class="blockList">
161*b2c653efSSorin Basca<h4>value</h4>
162*b2c653efSSorin Basca<pre>public abstract&nbsp;<a href="http://docs.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>[]&nbsp;value</pre>
163*b2c653efSSorin Basca<div class="block">Parameter values defined as a String array. Each element in the array is
164*b2c653efSSorin Basca a full parameter set, comma-separated. The values must match the method
165*b2c653efSSorin Basca parameters in order and type.
166*b2c653efSSorin Basca Example: <code>@Parameters({
167*b2c653efSSorin Basca                    "1, joe, 26.4, true",
168*b2c653efSSorin Basca                    "2, angie, 37.2, false"}</code></div>
169*b2c653efSSorin Basca<dl>
170*b2c653efSSorin Basca<dt>Default:</dt>
171*b2c653efSSorin Basca<dd>{}</dd>
172*b2c653efSSorin Basca</dl>
173*b2c653efSSorin Basca</li>
174*b2c653efSSorin Basca</ul>
175*b2c653efSSorin Basca</li>
176*b2c653efSSorin Basca</ul>
177*b2c653efSSorin Basca<ul class="blockList">
178*b2c653efSSorin Basca<li class="blockList"><a name="source--">
179*b2c653efSSorin Basca<!--   -->
180*b2c653efSSorin Basca</a>
181*b2c653efSSorin Basca<ul class="blockList">
182*b2c653efSSorin Basca<li class="blockList">
183*b2c653efSSorin Basca<h4>source</h4>
184*b2c653efSSorin Basca<pre>public abstract&nbsp;<a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a>&lt;?&gt;&nbsp;source</pre>
185*b2c653efSSorin Basca<div class="block">Parameter values defined externally. The specified class must have at
186*b2c653efSSorin Basca least one public static method starting with <code>provide</code>
187*b2c653efSSorin Basca returning <code>Object[]</code>. All such methods are used, so you can
188*b2c653efSSorin Basca group your examples. The resulting array should contain parameter sets in
189*b2c653efSSorin Basca its elements. Each parameter set must be another Object[] array, which
190*b2c653efSSorin Basca contains parameter values in its elements.
191*b2c653efSSorin Basca Example: <code>@Parameters(source = PeopleProvider.class)</code></div>
192*b2c653efSSorin Basca<dl>
193*b2c653efSSorin Basca<dt>Default:</dt>
194*b2c653efSSorin Basca<dd>javax.lang.model.type.NullType.class</dd>
195*b2c653efSSorin Basca</dl>
196*b2c653efSSorin Basca</li>
197*b2c653efSSorin Basca</ul>
198*b2c653efSSorin Basca</li>
199*b2c653efSSorin Basca</ul>
200*b2c653efSSorin Basca<ul class="blockList">
201*b2c653efSSorin Basca<li class="blockList"><a name="method--">
202*b2c653efSSorin Basca<!--   -->
203*b2c653efSSorin Basca</a>
204*b2c653efSSorin Basca<ul class="blockListLast">
205*b2c653efSSorin Basca<li class="blockList">
206*b2c653efSSorin Basca<h4>method</h4>
207*b2c653efSSorin Basca<pre>public abstract&nbsp;<a href="http://docs.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;method</pre>
208*b2c653efSSorin Basca<div class="block">Parameter values returned by a method within the test class. This way you
209*b2c653efSSorin Basca don't need additional classes and the test code may be a bit cleaner. The
210*b2c653efSSorin Basca format of the data returned by the method is the same as for the source
211*b2c653efSSorin Basca annotation class.
212*b2c653efSSorin Basca Example: <code>@Parameters(method = "examplaryPeople")</code>
213*b2c653efSSorin Basca
214*b2c653efSSorin Basca You can use multiple methods to provide parameters - use comma to do it:
215*b2c653efSSorin Basca Example: <code>@Parameters(method = "womenParams, menParams")</code></div>
216*b2c653efSSorin Basca<dl>
217*b2c653efSSorin Basca<dt>Default:</dt>
218*b2c653efSSorin Basca<dd>""</dd>
219*b2c653efSSorin Basca</dl>
220*b2c653efSSorin Basca</li>
221*b2c653efSSorin Basca</ul>
222*b2c653efSSorin Basca</li>
223*b2c653efSSorin Basca</ul>
224*b2c653efSSorin Basca</li>
225*b2c653efSSorin Basca</ul>
226*b2c653efSSorin Basca</div>
227*b2c653efSSorin Basca</div>
228*b2c653efSSorin Basca<!-- ========= END OF CLASS DATA ========= -->
229*b2c653efSSorin Basca<!-- ======= START OF BOTTOM NAVBAR ====== -->
230*b2c653efSSorin Basca<div class="bottomNav"><a name="navbar.bottom">
231*b2c653efSSorin Basca<!--   -->
232*b2c653efSSorin Basca</a>
233*b2c653efSSorin Basca<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
234*b2c653efSSorin Basca<a name="navbar.bottom.firstrow">
235*b2c653efSSorin Basca<!--   -->
236*b2c653efSSorin Basca</a>
237*b2c653efSSorin Basca<ul class="navList" title="Navigation">
238*b2c653efSSorin Basca<li><a href="../overview-summary.html">Overview</a></li>
239*b2c653efSSorin Basca<li><a href="package-summary.html">Package</a></li>
240*b2c653efSSorin Basca<li class="navBarCell1Rev">Class</li>
241*b2c653efSSorin Basca<li><a href="class-use/Parameters.html">Use</a></li>
242*b2c653efSSorin Basca<li><a href="package-tree.html">Tree</a></li>
243*b2c653efSSorin Basca<li><a href="../deprecated-list.html">Deprecated</a></li>
244*b2c653efSSorin Basca<li><a href="../index-all.html">Index</a></li>
245*b2c653efSSorin Basca<li><a href="../help-doc.html">Help</a></li>
246*b2c653efSSorin Basca</ul>
247*b2c653efSSorin Basca</div>
248*b2c653efSSorin Basca<div class="subNav">
249*b2c653efSSorin Basca<ul class="navList">
250*b2c653efSSorin Basca<li><a href="../junitparams/JUnitParamsRunner.html" title="class in junitparams"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
251*b2c653efSSorin Basca<li>Next&nbsp;Class</li>
252*b2c653efSSorin Basca</ul>
253*b2c653efSSorin Basca<ul class="navList">
254*b2c653efSSorin Basca<li><a href="../index.html?junitparams/Parameters.html" target="_top">Frames</a></li>
255*b2c653efSSorin Basca<li><a href="Parameters.html" target="_top">No&nbsp;Frames</a></li>
256*b2c653efSSorin Basca</ul>
257*b2c653efSSorin Basca<ul class="navList" id="allclasses_navbar_bottom">
258*b2c653efSSorin Basca<li><a href="../allclasses-noframe.html">All&nbsp;Classes</a></li>
259*b2c653efSSorin Basca</ul>
260*b2c653efSSorin Basca<div>
261*b2c653efSSorin Basca<script type="text/javascript"><!--
262*b2c653efSSorin Basca  allClassesLink = document.getElementById("allclasses_navbar_bottom");
263*b2c653efSSorin Basca  if(window==top) {
264*b2c653efSSorin Basca    allClassesLink.style.display = "block";
265*b2c653efSSorin Basca  }
266*b2c653efSSorin Basca  else {
267*b2c653efSSorin Basca    allClassesLink.style.display = "none";
268*b2c653efSSorin Basca  }
269*b2c653efSSorin Basca  //-->
270*b2c653efSSorin Basca</script>
271*b2c653efSSorin Basca</div>
272*b2c653efSSorin Basca<div>
273*b2c653efSSorin Basca<ul class="subNavList">
274*b2c653efSSorin Basca<li>Summary:&nbsp;</li>
275*b2c653efSSorin Basca<li>Field&nbsp;|&nbsp;</li>
276*b2c653efSSorin Basca<li>Required&nbsp;|&nbsp;</li>
277*b2c653efSSorin Basca<li><a href="#annotation.type.optional.element.summary">Optional</a></li>
278*b2c653efSSorin Basca</ul>
279*b2c653efSSorin Basca<ul class="subNavList">
280*b2c653efSSorin Basca<li>Detail:&nbsp;</li>
281*b2c653efSSorin Basca<li>Field&nbsp;|&nbsp;</li>
282*b2c653efSSorin Basca<li><a href="#annotation.type.element.detail">Element</a></li>
283*b2c653efSSorin Basca</ul>
284*b2c653efSSorin Basca</div>
285*b2c653efSSorin Basca<a name="skip.navbar.bottom">
286*b2c653efSSorin Basca<!--   -->
287*b2c653efSSorin Basca</a></div>
288*b2c653efSSorin Basca<!-- ======== END OF BOTTOM NAVBAR ======= -->
289*b2c653efSSorin Basca<p class="legalCopy"><small>Copyright &#169; 2014 <a href="http://pragmatists.pl">Pragmatists</a>. All rights reserved.</small></p>
290*b2c653efSSorin Basca</body>
291*b2c653efSSorin Basca</html>
292