Home | History | Annotate | Download | only in mappers
      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>IdentityMapper (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="IdentityMapper (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/IdentityMapper.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><a href="../../junitparams/mappers/DataMapper.html" title="interface in junitparams.mappers"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
     54 <li>Next&nbsp;Class</li>
     55 </ul>
     56 <ul class="navList">
     57 <li><a href="../../index.html?junitparams/mappers/IdentityMapper.html" target="_top">Frames</a></li>
     58 <li><a href="IdentityMapper.html" target="_top">No&nbsp;Frames</a></li>
     59 </ul>
     60 <ul class="navList" id="allclasses_navbar_top">
     61 <li><a href="../../allclasses-noframe.html">All&nbsp;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:&nbsp;</li>
     78 <li>Nested&nbsp;|&nbsp;</li>
     79 <li>Field&nbsp;|&nbsp;</li>
     80 <li><a href="#constructor.summary">Constr</a>&nbsp;|&nbsp;</li>
     81 <li><a href="#method.summary">Method</a></li>
     82 </ul>
     83 <ul class="subNavList">
     84 <li>Detail:&nbsp;</li>
     85 <li>Field&nbsp;|&nbsp;</li>
     86 <li><a href="#constructor.detail">Constr</a>&nbsp;|&nbsp;</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 IdentityMapper" class="title">Class IdentityMapper</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.IdentityMapper</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">IdentityMapper</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">A mapper, that maps contents of a file to a set of parameters for test
    121  methods. Basically a CSV with no header and ordering of columns exactly like
    122  the one in the test methods.
    123  
    124  It uses the logic from &#064;Parameters({}) for parsing lines of file, so be sure
    125  the columns in the file match exactly the ordering of arguments in the test
    126  method.</div>
    127 <dl>
    128 <dt><span class="simpleTagLabel">Author:</span></dt>
    129 <dd>Pawel Lipinski</dd>
    130 </dl>
    131 </li>
    132 </ul>
    133 </div>
    134 <div class="summary">
    135 <ul class="blockList">
    136 <li class="blockList">
    137 <!-- ======== CONSTRUCTOR SUMMARY ======== -->
    138 <ul class="blockList">
    139 <li class="blockList"><a name="constructor.summary">
    140 <!--   -->
    141 </a>
    142 <h3>Constructor Summary</h3>
    143 <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation">
    144 <caption><span>Constructors</span><span class="tabEnd">&nbsp;</span></caption>
    145 <tr>
    146 <th class="colOne" scope="col">Constructor and Description</th>
    147 </tr>
    148 <tr class="altColor">
    149 <td class="colOne"><code><span class="memberNameLink"><a href="../../junitparams/mappers/IdentityMapper.html#IdentityMapper--">IdentityMapper</a></span>()</code>&nbsp;</td>
    150 </tr>
    151 </table>
    152 </li>
    153 </ul>
    154 <!-- ========== METHOD SUMMARY =========== -->
    155 <ul class="blockList">
    156 <li class="blockList"><a name="method.summary">
    157 <!--   -->
    158 </a>
    159 <h3>Method Summary</h3>
    160 <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
    161 <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="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd">&nbsp;</span></span></caption>
    162 <tr>
    163 <th class="colFirst" scope="col">Modifier and Type</th>
    164 <th class="colLast" scope="col">Method and Description</th>
    165 </tr>
    166 <tr id="i0" class="altColor">
    167 <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>
    168 <td class="colLast"><code><span class="memberNameLink"><a href="../../junitparams/mappers/IdentityMapper.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>
    169 <div class="block">Maps file contents to parameters.</div>
    170 </td>
    171 </tr>
    172 </table>
    173 <ul class="blockList">
    174 <li class="blockList"><a name="methods.inherited.from.class.java.lang.Object">
    175 <!--   -->
    176 </a>
    177 <h3>Methods inherited from class&nbsp;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>
    178 <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>
    179 </ul>
    180 </li>
    181 </ul>
    182 </li>
    183 </ul>
    184 </div>
    185 <div class="details">
    186 <ul class="blockList">
    187 <li class="blockList">
    188 <!-- ========= CONSTRUCTOR DETAIL ======== -->
    189 <ul class="blockList">
    190 <li class="blockList"><a name="constructor.detail">
    191 <!--   -->
    192 </a>
    193 <h3>Constructor Detail</h3>
    194 <a name="IdentityMapper--">
    195 <!--   -->
    196 </a>
    197 <ul class="blockListLast">
    198 <li class="blockList">
    199 <h4>IdentityMapper</h4>
    200 <pre>public&nbsp;IdentityMapper()</pre>
    201 </li>
    202 </ul>
    203 </li>
    204 </ul>
    205 <!-- ============ METHOD DETAIL ========== -->
    206 <ul class="blockList">
    207 <li class="blockList"><a name="method.detail">
    208 <!--   -->
    209 </a>
    210 <h3>Method Detail</h3>
    211 <a name="map-java.io.Reader-">
    212 <!--   -->
    213 </a>
    214 <ul class="blockListLast">
    215 <li class="blockList">
    216 <h4>map</h4>
    217 <pre>public&nbsp;<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>
    218 <div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="../../junitparams/mappers/DataMapper.html#map-java.io.Reader-">DataMapper</a></code></span></div>
    219 <div class="block">Maps file contents to parameters. In your implementation read the data
    220  from the reader. The reader is closed in the framework, so just read it
    221  :)
    222  
    223  While reading transform the data into Object[][], where external
    224  dimension are different parameter sets, and internal dimension is the set
    225  of params per single test call
    226  
    227  You can optionally return Object[] with Strings inside, but each String
    228  must be a string in the same format as what you would normally pass to
    229  &#064;Parameters({})</div>
    230 <dl>
    231 <dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
    232 <dd><code><a href="../../junitparams/mappers/DataMapper.html#map-java.io.Reader-">map</a></code>&nbsp;in interface&nbsp;<code><a href="../../junitparams/mappers/DataMapper.html" title="interface in junitparams.mappers">DataMapper</a></code></dd>
    233 <dt><span class="returnLabel">Returns:</span></dt>
    234 <dd>an array with all parameter sets</dd>
    235 </dl>
    236 </li>
    237 </ul>
    238 </li>
    239 </ul>
    240 </li>
    241 </ul>
    242 </div>
    243 </div>
    244 <!-- ========= END OF CLASS DATA ========= -->
    245 <!-- ======= START OF BOTTOM NAVBAR ====== -->
    246 <div class="bottomNav"><a name="navbar.bottom">
    247 <!--   -->
    248 </a>
    249 <div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
    250 <a name="navbar.bottom.firstrow">
    251 <!--   -->
    252 </a>
    253 <ul class="navList" title="Navigation">
    254 <li><a href="../../overview-summary.html">Overview</a></li>
    255 <li><a href="package-summary.html">Package</a></li>
    256 <li class="navBarCell1Rev">Class</li>
    257 <li><a href="class-use/IdentityMapper.html">Use</a></li>
    258 <li><a href="package-tree.html">Tree</a></li>
    259 <li><a href="../../deprecated-list.html">Deprecated</a></li>
    260 <li><a href="../../index-all.html">Index</a></li>
    261 <li><a href="../../help-doc.html">Help</a></li>
    262 </ul>
    263 </div>
    264 <div class="subNav">
    265 <ul class="navList">
    266 <li><a href="../../junitparams/mappers/DataMapper.html" title="interface in junitparams.mappers"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
    267 <li>Next&nbsp;Class</li>
    268 </ul>
    269 <ul class="navList">
    270 <li><a href="../../index.html?junitparams/mappers/IdentityMapper.html" target="_top">Frames</a></li>
    271 <li><a href="IdentityMapper.html" target="_top">No&nbsp;Frames</a></li>
    272 </ul>
    273 <ul class="navList" id="allclasses_navbar_bottom">
    274 <li><a href="../../allclasses-noframe.html">All&nbsp;Classes</a></li>
    275 </ul>
    276 <div>
    277 <script type="text/javascript"><!--
    278   allClassesLink = document.getElementById("allclasses_navbar_bottom");
    279   if(window==top) {
    280     allClassesLink.style.display = "block";
    281   }
    282   else {
    283     allClassesLink.style.display = "none";
    284   }
    285   //-->
    286 </script>
    287 </div>
    288 <div>
    289 <ul class="subNavList">
    290 <li>Summary:&nbsp;</li>
    291 <li>Nested&nbsp;|&nbsp;</li>
    292 <li>Field&nbsp;|&nbsp;</li>
    293 <li><a href="#constructor.summary">Constr</a>&nbsp;|&nbsp;</li>
    294 <li><a href="#method.summary">Method</a></li>
    295 </ul>
    296 <ul class="subNavList">
    297 <li>Detail:&nbsp;</li>
    298 <li>Field&nbsp;|&nbsp;</li>
    299 <li><a href="#constructor.detail">Constr</a>&nbsp;|&nbsp;</li>
    300 <li><a href="#method.detail">Method</a></li>
    301 </ul>
    302 </div>
    303 <a name="skip.navbar.bottom">
    304 <!--   -->
    305 </a></div>
    306 <!-- ======== END OF BOTTOM NAVBAR ======= -->
    307 <p class="legalCopy"><small>Copyright &#169; 2014 <a href="http://pragmatists.pl">Pragmatists</a>. All rights reserved.</small></p>
    308 </body>
    309 </html>
    310