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_162) on Sat Apr 25 17:14:49 PDT 2020 --> 6<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> 7<title>Converter (jackson-databind 2.11.0 API)</title> 8<meta name="date" content="2020-04-25"> 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.11.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>, 126<a href="../../../../../com/fasterxml/jackson/databind/deser/std/StdDelegatingDeserializer.html" title="class in com.fasterxml.jackson.databind.deser.std"><code>StdDelegatingDeserializer</code></a></dd> 127</dl> 128</li> 129</ul> 130</div> 131<div class="summary"> 132<ul class="blockList"> 133<li class="blockList"> 134<!-- ======== NESTED CLASS SUMMARY ======== --> 135<ul class="blockList"> 136<li class="blockList"><a name="nested.class.summary"> 137<!-- --> 138</a> 139<h3>Nested Class Summary</h3> 140<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Nested Class Summary table, listing nested classes, and an explanation"> 141<caption><span>Nested Classes</span><span class="tabEnd"> </span></caption> 142<tr> 143<th class="colFirst" scope="col">Modifier and Type</th> 144<th class="colLast" scope="col">Interface and Description</th> 145</tr> 146<tr class="altColor"> 147<td class="colFirst"><code>static class </code></td> 148<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> 149<div class="block">This marker class is only to be used with annotations, to 150 indicate that <b>no converter is to be used</b>.</div> 151</td> 152</tr> 153</table> 154</li> 155</ul> 156<!-- ========== METHOD SUMMARY =========== --> 157<ul class="blockList"> 158<li class="blockList"><a name="method.summary"> 159<!-- --> 160</a> 161<h3>Method Summary</h3> 162<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation"> 163<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> 164<tr> 165<th class="colFirst" scope="col">Modifier and Type</th> 166<th class="colLast" scope="col">Method and Description</th> 167</tr> 168<tr id="i0" class="altColor"> 169<td class="colFirst"><code><a href="../../../../../com/fasterxml/jackson/databind/util/Converter.html" title="type parameter in Converter">OUT</a></code></td> 170<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> 171<div class="block">Main conversion method.</div> 172</td> 173</tr> 174<tr id="i1" class="rowColor"> 175<td class="colFirst"><code><a href="../../../../../com/fasterxml/jackson/databind/JavaType.html" title="class in com.fasterxml.jackson.databind">JavaType</a></code></td> 176<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> 177<div class="block">Method that can be used to find out actual input (source) type; this 178 usually can be determined from type parameters, but may need 179 to be implemented differently from programmatically defined 180 converters (which cannot change static type parameter bindings).</div> 181</td> 182</tr> 183<tr id="i2" class="altColor"> 184<td class="colFirst"><code><a href="../../../../../com/fasterxml/jackson/databind/JavaType.html" title="class in com.fasterxml.jackson.databind">JavaType</a></code></td> 185<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> 186<div class="block">Method that can be used to find out actual output (target) type; this 187 usually can be determined from type parameters, but may need 188 to be implemented differently from programmatically defined 189 converters (which cannot change static type parameter bindings).</div> 190</td> 191</tr> 192</table> 193</li> 194</ul> 195</li> 196</ul> 197</div> 198<div class="details"> 199<ul class="blockList"> 200<li class="blockList"> 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="convert-java.lang.Object-"> 208<!-- --> 209</a><a name="convert-IN-"> 210<!-- --> 211</a> 212<ul class="blockList"> 213<li class="blockList"> 214<h4>convert</h4> 215<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> 216<div class="block">Main conversion method.</div> 217</li> 218</ul> 219<a name="getInputType-com.fasterxml.jackson.databind.type.TypeFactory-"> 220<!-- --> 221</a> 222<ul class="blockList"> 223<li class="blockList"> 224<h4>getInputType</h4> 225<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> 226<div class="block">Method that can be used to find out actual input (source) type; this 227 usually can be determined from type parameters, but may need 228 to be implemented differently from programmatically defined 229 converters (which cannot change static type parameter bindings).</div> 230<dl> 231<dt><span class="simpleTagLabel">Since:</span></dt> 232<dd>2.2</dd> 233</dl> 234</li> 235</ul> 236<a name="getOutputType-com.fasterxml.jackson.databind.type.TypeFactory-"> 237<!-- --> 238</a> 239<ul class="blockListLast"> 240<li class="blockList"> 241<h4>getOutputType</h4> 242<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> 243<div class="block">Method that can be used to find out actual output (target) type; this 244 usually can be determined from type parameters, but may need 245 to be implemented differently from programmatically defined 246 converters (which cannot change static type parameter bindings).</div> 247<dl> 248<dt><span class="simpleTagLabel">Since:</span></dt> 249<dd>2.2</dd> 250</dl> 251</li> 252</ul> 253</li> 254</ul> 255</li> 256</ul> 257</div> 258</div> 259<!-- ========= END OF CLASS DATA ========= --> 260<!-- ======= START OF BOTTOM NAVBAR ====== --> 261<div class="bottomNav"><a name="navbar.bottom"> 262<!-- --> 263</a> 264<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div> 265<a name="navbar.bottom.firstrow"> 266<!-- --> 267</a> 268<ul class="navList" title="Navigation"> 269<li><a href="../../../../../overview-summary.html">Overview</a></li> 270<li><a href="package-summary.html">Package</a></li> 271<li class="navBarCell1Rev">Class</li> 272<li><a href="class-use/Converter.html">Use</a></li> 273<li><a href="package-tree.html">Tree</a></li> 274<li><a href="../../../../../deprecated-list.html">Deprecated</a></li> 275<li><a href="../../../../../index-all.html">Index</a></li> 276<li><a href="../../../../../help-doc.html">Help</a></li> 277</ul> 278</div> 279<div class="subNav"> 280<ul class="navList"> 281<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> 282<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> 283</ul> 284<ul class="navList"> 285<li><a href="../../../../../index.html?com/fasterxml/jackson/databind/util/Converter.html" target="_top">Frames</a></li> 286<li><a href="Converter.html" target="_top">No Frames</a></li> 287</ul> 288<ul class="navList" id="allclasses_navbar_bottom"> 289<li><a href="../../../../../allclasses-noframe.html">All Classes</a></li> 290</ul> 291<div> 292<script type="text/javascript"><!-- 293 allClassesLink = document.getElementById("allclasses_navbar_bottom"); 294 if(window==top) { 295 allClassesLink.style.display = "block"; 296 } 297 else { 298 allClassesLink.style.display = "none"; 299 } 300 //--> 301</script> 302</div> 303<div> 304<ul class="subNavList"> 305<li>Summary: </li> 306<li><a href="#nested.class.summary">Nested</a> | </li> 307<li>Field | </li> 308<li>Constr | </li> 309<li><a href="#method.summary">Method</a></li> 310</ul> 311<ul class="subNavList"> 312<li>Detail: </li> 313<li>Field | </li> 314<li>Constr | </li> 315<li><a href="#method.detail">Method</a></li> 316</ul> 317</div> 318<a name="skip.navbar.bottom"> 319<!-- --> 320</a></div> 321<!-- ======== END OF BOTTOM NAVBAR ======= --> 322<p class="legalCopy"><small>Copyright © 2008–2020 <a href="http://fasterxml.com/">FasterXML</a>. All rights reserved.</small></p> 323</body> 324</html> 325