xref: /aosp_15_r20/external/junit-params/apidocs/junitparams/mappers/DataMapper.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>DataMapper (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="DataMapper (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 Bascavar methods = {"i0":6};
23*b2c653efSSorin Bascavar tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],4:["t3","Abstract Methods"]};
24*b2c653efSSorin Bascavar altColor = "altColor";
25*b2c653efSSorin Bascavar rowColor = "rowColor";
26*b2c653efSSorin Bascavar tableTab = "tableTab";
27*b2c653efSSorin Bascavar activeTableTab = "activeTableTab";
28*b2c653efSSorin Basca</script>
29*b2c653efSSorin Basca<noscript>
30*b2c653efSSorin Basca<div>JavaScript is disabled on your browser.</div>
31*b2c653efSSorin Basca</noscript>
32*b2c653efSSorin Basca<!-- ========= START OF TOP NAVBAR ======= -->
33*b2c653efSSorin Basca<div class="topNav"><a name="navbar.top">
34*b2c653efSSorin Basca<!--   -->
35*b2c653efSSorin Basca</a>
36*b2c653efSSorin Basca<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div>
37*b2c653efSSorin Basca<a name="navbar.top.firstrow">
38*b2c653efSSorin Basca<!--   -->
39*b2c653efSSorin Basca</a>
40*b2c653efSSorin Basca<ul class="navList" title="Navigation">
41*b2c653efSSorin Basca<li><a href="../../overview-summary.html">Overview</a></li>
42*b2c653efSSorin Basca<li><a href="package-summary.html">Package</a></li>
43*b2c653efSSorin Basca<li class="navBarCell1Rev">Class</li>
44*b2c653efSSorin Basca<li><a href="class-use/DataMapper.html">Use</a></li>
45*b2c653efSSorin Basca<li><a href="package-tree.html">Tree</a></li>
46*b2c653efSSorin Basca<li><a href="../../deprecated-list.html">Deprecated</a></li>
47*b2c653efSSorin Basca<li><a href="../../index-all.html">Index</a></li>
48*b2c653efSSorin Basca<li><a href="../../help-doc.html">Help</a></li>
49*b2c653efSSorin Basca</ul>
50*b2c653efSSorin Basca</div>
51*b2c653efSSorin Basca<div class="subNav">
52*b2c653efSSorin Basca<ul class="navList">
53*b2c653efSSorin Basca<li><a href="../../junitparams/mappers/CsvWithHeaderMapper.html" title="class in junitparams.mappers"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
54*b2c653efSSorin Basca<li><a href="../../junitparams/mappers/IdentityMapper.html" title="class in junitparams.mappers"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
55*b2c653efSSorin Basca</ul>
56*b2c653efSSorin Basca<ul class="navList">
57*b2c653efSSorin Basca<li><a href="../../index.html?junitparams/mappers/DataMapper.html" target="_top">Frames</a></li>
58*b2c653efSSorin Basca<li><a href="DataMapper.html" target="_top">No&nbsp;Frames</a></li>
59*b2c653efSSorin Basca</ul>
60*b2c653efSSorin Basca<ul class="navList" id="allclasses_navbar_top">
61*b2c653efSSorin Basca<li><a href="../../allclasses-noframe.html">All&nbsp;Classes</a></li>
62*b2c653efSSorin Basca</ul>
63*b2c653efSSorin Basca<div>
64*b2c653efSSorin Basca<script type="text/javascript"><!--
65*b2c653efSSorin Basca  allClassesLink = document.getElementById("allclasses_navbar_top");
66*b2c653efSSorin Basca  if(window==top) {
67*b2c653efSSorin Basca    allClassesLink.style.display = "block";
68*b2c653efSSorin Basca  }
69*b2c653efSSorin Basca  else {
70*b2c653efSSorin Basca    allClassesLink.style.display = "none";
71*b2c653efSSorin Basca  }
72*b2c653efSSorin Basca  //-->
73*b2c653efSSorin Basca</script>
74*b2c653efSSorin Basca</div>
75*b2c653efSSorin Basca<div>
76*b2c653efSSorin Basca<ul class="subNavList">
77*b2c653efSSorin Basca<li>Summary:&nbsp;</li>
78*b2c653efSSorin Basca<li>Nested&nbsp;|&nbsp;</li>
79*b2c653efSSorin Basca<li>Field&nbsp;|&nbsp;</li>
80*b2c653efSSorin Basca<li>Constr&nbsp;|&nbsp;</li>
81*b2c653efSSorin Basca<li><a href="#method.summary">Method</a></li>
82*b2c653efSSorin Basca</ul>
83*b2c653efSSorin Basca<ul class="subNavList">
84*b2c653efSSorin Basca<li>Detail:&nbsp;</li>
85*b2c653efSSorin Basca<li>Field&nbsp;|&nbsp;</li>
86*b2c653efSSorin Basca<li>Constr&nbsp;|&nbsp;</li>
87*b2c653efSSorin Basca<li><a href="#method.detail">Method</a></li>
88*b2c653efSSorin Basca</ul>
89*b2c653efSSorin Basca</div>
90*b2c653efSSorin Basca<a name="skip.navbar.top">
91*b2c653efSSorin Basca<!--   -->
92*b2c653efSSorin Basca</a></div>
93*b2c653efSSorin Basca<!-- ========= END OF TOP NAVBAR ========= -->
94*b2c653efSSorin Basca<!-- ======== START OF CLASS DATA ======== -->
95*b2c653efSSorin Basca<div class="header">
96*b2c653efSSorin Basca<div class="subTitle">junitparams.mappers</div>
97*b2c653efSSorin Basca<h2 title="Interface DataMapper" class="title">Interface DataMapper</h2>
98*b2c653efSSorin Basca</div>
99*b2c653efSSorin Basca<div class="contentContainer">
100*b2c653efSSorin Basca<div class="description">
101*b2c653efSSorin Basca<ul class="blockList">
102*b2c653efSSorin Basca<li class="blockList">
103*b2c653efSSorin Basca<dl>
104*b2c653efSSorin Basca<dt>All Known Implementing Classes:</dt>
105*b2c653efSSorin Basca<dd><a href="../../junitparams/mappers/CsvWithHeaderMapper.html" title="class in junitparams.mappers">CsvWithHeaderMapper</a>, <a href="../../junitparams/mappers/IdentityMapper.html" title="class in junitparams.mappers">IdentityMapper</a></dd>
106*b2c653efSSorin Basca</dl>
107*b2c653efSSorin Basca<hr>
108*b2c653efSSorin Basca<br>
109*b2c653efSSorin Basca<pre>public interface <span class="typeNameLabel">DataMapper</span></pre>
110*b2c653efSSorin Basca<div class="block">Interface to be used by FileParameters'ized test methods. If you want to read
111*b2c653efSSorin Basca your own format of data from file, implement the map method appropriately.
112*b2c653efSSorin Basca For CSV files, just skip it.</div>
113*b2c653efSSorin Basca<dl>
114*b2c653efSSorin Basca<dt><span class="simpleTagLabel">Author:</span></dt>
115*b2c653efSSorin Basca<dd>Pawel Lipinski</dd>
116*b2c653efSSorin Basca</dl>
117*b2c653efSSorin Basca</li>
118*b2c653efSSorin Basca</ul>
119*b2c653efSSorin Basca</div>
120*b2c653efSSorin Basca<div class="summary">
121*b2c653efSSorin Basca<ul class="blockList">
122*b2c653efSSorin Basca<li class="blockList">
123*b2c653efSSorin Basca<!-- ========== METHOD SUMMARY =========== -->
124*b2c653efSSorin Basca<ul class="blockList">
125*b2c653efSSorin Basca<li class="blockList"><a name="method.summary">
126*b2c653efSSorin Basca<!--   -->
127*b2c653efSSorin Basca</a>
128*b2c653efSSorin Basca<h3>Method Summary</h3>
129*b2c653efSSorin Basca<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
130*b2c653efSSorin Basca<caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd">&nbsp;</span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t3" class="tableTab"><span><a href="javascript:show(4);">Abstract Methods</a></span><span class="tabEnd">&nbsp;</span></span></caption>
131*b2c653efSSorin Basca<tr>
132*b2c653efSSorin Basca<th class="colFirst" scope="col">Modifier and Type</th>
133*b2c653efSSorin Basca<th class="colLast" scope="col">Method and Description</th>
134*b2c653efSSorin Basca</tr>
135*b2c653efSSorin Basca<tr id="i0" class="altColor">
136*b2c653efSSorin Basca<td class="colFirst"><code><a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a>[]</code></td>
137*b2c653efSSorin Basca<td class="colLast"><code><span class="memberNameLink"><a href="../../junitparams/mappers/DataMapper.html#map-java.io.Reader-">map</a></span>(<a href="http://docs.oracle.com/javase/6/docs/api/java/io/Reader.html?is-external=true" title="class or interface in java.io">Reader</a>&nbsp;reader)</code>
138*b2c653efSSorin Basca<div class="block">Maps file contents to parameters.</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<!-- ============ METHOD DETAIL ========== -->
151*b2c653efSSorin Basca<ul class="blockList">
152*b2c653efSSorin Basca<li class="blockList"><a name="method.detail">
153*b2c653efSSorin Basca<!--   -->
154*b2c653efSSorin Basca</a>
155*b2c653efSSorin Basca<h3>Method Detail</h3>
156*b2c653efSSorin Basca<a name="map-java.io.Reader-">
157*b2c653efSSorin Basca<!--   -->
158*b2c653efSSorin Basca</a>
159*b2c653efSSorin Basca<ul class="blockListLast">
160*b2c653efSSorin Basca<li class="blockList">
161*b2c653efSSorin Basca<h4>map</h4>
162*b2c653efSSorin Basca<pre><a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a>[]&nbsp;map(<a href="http://docs.oracle.com/javase/6/docs/api/java/io/Reader.html?is-external=true" title="class or interface in java.io">Reader</a>&nbsp;reader)</pre>
163*b2c653efSSorin Basca<div class="block">Maps file contents to parameters. In your implementation read the data
164*b2c653efSSorin Basca from the reader. The reader is closed in the framework, so just read it
165*b2c653efSSorin Basca :)
166*b2c653efSSorin Basca
167*b2c653efSSorin Basca While reading transform the data into Object[][], where external
168*b2c653efSSorin Basca dimension are different parameter sets, and internal dimension is the set
169*b2c653efSSorin Basca of params per single test call
170*b2c653efSSorin Basca
171*b2c653efSSorin Basca You can optionally return Object[] with Strings inside, but each String
172*b2c653efSSorin Basca must be a string in the same format as what you would normally pass to
173*b2c653efSSorin Basca &#064;Parameters({})</div>
174*b2c653efSSorin Basca<dl>
175*b2c653efSSorin Basca<dt><span class="paramLabel">Parameters:</span></dt>
176*b2c653efSSorin Basca<dd><code>reader</code> - </dd>
177*b2c653efSSorin Basca<dt><span class="returnLabel">Returns:</span></dt>
178*b2c653efSSorin Basca<dd>an array with all parameter sets</dd>
179*b2c653efSSorin Basca</dl>
180*b2c653efSSorin Basca</li>
181*b2c653efSSorin Basca</ul>
182*b2c653efSSorin Basca</li>
183*b2c653efSSorin Basca</ul>
184*b2c653efSSorin Basca</li>
185*b2c653efSSorin Basca</ul>
186*b2c653efSSorin Basca</div>
187*b2c653efSSorin Basca</div>
188*b2c653efSSorin Basca<!-- ========= END OF CLASS DATA ========= -->
189*b2c653efSSorin Basca<!-- ======= START OF BOTTOM NAVBAR ====== -->
190*b2c653efSSorin Basca<div class="bottomNav"><a name="navbar.bottom">
191*b2c653efSSorin Basca<!--   -->
192*b2c653efSSorin Basca</a>
193*b2c653efSSorin Basca<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
194*b2c653efSSorin Basca<a name="navbar.bottom.firstrow">
195*b2c653efSSorin Basca<!--   -->
196*b2c653efSSorin Basca</a>
197*b2c653efSSorin Basca<ul class="navList" title="Navigation">
198*b2c653efSSorin Basca<li><a href="../../overview-summary.html">Overview</a></li>
199*b2c653efSSorin Basca<li><a href="package-summary.html">Package</a></li>
200*b2c653efSSorin Basca<li class="navBarCell1Rev">Class</li>
201*b2c653efSSorin Basca<li><a href="class-use/DataMapper.html">Use</a></li>
202*b2c653efSSorin Basca<li><a href="package-tree.html">Tree</a></li>
203*b2c653efSSorin Basca<li><a href="../../deprecated-list.html">Deprecated</a></li>
204*b2c653efSSorin Basca<li><a href="../../index-all.html">Index</a></li>
205*b2c653efSSorin Basca<li><a href="../../help-doc.html">Help</a></li>
206*b2c653efSSorin Basca</ul>
207*b2c653efSSorin Basca</div>
208*b2c653efSSorin Basca<div class="subNav">
209*b2c653efSSorin Basca<ul class="navList">
210*b2c653efSSorin Basca<li><a href="../../junitparams/mappers/CsvWithHeaderMapper.html" title="class in junitparams.mappers"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
211*b2c653efSSorin Basca<li><a href="../../junitparams/mappers/IdentityMapper.html" title="class in junitparams.mappers"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
212*b2c653efSSorin Basca</ul>
213*b2c653efSSorin Basca<ul class="navList">
214*b2c653efSSorin Basca<li><a href="../../index.html?junitparams/mappers/DataMapper.html" target="_top">Frames</a></li>
215*b2c653efSSorin Basca<li><a href="DataMapper.html" target="_top">No&nbsp;Frames</a></li>
216*b2c653efSSorin Basca</ul>
217*b2c653efSSorin Basca<ul class="navList" id="allclasses_navbar_bottom">
218*b2c653efSSorin Basca<li><a href="../../allclasses-noframe.html">All&nbsp;Classes</a></li>
219*b2c653efSSorin Basca</ul>
220*b2c653efSSorin Basca<div>
221*b2c653efSSorin Basca<script type="text/javascript"><!--
222*b2c653efSSorin Basca  allClassesLink = document.getElementById("allclasses_navbar_bottom");
223*b2c653efSSorin Basca  if(window==top) {
224*b2c653efSSorin Basca    allClassesLink.style.display = "block";
225*b2c653efSSorin Basca  }
226*b2c653efSSorin Basca  else {
227*b2c653efSSorin Basca    allClassesLink.style.display = "none";
228*b2c653efSSorin Basca  }
229*b2c653efSSorin Basca  //-->
230*b2c653efSSorin Basca</script>
231*b2c653efSSorin Basca</div>
232*b2c653efSSorin Basca<div>
233*b2c653efSSorin Basca<ul class="subNavList">
234*b2c653efSSorin Basca<li>Summary:&nbsp;</li>
235*b2c653efSSorin Basca<li>Nested&nbsp;|&nbsp;</li>
236*b2c653efSSorin Basca<li>Field&nbsp;|&nbsp;</li>
237*b2c653efSSorin Basca<li>Constr&nbsp;|&nbsp;</li>
238*b2c653efSSorin Basca<li><a href="#method.summary">Method</a></li>
239*b2c653efSSorin Basca</ul>
240*b2c653efSSorin Basca<ul class="subNavList">
241*b2c653efSSorin Basca<li>Detail:&nbsp;</li>
242*b2c653efSSorin Basca<li>Field&nbsp;|&nbsp;</li>
243*b2c653efSSorin Basca<li>Constr&nbsp;|&nbsp;</li>
244*b2c653efSSorin Basca<li><a href="#method.detail">Method</a></li>
245*b2c653efSSorin Basca</ul>
246*b2c653efSSorin Basca</div>
247*b2c653efSSorin Basca<a name="skip.navbar.bottom">
248*b2c653efSSorin Basca<!--   -->
249*b2c653efSSorin Basca</a></div>
250*b2c653efSSorin Basca<!-- ======== END OF BOTTOM NAVBAR ======= -->
251*b2c653efSSorin Basca<p class="legalCopy"><small>Copyright &#169; 2014 <a href="http://pragmatists.pl">Pragmatists</a>. All rights reserved.</small></p>
252*b2c653efSSorin Basca</body>
253*b2c653efSSorin Basca</html>
254