1<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> 2<!-- NewPage --> 3<html lang="pl"> 4<head> 5<!-- Generated by javadoc (1.8.0) on Mon Jul 28 12:08:59 CEST 2014 --> 6<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> 7<title>Parameters (JUnitParams 1.0.3-SNAPSHOT API)</title> 8<meta name="date" content="2014-07-28"> 9<link rel="stylesheet" type="text/css" href="../stylesheet.css" title="Style"> 10<script type="text/javascript" src="../script.js"></script> 11</head> 12<body> 13<script type="text/javascript"><!-- 14 try { 15 if (location.href.indexOf('is-external=true') == -1) { 16 parent.document.title="Parameters (JUnitParams 1.0.3-SNAPSHOT API)"; 17 } 18 } 19 catch(err) { 20 } 21//--> 22</script> 23<noscript> 24<div>JavaScript is disabled on your browser.</div> 25</noscript> 26<!-- ========= START OF TOP NAVBAR ======= --> 27<div class="topNav"><a name="navbar.top"> 28<!-- --> 29</a> 30<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div> 31<a name="navbar.top.firstrow"> 32<!-- --> 33</a> 34<ul class="navList" title="Navigation"> 35<li><a href="../overview-summary.html">Overview</a></li> 36<li><a href="package-summary.html">Package</a></li> 37<li class="navBarCell1Rev">Class</li> 38<li><a href="class-use/Parameters.html">Use</a></li> 39<li><a href="package-tree.html">Tree</a></li> 40<li><a href="../deprecated-list.html">Deprecated</a></li> 41<li><a href="../index-all.html">Index</a></li> 42<li><a href="../help-doc.html">Help</a></li> 43</ul> 44</div> 45<div class="subNav"> 46<ul class="navList"> 47<li><a href="../junitparams/JUnitParamsRunner.html" title="class in junitparams"><span class="typeNameLink">Prev Class</span></a></li> 48<li>Next Class</li> 49</ul> 50<ul class="navList"> 51<li><a href="../index.html?junitparams/Parameters.html" target="_top">Frames</a></li> 52<li><a href="Parameters.html" target="_top">No Frames</a></li> 53</ul> 54<ul class="navList" id="allclasses_navbar_top"> 55<li><a href="../allclasses-noframe.html">All Classes</a></li> 56</ul> 57<div> 58<script type="text/javascript"><!-- 59 allClassesLink = document.getElementById("allclasses_navbar_top"); 60 if(window==top) { 61 allClassesLink.style.display = "block"; 62 } 63 else { 64 allClassesLink.style.display = "none"; 65 } 66 //--> 67</script> 68</div> 69<div> 70<ul class="subNavList"> 71<li>Summary: </li> 72<li>Field | </li> 73<li>Required | </li> 74<li><a href="#annotation.type.optional.element.summary">Optional</a></li> 75</ul> 76<ul class="subNavList"> 77<li>Detail: </li> 78<li>Field | </li> 79<li><a href="#annotation.type.element.detail">Element</a></li> 80</ul> 81</div> 82<a name="skip.navbar.top"> 83<!-- --> 84</a></div> 85<!-- ========= END OF TOP NAVBAR ========= --> 86<!-- ======== START OF CLASS DATA ======== --> 87<div class="header"> 88<div class="subTitle">junitparams</div> 89<h2 title="Annotation Type Parameters" class="title">Annotation Type Parameters</h2> 90</div> 91<div class="contentContainer"> 92<div class="description"> 93<ul class="blockList"> 94<li class="blockList"> 95<hr> 96<br> 97<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>) 98public @interface <span class="memberNameLabel">Parameters</span></pre> 99<div class="block">THE annotation for the test parameters. Use it to say that a method takes 100 some parameters and define how to obtain them.</div> 101<dl> 102<dt><span class="simpleTagLabel">Author:</span></dt> 103<dd>Pawel Lipinski</dd> 104</dl> 105</li> 106</ul> 107</div> 108<div class="summary"> 109<ul class="blockList"> 110<li class="blockList"> 111<!-- =========== ANNOTATION TYPE OPTIONAL MEMBER SUMMARY =========== --> 112<ul class="blockList"> 113<li class="blockList"><a name="annotation.type.optional.element.summary"> 114<!-- --> 115</a> 116<h3>Optional Element Summary</h3> 117<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Optional Element Summary table, listing optional elements, and an explanation"> 118<caption><span>Optional Elements</span><span class="tabEnd"> </span></caption> 119<tr> 120<th class="colFirst" scope="col">Modifier and Type</th> 121<th class="colLast" scope="col">Optional Element and Description</th> 122</tr> 123<tr class="altColor"> 124<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<td class="colLast"><code><span class="memberNameLink"><a href="../junitparams/Parameters.html#method--">method</a></span></code> 126<div class="block">Parameter values returned by a method within the test class.</div> 127</td> 128</tr> 129<tr class="rowColor"> 130<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><?></code></td> 131<td class="colLast"><code><span class="memberNameLink"><a href="../junitparams/Parameters.html#source--">source</a></span></code> 132<div class="block">Parameter values defined externally.</div> 133</td> 134</tr> 135<tr class="altColor"> 136<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<td class="colLast"><code><span class="memberNameLink"><a href="../junitparams/Parameters.html#value--">value</a></span></code> 138<div class="block">Parameter values defined as a String array.</div> 139</td> 140</tr> 141</table> 142</li> 143</ul> 144</li> 145</ul> 146</div> 147<div class="details"> 148<ul class="blockList"> 149<li class="blockList"> 150<!-- ============ ANNOTATION TYPE MEMBER DETAIL =========== --> 151<ul class="blockList"> 152<li class="blockList"><a name="annotation.type.element.detail"> 153<!-- --> 154</a> 155<h3>Element Detail</h3> 156<a name="value--"> 157<!-- --> 158</a> 159<ul class="blockList"> 160<li class="blockList"> 161<h4>value</h4> 162<pre>public abstract <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>[] value</pre> 163<div class="block">Parameter values defined as a String array. Each element in the array is 164 a full parameter set, comma-separated. The values must match the method 165 parameters in order and type. 166 Example: <code>@Parameters({ 167 "1, joe, 26.4, true", 168 "2, angie, 37.2, false"}</code></div> 169<dl> 170<dt>Default:</dt> 171<dd>{}</dd> 172</dl> 173</li> 174</ul> 175</li> 176</ul> 177<ul class="blockList"> 178<li class="blockList"><a name="source--"> 179<!-- --> 180</a> 181<ul class="blockList"> 182<li class="blockList"> 183<h4>source</h4> 184<pre>public abstract <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><?> source</pre> 185<div class="block">Parameter values defined externally. The specified class must have at 186 least one public static method starting with <code>provide</code> 187 returning <code>Object[]</code>. All such methods are used, so you can 188 group your examples. The resulting array should contain parameter sets in 189 its elements. Each parameter set must be another Object[] array, which 190 contains parameter values in its elements. 191 Example: <code>@Parameters(source = PeopleProvider.class)</code></div> 192<dl> 193<dt>Default:</dt> 194<dd>javax.lang.model.type.NullType.class</dd> 195</dl> 196</li> 197</ul> 198</li> 199</ul> 200<ul class="blockList"> 201<li class="blockList"><a name="method--"> 202<!-- --> 203</a> 204<ul class="blockListLast"> 205<li class="blockList"> 206<h4>method</h4> 207<pre>public abstract <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> method</pre> 208<div class="block">Parameter values returned by a method within the test class. This way you 209 don't need additional classes and the test code may be a bit cleaner. The 210 format of the data returned by the method is the same as for the source 211 annotation class. 212 Example: <code>@Parameters(method = "examplaryPeople")</code> 213 214 You can use multiple methods to provide parameters - use comma to do it: 215 Example: <code>@Parameters(method = "womenParams, menParams")</code></div> 216<dl> 217<dt>Default:</dt> 218<dd>""</dd> 219</dl> 220</li> 221</ul> 222</li> 223</ul> 224</li> 225</ul> 226</div> 227</div> 228<!-- ========= END OF CLASS DATA ========= --> 229<!-- ======= START OF BOTTOM NAVBAR ====== --> 230<div class="bottomNav"><a name="navbar.bottom"> 231<!-- --> 232</a> 233<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div> 234<a name="navbar.bottom.firstrow"> 235<!-- --> 236</a> 237<ul class="navList" title="Navigation"> 238<li><a href="../overview-summary.html">Overview</a></li> 239<li><a href="package-summary.html">Package</a></li> 240<li class="navBarCell1Rev">Class</li> 241<li><a href="class-use/Parameters.html">Use</a></li> 242<li><a href="package-tree.html">Tree</a></li> 243<li><a href="../deprecated-list.html">Deprecated</a></li> 244<li><a href="../index-all.html">Index</a></li> 245<li><a href="../help-doc.html">Help</a></li> 246</ul> 247</div> 248<div class="subNav"> 249<ul class="navList"> 250<li><a href="../junitparams/JUnitParamsRunner.html" title="class in junitparams"><span class="typeNameLink">Prev Class</span></a></li> 251<li>Next Class</li> 252</ul> 253<ul class="navList"> 254<li><a href="../index.html?junitparams/Parameters.html" target="_top">Frames</a></li> 255<li><a href="Parameters.html" target="_top">No Frames</a></li> 256</ul> 257<ul class="navList" id="allclasses_navbar_bottom"> 258<li><a href="../allclasses-noframe.html">All Classes</a></li> 259</ul> 260<div> 261<script type="text/javascript"><!-- 262 allClassesLink = document.getElementById("allclasses_navbar_bottom"); 263 if(window==top) { 264 allClassesLink.style.display = "block"; 265 } 266 else { 267 allClassesLink.style.display = "none"; 268 } 269 //--> 270</script> 271</div> 272<div> 273<ul class="subNavList"> 274<li>Summary: </li> 275<li>Field | </li> 276<li>Required | </li> 277<li><a href="#annotation.type.optional.element.summary">Optional</a></li> 278</ul> 279<ul class="subNavList"> 280<li>Detail: </li> 281<li>Field | </li> 282<li><a href="#annotation.type.element.detail">Element</a></li> 283</ul> 284</div> 285<a name="skip.navbar.bottom"> 286<!-- --> 287</a></div> 288<!-- ======== END OF BOTTOM NAVBAR ======= --> 289<p class="legalCopy"><small>Copyright © 2014 <a href="http://pragmatists.pl">Pragmatists</a>. All rights reserved.</small></p> 290</body> 291</html> 292