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>CsvWithHeaderMapper (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="CsvWithHeaderMapper (JUnitParams 1.0.3-SNAPSHOT API)"; 17 } 18 } 19 catch(err) { 20 } 21 //--> 22 var methods = {"i0":10}; 23 var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],8:["t4","Concrete Methods"]}; 24 var altColor = "altColor"; 25 var rowColor = "rowColor"; 26 var tableTab = "tableTab"; 27 var activeTableTab = "activeTableTab"; 28 </script> 29 <noscript> 30 <div>JavaScript is disabled on your browser.</div> 31 </noscript> 32 <!-- ========= START OF TOP NAVBAR ======= --> 33 <div class="topNav"><a name="navbar.top"> 34 <!-- --> 35 </a> 36 <div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div> 37 <a name="navbar.top.firstrow"> 38 <!-- --> 39 </a> 40 <ul class="navList" title="Navigation"> 41 <li><a href="../../overview-summary.html">Overview</a></li> 42 <li><a href="package-summary.html">Package</a></li> 43 <li class="navBarCell1Rev">Class</li> 44 <li><a href="class-use/CsvWithHeaderMapper.html">Use</a></li> 45 <li><a href="package-tree.html">Tree</a></li> 46 <li><a href="../../deprecated-list.html">Deprecated</a></li> 47 <li><a href="../../index-all.html">Index</a></li> 48 <li><a href="../../help-doc.html">Help</a></li> 49 </ul> 50 </div> 51 <div class="subNav"> 52 <ul class="navList"> 53 <li>Prev Class</li> 54 <li><a href="../../junitparams/mappers/DataMapper.html" title="interface in junitparams.mappers"><span class="typeNameLink">Next Class</span></a></li> 55 </ul> 56 <ul class="navList"> 57 <li><a href="../../index.html?junitparams/mappers/CsvWithHeaderMapper.html" target="_top">Frames</a></li> 58 <li><a href="CsvWithHeaderMapper.html" target="_top">No Frames</a></li> 59 </ul> 60 <ul class="navList" id="allclasses_navbar_top"> 61 <li><a href="../../allclasses-noframe.html">All Classes</a></li> 62 </ul> 63 <div> 64 <script type="text/javascript"><!-- 65 allClassesLink = document.getElementById("allclasses_navbar_top"); 66 if(window==top) { 67 allClassesLink.style.display = "block"; 68 } 69 else { 70 allClassesLink.style.display = "none"; 71 } 72 //--> 73 </script> 74 </div> 75 <div> 76 <ul class="subNavList"> 77 <li>Summary: </li> 78 <li>Nested | </li> 79 <li>Field | </li> 80 <li><a href="#constructor.summary">Constr</a> | </li> 81 <li><a href="#method.summary">Method</a></li> 82 </ul> 83 <ul class="subNavList"> 84 <li>Detail: </li> 85 <li>Field | </li> 86 <li><a href="#constructor.detail">Constr</a> | </li> 87 <li><a href="#method.detail">Method</a></li> 88 </ul> 89 </div> 90 <a name="skip.navbar.top"> 91 <!-- --> 92 </a></div> 93 <!-- ========= END OF TOP NAVBAR ========= --> 94 <!-- ======== START OF CLASS DATA ======== --> 95 <div class="header"> 96 <div class="subTitle">junitparams.mappers</div> 97 <h2 title="Class CsvWithHeaderMapper" class="title">Class CsvWithHeaderMapper</h2> 98 </div> 99 <div class="contentContainer"> 100 <ul class="inheritance"> 101 <li><a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">java.lang.Object</a></li> 102 <li> 103 <ul class="inheritance"> 104 <li>junitparams.mappers.CsvWithHeaderMapper</li> 105 </ul> 106 </li> 107 </ul> 108 <div class="description"> 109 <ul class="blockList"> 110 <li class="blockList"> 111 <dl> 112 <dt>All Implemented Interfaces:</dt> 113 <dd><a href="../../junitparams/mappers/DataMapper.html" title="interface in junitparams.mappers">DataMapper</a></dd> 114 </dl> 115 <hr> 116 <br> 117 <pre>public class <span class="typeNameLabel">CsvWithHeaderMapper</span> 118 extends <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> 119 implements <a href="../../junitparams/mappers/DataMapper.html" title="interface in junitparams.mappers">DataMapper</a></pre> 120 <div class="block">Reads a CSV file starting from the second line - the first one is supposed to 121 be a header. If you don't want to skip the first line, use @FilePatameters 122 without any mapper.</div> 123 <dl> 124 <dt><span class="simpleTagLabel">Author:</span></dt> 125 <dd>Pawel Lipinski</dd> 126 </dl> 127 </li> 128 </ul> 129 </div> 130 <div class="summary"> 131 <ul class="blockList"> 132 <li class="blockList"> 133 <!-- ======== CONSTRUCTOR SUMMARY ======== --> 134 <ul class="blockList"> 135 <li class="blockList"><a name="constructor.summary"> 136 <!-- --> 137 </a> 138 <h3>Constructor Summary</h3> 139 <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation"> 140 <caption><span>Constructors</span><span class="tabEnd"> </span></caption> 141 <tr> 142 <th class="colOne" scope="col">Constructor and Description</th> 143 </tr> 144 <tr class="altColor"> 145 <td class="colOne"><code><span class="memberNameLink"><a href="../../junitparams/mappers/CsvWithHeaderMapper.html#CsvWithHeaderMapper--">CsvWithHeaderMapper</a></span>()</code> </td> 146 </tr> 147 </table> 148 </li> 149 </ul> 150 <!-- ========== METHOD SUMMARY =========== --> 151 <ul class="blockList"> 152 <li class="blockList"><a name="method.summary"> 153 <!-- --> 154 </a> 155 <h3>Method Summary</h3> 156 <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation"> 157 <caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd"> </span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd"> </span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd"> </span></span></caption> 158 <tr> 159 <th class="colFirst" scope="col">Modifier and Type</th> 160 <th class="colLast" scope="col">Method and Description</th> 161 </tr> 162 <tr id="i0" class="altColor"> 163 <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> 164 <td class="colLast"><code><span class="memberNameLink"><a href="../../junitparams/mappers/CsvWithHeaderMapper.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> reader)</code> 165 <div class="block">Maps file contents to parameters.</div> 166 </td> 167 </tr> 168 </table> 169 <ul class="blockList"> 170 <li class="blockList"><a name="methods.inherited.from.class.java.lang.Object"> 171 <!-- --> 172 </a> 173 <h3>Methods inherited from class java.lang.<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></h3> 174 <code><a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#clone--" title="class or interface in java.lang">clone</a>, <a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#equals-java.lang.Object-" title="class or interface in java.lang">equals</a>, <a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#finalize--" title="class or interface in java.lang">finalize</a>, <a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#getClass--" title="class or interface in java.lang">getClass</a>, <a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#hashCode--" title="class or interface in java.lang">hashCode</a>, <a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#notify--" title="class or interface in java.lang">notify</a>, <a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#notifyAll--" title="class or interface in java.lang">notifyAll</a>, <a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#toString--" title="class or interface in java.lang">toString</a>, <a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#wait--" title="class or interface in java.lang">wait</a>, <a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#wait-long-" title="class or interface in java.lang">wait</a>, <a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#wait-long-int-" title="class or interface in java.lang">wait</a></code></li> 175 </ul> 176 </li> 177 </ul> 178 </li> 179 </ul> 180 </div> 181 <div class="details"> 182 <ul class="blockList"> 183 <li class="blockList"> 184 <!-- ========= CONSTRUCTOR DETAIL ======== --> 185 <ul class="blockList"> 186 <li class="blockList"><a name="constructor.detail"> 187 <!-- --> 188 </a> 189 <h3>Constructor Detail</h3> 190 <a name="CsvWithHeaderMapper--"> 191 <!-- --> 192 </a> 193 <ul class="blockListLast"> 194 <li class="blockList"> 195 <h4>CsvWithHeaderMapper</h4> 196 <pre>public CsvWithHeaderMapper()</pre> 197 </li> 198 </ul> 199 </li> 200 </ul> 201 <!-- ============ METHOD DETAIL ========== --> 202 <ul class="blockList"> 203 <li class="blockList"><a name="method.detail"> 204 <!-- --> 205 </a> 206 <h3>Method Detail</h3> 207 <a name="map-java.io.Reader-"> 208 <!-- --> 209 </a> 210 <ul class="blockListLast"> 211 <li class="blockList"> 212 <h4>map</h4> 213 <pre>public <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>[] 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> reader)</pre> 214 <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../junitparams/mappers/DataMapper.html#map-java.io.Reader-">DataMapper</a></code></span></div> 215 <div class="block">Maps file contents to parameters. In your implementation read the data 216 from the reader. The reader is closed in the framework, so just read it 217 :) 218 219 While reading transform the data into Object[][], where external 220 dimension are different parameter sets, and internal dimension is the set 221 of params per single test call 222 223 You can optionally return Object[] with Strings inside, but each String 224 must be a string in the same format as what you would normally pass to 225 @Parameters({})</div> 226 <dl> 227 <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> 228 <dd><code><a href="../../junitparams/mappers/DataMapper.html#map-java.io.Reader-">map</a></code> in interface <code><a href="../../junitparams/mappers/DataMapper.html" title="interface in junitparams.mappers">DataMapper</a></code></dd> 229 <dt><span class="returnLabel">Returns:</span></dt> 230 <dd>an array with all parameter sets</dd> 231 </dl> 232 </li> 233 </ul> 234 </li> 235 </ul> 236 </li> 237 </ul> 238 </div> 239 </div> 240 <!-- ========= END OF CLASS DATA ========= --> 241 <!-- ======= START OF BOTTOM NAVBAR ====== --> 242 <div class="bottomNav"><a name="navbar.bottom"> 243 <!-- --> 244 </a> 245 <div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div> 246 <a name="navbar.bottom.firstrow"> 247 <!-- --> 248 </a> 249 <ul class="navList" title="Navigation"> 250 <li><a href="../../overview-summary.html">Overview</a></li> 251 <li><a href="package-summary.html">Package</a></li> 252 <li class="navBarCell1Rev">Class</li> 253 <li><a href="class-use/CsvWithHeaderMapper.html">Use</a></li> 254 <li><a href="package-tree.html">Tree</a></li> 255 <li><a href="../../deprecated-list.html">Deprecated</a></li> 256 <li><a href="../../index-all.html">Index</a></li> 257 <li><a href="../../help-doc.html">Help</a></li> 258 </ul> 259 </div> 260 <div class="subNav"> 261 <ul class="navList"> 262 <li>Prev Class</li> 263 <li><a href="../../junitparams/mappers/DataMapper.html" title="interface in junitparams.mappers"><span class="typeNameLink">Next Class</span></a></li> 264 </ul> 265 <ul class="navList"> 266 <li><a href="../../index.html?junitparams/mappers/CsvWithHeaderMapper.html" target="_top">Frames</a></li> 267 <li><a href="CsvWithHeaderMapper.html" target="_top">No Frames</a></li> 268 </ul> 269 <ul class="navList" id="allclasses_navbar_bottom"> 270 <li><a href="../../allclasses-noframe.html">All Classes</a></li> 271 </ul> 272 <div> 273 <script type="text/javascript"><!-- 274 allClassesLink = document.getElementById("allclasses_navbar_bottom"); 275 if(window==top) { 276 allClassesLink.style.display = "block"; 277 } 278 else { 279 allClassesLink.style.display = "none"; 280 } 281 //--> 282 </script> 283 </div> 284 <div> 285 <ul class="subNavList"> 286 <li>Summary: </li> 287 <li>Nested | </li> 288 <li>Field | </li> 289 <li><a href="#constructor.summary">Constr</a> | </li> 290 <li><a href="#method.summary">Method</a></li> 291 </ul> 292 <ul class="subNavList"> 293 <li>Detail: </li> 294 <li>Field | </li> 295 <li><a href="#constructor.detail">Constr</a> | </li> 296 <li><a href="#method.detail">Method</a></li> 297 </ul> 298 </div> 299 <a name="skip.navbar.bottom"> 300 <!-- --> 301 </a></div> 302 <!-- ======== END OF BOTTOM NAVBAR ======= --> 303 <p class="legalCopy"><small>Copyright © 2014 <a href="http://pragmatists.pl">Pragmatists</a>. All rights reserved.</small></p> 304 </body> 305 </html> 306
