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