1<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> 2<!-- NewPage --> 3<html lang="en"> 4<head> 5<!-- Generated by javadoc (1.8.0) on Sun Jul 19 11:36:54 PDT 2015 --> 6<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> 7<title>Converter (jackson-databind 2.6.0 API)</title> 8<meta name="date" content="2015-07-19"> 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="Converter (jackson-databind 2.6.0 API)"; 17 } 18 } 19 catch(err) { 20 } 21//--> 22var methods = {"i0":6,"i1":6,"i2":6}; 23var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],4:["t3","Abstract Methods"]}; 24var altColor = "altColor"; 25var rowColor = "rowColor"; 26var tableTab = "tableTab"; 27var 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/Converter.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="../../../../../com/fasterxml/jackson/databind/util/CompactStringObjectMap.html" title="class in com.fasterxml.jackson.databind.util"><span class="typeNameLink">Prev Class</span></a></li> 54<li><a href="../../../../../com/fasterxml/jackson/databind/util/Converter.None.html" title="class in com.fasterxml.jackson.databind.util"><span class="typeNameLink">Next Class</span></a></li> 55</ul> 56<ul class="navList"> 57<li><a href="../../../../../index.html?com/fasterxml/jackson/databind/util/Converter.html" target="_top">Frames</a></li> 58<li><a href="Converter.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><a href="#nested.class.summary">Nested</a> | </li> 79<li>Field | </li> 80<li>Constr | </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>Constr | </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">com.fasterxml.jackson.databind.util</div> 97<h2 title="Interface Converter" class="title">Interface Converter<IN,OUT></h2> 98</div> 99<div class="contentContainer"> 100<div class="description"> 101<ul class="blockList"> 102<li class="blockList"> 103<dl> 104<dt><span class="paramLabel">Type Parameters:</span></dt> 105<dd><code>IN</code> - Type of values converter takes</dd> 106<dd><code>OUT</code> - Result type from conversion</dd> 107</dl> 108<dl> 109<dt>All Known Implementing Classes:</dt> 110<dd><a href="../../../../../com/fasterxml/jackson/databind/util/Converter.None.html" title="class in com.fasterxml.jackson.databind.util">Converter.None</a>, <a href="../../../../../com/fasterxml/jackson/databind/util/StdConverter.html" title="class in com.fasterxml.jackson.databind.util">StdConverter</a></dd> 111</dl> 112<hr> 113<br> 114<pre>public interface <span class="typeNameLabel">Converter<IN,OUT></span></pre> 115<div class="block">Helper interface for things that convert Objects of 116 one type to another. 117<p> 118 NOTE: implementors are strongly encouraged to extend <a href="../../../../../com/fasterxml/jackson/databind/util/StdConverter.html" title="class in com.fasterxml.jackson.databind.util"><code>StdConverter</code></a> 119 instead of directly implementing <a href="../../../../../com/fasterxml/jackson/databind/util/Converter.html" title="interface in com.fasterxml.jackson.databind.util"><code>Converter</code></a>, since that can 120 help with default implementation of typically boiler-plate code.</div> 121<dl> 122<dt><span class="simpleTagLabel">Since:</span></dt> 123<dd>2.1</dd> 124<dt><span class="seeLabel">See Also:</span></dt> 125<dd><a href="../../../../../com/fasterxml/jackson/databind/ser/std/StdDelegatingSerializer.html" title="class in com.fasterxml.jackson.databind.ser.std"><code>StdDelegatingSerializer</code></a></dd> 126</dl> 127</li> 128</ul> 129</div> 130<div class="summary"> 131<ul class="blockList"> 132<li class="blockList"> 133<!-- ======== NESTED CLASS SUMMARY ======== --> 134<ul class="blockList"> 135<li class="blockList"><a name="nested.class.summary"> 136<!-- --> 137</a> 138<h3>Nested Class Summary</h3> 139<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Nested Class Summary table, listing nested classes, and an explanation"> 140<caption><span>Nested Classes</span><span class="tabEnd"> </span></caption> 141<tr> 142<th class="colFirst" scope="col">Modifier and Type</th> 143<th class="colLast" scope="col">Interface and Description</th> 144</tr> 145<tr class="altColor"> 146<td class="colFirst"><code>static class </code></td> 147<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../com/fasterxml/jackson/databind/util/Converter.None.html" title="class in com.fasterxml.jackson.databind.util">Converter.None</a></span></code> 148<div class="block">This marker class is only to be used with annotations, to 149 indicate that <b>no converter is to be used</b>.</div> 150</td> 151</tr> 152</table> 153</li> 154</ul> 155<!-- ========== METHOD SUMMARY =========== --> 156<ul class="blockList"> 157<li class="blockList"><a name="method.summary"> 158<!-- --> 159</a> 160<h3>Method Summary</h3> 161<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation"> 162<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="t3" class="tableTab"><span><a href="javascript:show(4);">Abstract Methods</a></span><span class="tabEnd"> </span></span></caption> 163<tr> 164<th class="colFirst" scope="col">Modifier and Type</th> 165<th class="colLast" scope="col">Method and Description</th> 166</tr> 167<tr id="i0" class="altColor"> 168<td class="colFirst"><code><a href="../../../../../com/fasterxml/jackson/databind/util/Converter.html" title="type parameter in Converter">OUT</a></code></td> 169<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../com/fasterxml/jackson/databind/util/Converter.html#convert-IN-">convert</a></span>(<a href="../../../../../com/fasterxml/jackson/databind/util/Converter.html" title="type parameter in Converter">IN</a> value)</code> 170<div class="block">Main conversion method.</div> 171</td> 172</tr> 173<tr id="i1" class="rowColor"> 174<td class="colFirst"><code><a href="../../../../../com/fasterxml/jackson/databind/JavaType.html" title="class in com.fasterxml.jackson.databind">JavaType</a></code></td> 175<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../com/fasterxml/jackson/databind/util/Converter.html#getInputType-com.fasterxml.jackson.databind.type.TypeFactory-">getInputType</a></span>(<a href="../../../../../com/fasterxml/jackson/databind/type/TypeFactory.html" title="class in com.fasterxml.jackson.databind.type">TypeFactory</a> typeFactory)</code> 176<div class="block">Method that can be used to find out actual input (source) type; this 177 usually can be determined from type parameters, but may need 178 to be implemented differently from programmatically defined 179 converters (which can not change static type parameter bindings).</div> 180</td> 181</tr> 182<tr id="i2" class="altColor"> 183<td class="colFirst"><code><a href="../../../../../com/fasterxml/jackson/databind/JavaType.html" title="class in com.fasterxml.jackson.databind">JavaType</a></code></td> 184<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../com/fasterxml/jackson/databind/util/Converter.html#getOutputType-com.fasterxml.jackson.databind.type.TypeFactory-">getOutputType</a></span>(<a href="../../../../../com/fasterxml/jackson/databind/type/TypeFactory.html" title="class in com.fasterxml.jackson.databind.type">TypeFactory</a> typeFactory)</code> 185<div class="block">Method that can be used to find out actual output (target) type; this 186 usually can be determined from type parameters, but may need 187 to be implemented differently from programmatically defined 188 converters (which can not change static type parameter bindings).</div> 189</td> 190</tr> 191</table> 192</li> 193</ul> 194</li> 195</ul> 196</div> 197<div class="details"> 198<ul class="blockList"> 199<li class="blockList"> 200<!-- ============ METHOD DETAIL ========== --> 201<ul class="blockList"> 202<li class="blockList"><a name="method.detail"> 203<!-- --> 204</a> 205<h3>Method Detail</h3> 206<a name="convert-java.lang.Object-"> 207<!-- --> 208</a><a name="convert-IN-"> 209<!-- --> 210</a> 211<ul class="blockList"> 212<li class="blockList"> 213<h4>convert</h4> 214<pre><a href="../../../../../com/fasterxml/jackson/databind/util/Converter.html" title="type parameter in Converter">OUT</a> convert(<a href="../../../../../com/fasterxml/jackson/databind/util/Converter.html" title="type parameter in Converter">IN</a> value)</pre> 215<div class="block">Main conversion method.</div> 216</li> 217</ul> 218<a name="getInputType-com.fasterxml.jackson.databind.type.TypeFactory-"> 219<!-- --> 220</a> 221<ul class="blockList"> 222<li class="blockList"> 223<h4>getInputType</h4> 224<pre><a href="../../../../../com/fasterxml/jackson/databind/JavaType.html" title="class in com.fasterxml.jackson.databind">JavaType</a> getInputType(<a href="../../../../../com/fasterxml/jackson/databind/type/TypeFactory.html" title="class in com.fasterxml.jackson.databind.type">TypeFactory</a> typeFactory)</pre> 225<div class="block">Method that can be used to find out actual input (source) type; this 226 usually can be determined from type parameters, but may need 227 to be implemented differently from programmatically defined 228 converters (which can not change static type parameter bindings).</div> 229<dl> 230<dt><span class="simpleTagLabel">Since:</span></dt> 231<dd>2.2</dd> 232</dl> 233</li> 234</ul> 235<a name="getOutputType-com.fasterxml.jackson.databind.type.TypeFactory-"> 236<!-- --> 237</a> 238<ul class="blockListLast"> 239<li class="blockList"> 240<h4>getOutputType</h4> 241<pre><a href="../../../../../com/fasterxml/jackson/databind/JavaType.html" title="class in com.fasterxml.jackson.databind">JavaType</a> getOutputType(<a href="../../../../../com/fasterxml/jackson/databind/type/TypeFactory.html" title="class in com.fasterxml.jackson.databind.type">TypeFactory</a> typeFactory)</pre> 242<div class="block">Method that can be used to find out actual output (target) type; this 243 usually can be determined from type parameters, but may need 244 to be implemented differently from programmatically defined 245 converters (which can not change static type parameter bindings).</div> 246<dl> 247<dt><span class="simpleTagLabel">Since:</span></dt> 248<dd>2.2</dd> 249</dl> 250</li> 251</ul> 252</li> 253</ul> 254</li> 255</ul> 256</div> 257</div> 258<!-- ========= END OF CLASS DATA ========= --> 259<!-- ======= START OF BOTTOM NAVBAR ====== --> 260<div class="bottomNav"><a name="navbar.bottom"> 261<!-- --> 262</a> 263<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div> 264<a name="navbar.bottom.firstrow"> 265<!-- --> 266</a> 267<ul class="navList" title="Navigation"> 268<li><a href="../../../../../overview-summary.html">Overview</a></li> 269<li><a href="package-summary.html">Package</a></li> 270<li class="navBarCell1Rev">Class</li> 271<li><a href="class-use/Converter.html">Use</a></li> 272<li><a href="package-tree.html">Tree</a></li> 273<li><a href="../../../../../deprecated-list.html">Deprecated</a></li> 274<li><a href="../../../../../index-all.html">Index</a></li> 275<li><a href="../../../../../help-doc.html">Help</a></li> 276</ul> 277</div> 278<div class="subNav"> 279<ul class="navList"> 280<li><a href="../../../../../com/fasterxml/jackson/databind/util/CompactStringObjectMap.html" title="class in com.fasterxml.jackson.databind.util"><span class="typeNameLink">Prev Class</span></a></li> 281<li><a href="../../../../../com/fasterxml/jackson/databind/util/Converter.None.html" title="class in com.fasterxml.jackson.databind.util"><span class="typeNameLink">Next Class</span></a></li> 282</ul> 283<ul class="navList"> 284<li><a href="../../../../../index.html?com/fasterxml/jackson/databind/util/Converter.html" target="_top">Frames</a></li> 285<li><a href="Converter.html" target="_top">No Frames</a></li> 286</ul> 287<ul class="navList" id="allclasses_navbar_bottom"> 288<li><a href="../../../../../allclasses-noframe.html">All Classes</a></li> 289</ul> 290<div> 291<script type="text/javascript"><!-- 292 allClassesLink = document.getElementById("allclasses_navbar_bottom"); 293 if(window==top) { 294 allClassesLink.style.display = "block"; 295 } 296 else { 297 allClassesLink.style.display = "none"; 298 } 299 //--> 300</script> 301</div> 302<div> 303<ul class="subNavList"> 304<li>Summary: </li> 305<li><a href="#nested.class.summary">Nested</a> | </li> 306<li>Field | </li> 307<li>Constr | </li> 308<li><a href="#method.summary">Method</a></li> 309</ul> 310<ul class="subNavList"> 311<li>Detail: </li> 312<li>Field | </li> 313<li>Constr | </li> 314<li><a href="#method.detail">Method</a></li> 315</ul> 316</div> 317<a name="skip.navbar.bottom"> 318<!-- --> 319</a></div> 320<!-- ======== END OF BOTTOM NAVBAR ======= --> 321<p class="legalCopy"><small>Copyright © 2014–2015 <a href="http://fasterxml.com/">FasterXML</a>. All rights reserved.</small></p> 322</body> 323</html> 324