xref: /aosp_15_r20/external/junit-params/apidocs/junitparams/FileParameters.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>FileParameters (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="FileParameters (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/FileParameters.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>Prev&nbsp;Class</li>
48*b2c653efSSorin Basca<li><a href="../junitparams/JUnitParamsRunner.html" title="class in junitparams"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
49*b2c653efSSorin Basca</ul>
50*b2c653efSSorin Basca<ul class="navList">
51*b2c653efSSorin Basca<li><a href="../index.html?junitparams/FileParameters.html" target="_top">Frames</a></li>
52*b2c653efSSorin Basca<li><a href="FileParameters.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><a href="#annotation.type.required.element.summary">Required</a>&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 FileParameters" class="title">Annotation Type FileParameters</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">FileParameters</span></pre>
99*b2c653efSSorin Basca<div class="block">Denotes that parameters for a annotated test method should be taken from an
100*b2c653efSSorin Basca external resource.</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 REQUIRED MEMBER SUMMARY =========== -->
112*b2c653efSSorin Basca<ul class="blockList">
113*b2c653efSSorin Basca<li class="blockList"><a name="annotation.type.required.element.summary">
114*b2c653efSSorin Basca<!--   -->
115*b2c653efSSorin Basca</a>
116*b2c653efSSorin Basca<h3>Required Element Summary</h3>
117*b2c653efSSorin Basca<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Required Element Summary table, listing required elements, and an explanation">
118*b2c653efSSorin Basca<caption><span>Required 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">Required 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/FileParameters.html#value--">value</a></span></code>
126*b2c653efSSorin Basca<div class="block">File name (with full path) of the file with data.</div>
127*b2c653efSSorin Basca</td>
128*b2c653efSSorin Basca</tr>
129*b2c653efSSorin Basca</table>
130*b2c653efSSorin Basca</li>
131*b2c653efSSorin Basca</ul>
132*b2c653efSSorin Basca<!-- =========== ANNOTATION TYPE OPTIONAL MEMBER SUMMARY =========== -->
133*b2c653efSSorin Basca<ul class="blockList">
134*b2c653efSSorin Basca<li class="blockList"><a name="annotation.type.optional.element.summary">
135*b2c653efSSorin Basca<!--   -->
136*b2c653efSSorin Basca</a>
137*b2c653efSSorin Basca<h3>Optional Element Summary</h3>
138*b2c653efSSorin Basca<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Optional Element Summary table, listing optional elements, and an explanation">
139*b2c653efSSorin Basca<caption><span>Optional Elements</span><span class="tabEnd">&nbsp;</span></caption>
140*b2c653efSSorin Basca<tr>
141*b2c653efSSorin Basca<th class="colFirst" scope="col">Modifier and Type</th>
142*b2c653efSSorin Basca<th class="colLast" scope="col">Optional Element and Description</th>
143*b2c653efSSorin Basca</tr>
144*b2c653efSSorin Basca<tr class="altColor">
145*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;? extends <a href="../junitparams/mappers/DataMapper.html" title="interface in junitparams.mappers">DataMapper</a>&gt;</code></td>
146*b2c653efSSorin Basca<td class="colLast"><code><span class="memberNameLink"><a href="../junitparams/FileParameters.html#mapper--">mapper</a></span></code>
147*b2c653efSSorin Basca<div class="block">The mapper which knows how to get the data from the external resource and
148*b2c653efSSorin Basca turn it into a valid set of parameters.</div>
149*b2c653efSSorin Basca</td>
150*b2c653efSSorin Basca</tr>
151*b2c653efSSorin Basca</table>
152*b2c653efSSorin Basca</li>
153*b2c653efSSorin Basca</ul>
154*b2c653efSSorin Basca</li>
155*b2c653efSSorin Basca</ul>
156*b2c653efSSorin Basca</div>
157*b2c653efSSorin Basca<div class="details">
158*b2c653efSSorin Basca<ul class="blockList">
159*b2c653efSSorin Basca<li class="blockList">
160*b2c653efSSorin Basca<!-- ============ ANNOTATION TYPE MEMBER DETAIL =========== -->
161*b2c653efSSorin Basca<ul class="blockList">
162*b2c653efSSorin Basca<li class="blockList"><a name="annotation.type.element.detail">
163*b2c653efSSorin Basca<!--   -->
164*b2c653efSSorin Basca</a>
165*b2c653efSSorin Basca<h3>Element Detail</h3>
166*b2c653efSSorin Basca<a name="value--">
167*b2c653efSSorin Basca<!--   -->
168*b2c653efSSorin Basca</a>
169*b2c653efSSorin Basca<ul class="blockListLast">
170*b2c653efSSorin Basca<li class="blockList">
171*b2c653efSSorin Basca<h4>value</h4>
172*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>
173*b2c653efSSorin Basca<div class="block">File name (with full path) of the file with data.</div>
174*b2c653efSSorin Basca</li>
175*b2c653efSSorin Basca</ul>
176*b2c653efSSorin Basca</li>
177*b2c653efSSorin Basca</ul>
178*b2c653efSSorin Basca<!-- ============ ANNOTATION TYPE MEMBER DETAIL =========== -->
179*b2c653efSSorin Basca<ul class="blockList">
180*b2c653efSSorin Basca<li class="blockList"><a name="mapper--">
181*b2c653efSSorin Basca<!--   -->
182*b2c653efSSorin Basca</a>
183*b2c653efSSorin Basca<ul class="blockListLast">
184*b2c653efSSorin Basca<li class="blockList">
185*b2c653efSSorin Basca<h4>mapper</h4>
186*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;? extends <a href="../junitparams/mappers/DataMapper.html" title="interface in junitparams.mappers">DataMapper</a>&gt;&nbsp;mapper</pre>
187*b2c653efSSorin Basca<div class="block">The mapper which knows how to get the data from the external resource and
188*b2c653efSSorin Basca turn it into a valid set of parameters. By default it is an
189*b2c653efSSorin Basca IdentityMapper, meaning the resource has exactly the same format as the
190*b2c653efSSorin Basca
191*b2c653efSSorin Basca &#064;Parameters annotation value (when passed as String), being CSV.</div>
192*b2c653efSSorin Basca<dl>
193*b2c653efSSorin Basca<dt>Default:</dt>
194*b2c653efSSorin Basca<dd>junitparams.mappers.IdentityMapper.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</li>
201*b2c653efSSorin Basca</ul>
202*b2c653efSSorin Basca</div>
203*b2c653efSSorin Basca</div>
204*b2c653efSSorin Basca<!-- ========= END OF CLASS DATA ========= -->
205*b2c653efSSorin Basca<!-- ======= START OF BOTTOM NAVBAR ====== -->
206*b2c653efSSorin Basca<div class="bottomNav"><a name="navbar.bottom">
207*b2c653efSSorin Basca<!--   -->
208*b2c653efSSorin Basca</a>
209*b2c653efSSorin Basca<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
210*b2c653efSSorin Basca<a name="navbar.bottom.firstrow">
211*b2c653efSSorin Basca<!--   -->
212*b2c653efSSorin Basca</a>
213*b2c653efSSorin Basca<ul class="navList" title="Navigation">
214*b2c653efSSorin Basca<li><a href="../overview-summary.html">Overview</a></li>
215*b2c653efSSorin Basca<li><a href="package-summary.html">Package</a></li>
216*b2c653efSSorin Basca<li class="navBarCell1Rev">Class</li>
217*b2c653efSSorin Basca<li><a href="class-use/FileParameters.html">Use</a></li>
218*b2c653efSSorin Basca<li><a href="package-tree.html">Tree</a></li>
219*b2c653efSSorin Basca<li><a href="../deprecated-list.html">Deprecated</a></li>
220*b2c653efSSorin Basca<li><a href="../index-all.html">Index</a></li>
221*b2c653efSSorin Basca<li><a href="../help-doc.html">Help</a></li>
222*b2c653efSSorin Basca</ul>
223*b2c653efSSorin Basca</div>
224*b2c653efSSorin Basca<div class="subNav">
225*b2c653efSSorin Basca<ul class="navList">
226*b2c653efSSorin Basca<li>Prev&nbsp;Class</li>
227*b2c653efSSorin Basca<li><a href="../junitparams/JUnitParamsRunner.html" title="class in junitparams"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
228*b2c653efSSorin Basca</ul>
229*b2c653efSSorin Basca<ul class="navList">
230*b2c653efSSorin Basca<li><a href="../index.html?junitparams/FileParameters.html" target="_top">Frames</a></li>
231*b2c653efSSorin Basca<li><a href="FileParameters.html" target="_top">No&nbsp;Frames</a></li>
232*b2c653efSSorin Basca</ul>
233*b2c653efSSorin Basca<ul class="navList" id="allclasses_navbar_bottom">
234*b2c653efSSorin Basca<li><a href="../allclasses-noframe.html">All&nbsp;Classes</a></li>
235*b2c653efSSorin Basca</ul>
236*b2c653efSSorin Basca<div>
237*b2c653efSSorin Basca<script type="text/javascript"><!--
238*b2c653efSSorin Basca  allClassesLink = document.getElementById("allclasses_navbar_bottom");
239*b2c653efSSorin Basca  if(window==top) {
240*b2c653efSSorin Basca    allClassesLink.style.display = "block";
241*b2c653efSSorin Basca  }
242*b2c653efSSorin Basca  else {
243*b2c653efSSorin Basca    allClassesLink.style.display = "none";
244*b2c653efSSorin Basca  }
245*b2c653efSSorin Basca  //-->
246*b2c653efSSorin Basca</script>
247*b2c653efSSorin Basca</div>
248*b2c653efSSorin Basca<div>
249*b2c653efSSorin Basca<ul class="subNavList">
250*b2c653efSSorin Basca<li>Summary:&nbsp;</li>
251*b2c653efSSorin Basca<li>Field&nbsp;|&nbsp;</li>
252*b2c653efSSorin Basca<li><a href="#annotation.type.required.element.summary">Required</a>&nbsp;|&nbsp;</li>
253*b2c653efSSorin Basca<li><a href="#annotation.type.optional.element.summary">Optional</a></li>
254*b2c653efSSorin Basca</ul>
255*b2c653efSSorin Basca<ul class="subNavList">
256*b2c653efSSorin Basca<li>Detail:&nbsp;</li>
257*b2c653efSSorin Basca<li>Field&nbsp;|&nbsp;</li>
258*b2c653efSSorin Basca<li><a href="#annotation.type.element.detail">Element</a></li>
259*b2c653efSSorin Basca</ul>
260*b2c653efSSorin Basca</div>
261*b2c653efSSorin Basca<a name="skip.navbar.bottom">
262*b2c653efSSorin Basca<!--   -->
263*b2c653efSSorin Basca</a></div>
264*b2c653efSSorin Basca<!-- ======== END OF BOTTOM NAVBAR ======= -->
265*b2c653efSSorin Basca<p class="legalCopy"><small>Copyright &#169; 2014 <a href="http://pragmatists.pl">Pragmatists</a>. All rights reserved.</small></p>
266*b2c653efSSorin Basca</body>
267*b2c653efSSorin Basca</html>
268