Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / junit-params / 4de802c98f6c0030603b37726e485dac4f356cb0 / . / apidocs / junitparams / converters / ConvertParam.html
blob: 4b55080b2ab817346fbe72eae2fa10ede109cc07 [file] [log] [blame]
Paul Duffinfd1f9492016-07-12 11:23:47 +0100[diff] [blame]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>ConvertParam (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="ConvertParam (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/ConvertParam.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><a href="../../junitparams/converters/ConversionFailedException.html" title="class in junitparams.converters"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
48<li><a href="../../junitparams/converters/ParamConverter.html" title="interface in junitparams.converters"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
49</ul>
50<ul class="navList">
51<li><a href="../../index.html?junitparams/converters/ConvertParam.html" target="_top">Frames</a></li>
52<li><a href="ConvertParam.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.converters</div>
89<h2 title="Annotation Type ConvertParam" class="title">Annotation Type ConvertParam</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">ConvertParam</span></pre>
99<div class="block">Defines a converter which should be used to convert a parameter to expected
100 type.</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/Class.html?is-external=true" title="class or interface in java.lang">Class</a>&lt;? extends <a href="../../junitparams/converters/ParamConverter.html" title="interface in junitparams.converters">ParamConverter</a>&lt;?&gt;&gt;</code></td>
125<td class="colLast"><code><span class="memberNameLink"><a href="../../junitparams/converters/ConvertParam.html#value--">value</a></span></code>&nbsp;</td>
126</tr>
127</table>
128</li>
129</ul>
130<!-- =========== ANNOTATION TYPE OPTIONAL MEMBER SUMMARY =========== -->
131<ul class="blockList">
132<li class="blockList"><a name="annotation.type.optional.element.summary">
133<!-- -->
134</a>
135<h3>Optional Element Summary</h3>
136<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Optional Element Summary table, listing optional elements, and an explanation">
137<caption><span>Optional Elements</span><span class="tabEnd">&nbsp;</span></caption>
138<tr>
139<th class="colFirst" scope="col">Modifier and Type</th>
140<th class="colLast" scope="col">Optional Element and Description</th>
141</tr>
142<tr class="altColor">
143<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>
144<td class="colLast"><code><span class="memberNameLink"><a href="../../junitparams/converters/ConvertParam.html#options--">options</a></span></code>
145<div class="block">Options / settings to be used by the converter class</div>
146</td>
147</tr>
148</table>
149</li>
150</ul>
151</li>
152</ul>
153</div>
154<div class="details">
155<ul class="blockList">
156<li class="blockList">
157<!-- ============ ANNOTATION TYPE MEMBER DETAIL =========== -->
158<ul class="blockList">
159<li class="blockList"><a name="annotation.type.element.detail">
160<!-- -->
161</a>
162<h3>Element Detail</h3>
163<a name="value--">
164<!-- -->
165</a>
166<ul class="blockListLast">
167<li class="blockList">
168<h4>value</h4>
169<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/converters/ParamConverter.html" title="interface in junitparams.converters">ParamConverter</a>&lt;?&gt;&gt;&nbsp;value</pre>
170</li>
171</ul>
172</li>
173</ul>
174<!-- ============ ANNOTATION TYPE MEMBER DETAIL =========== -->
175<ul class="blockList">
176<li class="blockList"><a name="options--">
177<!-- -->
178</a>
179<ul class="blockListLast">
180<li class="blockList">
181<h4>options</h4>
182<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;options</pre>
183<div class="block">Options / settings to be used by the converter class</div>
184<dl>
185<dt><span class="returnLabel">Returns:</span></dt>
186</dl>
187<dl>
188<dt>Default:</dt>
189<dd>""</dd>
190</dl>
191</li>
192</ul>
193</li>
194</ul>
195</li>
196</ul>
197</div>
198</div>
199<!-- ========= END OF CLASS DATA ========= -->
200<!-- ======= START OF BOTTOM NAVBAR ====== -->
201<div class="bottomNav"><a name="navbar.bottom">
202<!-- -->
203</a>
204<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
205<a name="navbar.bottom.firstrow">
206<!-- -->
207</a>
208<ul class="navList" title="Navigation">
209<li><a href="../../overview-summary.html">Overview</a></li>
210<li><a href="package-summary.html">Package</a></li>
211<li class="navBarCell1Rev">Class</li>
212<li><a href="class-use/ConvertParam.html">Use</a></li>
213<li><a href="package-tree.html">Tree</a></li>
214<li><a href="../../deprecated-list.html">Deprecated</a></li>
215<li><a href="../../index-all.html">Index</a></li>
216<li><a href="../../help-doc.html">Help</a></li>
217</ul>
218</div>
219<div class="subNav">
220<ul class="navList">
221<li><a href="../../junitparams/converters/ConversionFailedException.html" title="class in junitparams.converters"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
222<li><a href="../../junitparams/converters/ParamConverter.html" title="interface in junitparams.converters"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
223</ul>
224<ul class="navList">
225<li><a href="../../index.html?junitparams/converters/ConvertParam.html" target="_top">Frames</a></li>
226<li><a href="ConvertParam.html" target="_top">No&nbsp;Frames</a></li>
227</ul>
228<ul class="navList" id="allclasses_navbar_bottom">
229<li><a href="../../allclasses-noframe.html">All&nbsp;Classes</a></li>
230</ul>
231<div>
232<script type="text/javascript"><!--
233 allClassesLink = document.getElementById("allclasses_navbar_bottom");
234 if(window==top) {
235 allClassesLink.style.display = "block";
236 }
237 else {
238 allClassesLink.style.display = "none";
239 }
240 //-->
241</script>
242</div>
243<div>
244<ul class="subNavList">
245<li>Summary:&nbsp;</li>
246<li>Field&nbsp;|&nbsp;</li>
247<li><a href="#annotation.type.required.element.summary">Required</a>&nbsp;|&nbsp;</li>
248<li><a href="#annotation.type.optional.element.summary">Optional</a></li>
249</ul>
250<ul class="subNavList">
251<li>Detail:&nbsp;</li>
252<li>Field&nbsp;|&nbsp;</li>
253<li><a href="#annotation.type.element.detail">Element</a></li>
254</ul>
255</div>
256<a name="skip.navbar.bottom">
257<!-- -->
258</a></div>
259<!-- ======== END OF BOTTOM NAVBAR ======= -->
260<p class="legalCopy"><small>Copyright &#169; 2014 <a href="http://pragmatists.pl">Pragmatists</a>. All rights reserved.</small></p>
261</body>
262</html>