• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
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 (version 1.7.0_79) on Fri Jan 15 20:28:44 PST 2016 -->
6<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
7<title>Converter (jackson-databind 2.7.0 API)</title>
8<meta name="date" content="2016-01-15">
9<link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style">
10</head>
11<body>
12<script type="text/javascript"><!--
13    if (location.href.indexOf('is-external=true') == -1) {
14        parent.document.title="Converter (jackson-databind 2.7.0 API)";
15    }
16//-->
17</script>
18<noscript>
19<div>JavaScript is disabled on your browser.</div>
20</noscript>
21<!-- ========= START OF TOP NAVBAR ======= -->
22<div class="topNav"><a name="navbar_top">
23<!--   -->
24</a><a href="#skip-navbar_top" title="Skip navigation links"></a><a name="navbar_top_firstrow">
25<!--   -->
26</a>
27<ul class="navList" title="Navigation">
28<li><a href="../../../../../overview-summary.html">Overview</a></li>
29<li><a href="package-summary.html">Package</a></li>
30<li class="navBarCell1Rev">Class</li>
31<li><a href="class-use/Converter.html">Use</a></li>
32<li><a href="package-tree.html">Tree</a></li>
33<li><a href="../../../../../deprecated-list.html">Deprecated</a></li>
34<li><a href="../../../../../index-all.html">Index</a></li>
35<li><a href="../../../../../help-doc.html">Help</a></li>
36</ul>
37</div>
38<div class="subNav">
39<ul class="navList">
40<li><a href="../../../../../com/fasterxml/jackson/databind/util/CompactStringObjectMap.html" title="class in com.fasterxml.jackson.databind.util"><span class="strong">Prev Class</span></a></li>
41<li><a href="../../../../../com/fasterxml/jackson/databind/util/Converter.None.html" title="class in com.fasterxml.jackson.databind.util"><span class="strong">Next Class</span></a></li>
42</ul>
43<ul class="navList">
44<li><a href="../../../../../index.html?com/fasterxml/jackson/databind/util/Converter.html" target="_top">Frames</a></li>
45<li><a href="Converter.html" target="_top">No Frames</a></li>
46</ul>
47<ul class="navList" id="allclasses_navbar_top">
48<li><a href="../../../../../allclasses-noframe.html">All Classes</a></li>
49</ul>
50<div>
51<script type="text/javascript"><!--
52  allClassesLink = document.getElementById("allclasses_navbar_top");
53  if(window==top) {
54    allClassesLink.style.display = "block";
55  }
56  else {
57    allClassesLink.style.display = "none";
58  }
59  //-->
60</script>
61</div>
62<div>
63<ul class="subNavList">
64<li>Summary:&nbsp;</li>
65<li><a href="#nested_class_summary">Nested</a>&nbsp;|&nbsp;</li>
66<li>Field&nbsp;|&nbsp;</li>
67<li>Constr&nbsp;|&nbsp;</li>
68<li><a href="#method_summary">Method</a></li>
69</ul>
70<ul class="subNavList">
71<li>Detail:&nbsp;</li>
72<li>Field&nbsp;|&nbsp;</li>
73<li>Constr&nbsp;|&nbsp;</li>
74<li><a href="#method_detail">Method</a></li>
75</ul>
76</div>
77<a name="skip-navbar_top">
78<!--   -->
79</a></div>
80<!-- ========= END OF TOP NAVBAR ========= -->
81<!-- ======== START OF CLASS DATA ======== -->
82<div class="header">
83<div class="subTitle">com.fasterxml.jackson.databind.util</div>
84<h2 title="Interface Converter" class="title">Interface Converter&lt;IN,OUT&gt;</h2>
85</div>
86<div class="contentContainer">
87<div class="description">
88<ul class="blockList">
89<li class="blockList">
90<dl><dt><span class="strong">Type Parameters:</span></dt><dd><code>IN</code> - Type of values converter takes</dd><dd><code>OUT</code> - Result type from conversion</dd></dl>
91<dl>
92<dt>All Known Implementing Classes:</dt>
93<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>
94</dl>
95<hr>
96<br>
97<pre>public interface <span class="strong">Converter&lt;IN,OUT&gt;</span></pre>
98<div class="block">Helper interface for things that convert Objects of
99 one type to another.
100<p>
101 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>
102 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
103 help with default implementation of typically boiler-plate code.</div>
104<dl><dt><span class="strong">Since:</span></dt>
105  <dd>2.1</dd>
106<dt><span class="strong">See Also:</span></dt><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></dl>
107</li>
108</ul>
109</div>
110<div class="summary">
111<ul class="blockList">
112<li class="blockList">
113<!-- ======== NESTED CLASS SUMMARY ======== -->
114<ul class="blockList">
115<li class="blockList"><a name="nested_class_summary">
116<!--   -->
117</a>
118<h3>Nested Class Summary</h3>
119<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Nested Class Summary table, listing nested classes, and an explanation">
120<caption><span>Nested Classes</span><span class="tabEnd">&nbsp;</span></caption>
121<tr>
122<th class="colFirst" scope="col">Modifier and Type</th>
123<th class="colLast" scope="col">Interface and Description</th>
124</tr>
125<tr class="altColor">
126<td class="colFirst"><code>static class&nbsp;</code></td>
127<td class="colLast"><code><strong><a href="../../../../../com/fasterxml/jackson/databind/util/Converter.None.html" title="class in com.fasterxml.jackson.databind.util">Converter.None</a></strong></code>
128<div class="block">This marker class is only to be used with annotations, to
129 indicate that <b>no converter is to be used</b>.</div>
130</td>
131</tr>
132</table>
133</li>
134</ul>
135<!-- ========== METHOD SUMMARY =========== -->
136<ul class="blockList">
137<li class="blockList"><a name="method_summary">
138<!--   -->
139</a>
140<h3>Method Summary</h3>
141<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
142<caption><span>Methods</span><span class="tabEnd">&nbsp;</span></caption>
143<tr>
144<th class="colFirst" scope="col">Modifier and Type</th>
145<th class="colLast" scope="col">Method and Description</th>
146</tr>
147<tr class="altColor">
148<td class="colFirst"><code><a href="../../../../../com/fasterxml/jackson/databind/util/Converter.html" title="type parameter in Converter">OUT</a></code></td>
149<td class="colLast"><code><strong><a href="../../../../../com/fasterxml/jackson/databind/util/Converter.html#convert(IN)">convert</a></strong>(<a href="../../../../../com/fasterxml/jackson/databind/util/Converter.html" title="type parameter in Converter">IN</a>&nbsp;value)</code>
150<div class="block">Main conversion method.</div>
151</td>
152</tr>
153<tr class="rowColor">
154<td class="colFirst"><code><a href="../../../../../com/fasterxml/jackson/databind/JavaType.html" title="class in com.fasterxml.jackson.databind">JavaType</a></code></td>
155<td class="colLast"><code><strong><a href="../../../../../com/fasterxml/jackson/databind/util/Converter.html#getInputType(com.fasterxml.jackson.databind.type.TypeFactory)">getInputType</a></strong>(<a href="../../../../../com/fasterxml/jackson/databind/type/TypeFactory.html" title="class in com.fasterxml.jackson.databind.type">TypeFactory</a>&nbsp;typeFactory)</code>
156<div class="block">Method that can be used to find out actual input (source) type; this
157 usually can be determined from type parameters, but may need
158 to be implemented differently from programmatically defined
159 converters (which can not change static type parameter bindings).</div>
160</td>
161</tr>
162<tr class="altColor">
163<td class="colFirst"><code><a href="../../../../../com/fasterxml/jackson/databind/JavaType.html" title="class in com.fasterxml.jackson.databind">JavaType</a></code></td>
164<td class="colLast"><code><strong><a href="../../../../../com/fasterxml/jackson/databind/util/Converter.html#getOutputType(com.fasterxml.jackson.databind.type.TypeFactory)">getOutputType</a></strong>(<a href="../../../../../com/fasterxml/jackson/databind/type/TypeFactory.html" title="class in com.fasterxml.jackson.databind.type">TypeFactory</a>&nbsp;typeFactory)</code>
165<div class="block">Method that can be used to find out actual output (target) type; this
166 usually can be determined from type parameters, but may need
167 to be implemented differently from programmatically defined
168 converters (which can not change static type parameter bindings).</div>
169</td>
170</tr>
171</table>
172</li>
173</ul>
174</li>
175</ul>
176</div>
177<div class="details">
178<ul class="blockList">
179<li class="blockList">
180<!-- ============ METHOD DETAIL ========== -->
181<ul class="blockList">
182<li class="blockList"><a name="method_detail">
183<!--   -->
184</a>
185<h3>Method Detail</h3>
186<a name="convert(java.lang.Object)">
187<!--   -->
188</a><a name="convert(IN)">
189<!--   -->
190</a>
191<ul class="blockList">
192<li class="blockList">
193<h4>convert</h4>
194<pre><a href="../../../../../com/fasterxml/jackson/databind/util/Converter.html" title="type parameter in Converter">OUT</a>&nbsp;convert(<a href="../../../../../com/fasterxml/jackson/databind/util/Converter.html" title="type parameter in Converter">IN</a>&nbsp;value)</pre>
195<div class="block">Main conversion method.</div>
196</li>
197</ul>
198<a name="getInputType(com.fasterxml.jackson.databind.type.TypeFactory)">
199<!--   -->
200</a>
201<ul class="blockList">
202<li class="blockList">
203<h4>getInputType</h4>
204<pre><a href="../../../../../com/fasterxml/jackson/databind/JavaType.html" title="class in com.fasterxml.jackson.databind">JavaType</a>&nbsp;getInputType(<a href="../../../../../com/fasterxml/jackson/databind/type/TypeFactory.html" title="class in com.fasterxml.jackson.databind.type">TypeFactory</a>&nbsp;typeFactory)</pre>
205<div class="block">Method that can be used to find out actual input (source) type; this
206 usually can be determined from type parameters, but may need
207 to be implemented differently from programmatically defined
208 converters (which can not change static type parameter bindings).</div>
209<dl><dt><span class="strong">Since:</span></dt>
210  <dd>2.2</dd></dl>
211</li>
212</ul>
213<a name="getOutputType(com.fasterxml.jackson.databind.type.TypeFactory)">
214<!--   -->
215</a>
216<ul class="blockListLast">
217<li class="blockList">
218<h4>getOutputType</h4>
219<pre><a href="../../../../../com/fasterxml/jackson/databind/JavaType.html" title="class in com.fasterxml.jackson.databind">JavaType</a>&nbsp;getOutputType(<a href="../../../../../com/fasterxml/jackson/databind/type/TypeFactory.html" title="class in com.fasterxml.jackson.databind.type">TypeFactory</a>&nbsp;typeFactory)</pre>
220<div class="block">Method that can be used to find out actual output (target) type; this
221 usually can be determined from type parameters, but may need
222 to be implemented differently from programmatically defined
223 converters (which can not change static type parameter bindings).</div>
224<dl><dt><span class="strong">Since:</span></dt>
225  <dd>2.2</dd></dl>
226</li>
227</ul>
228</li>
229</ul>
230</li>
231</ul>
232</div>
233</div>
234<!-- ========= END OF CLASS DATA ========= -->
235<!-- ======= START OF BOTTOM NAVBAR ====== -->
236<div class="bottomNav"><a name="navbar_bottom">
237<!--   -->
238</a><a href="#skip-navbar_bottom" title="Skip navigation links"></a><a name="navbar_bottom_firstrow">
239<!--   -->
240</a>
241<ul class="navList" title="Navigation">
242<li><a href="../../../../../overview-summary.html">Overview</a></li>
243<li><a href="package-summary.html">Package</a></li>
244<li class="navBarCell1Rev">Class</li>
245<li><a href="class-use/Converter.html">Use</a></li>
246<li><a href="package-tree.html">Tree</a></li>
247<li><a href="../../../../../deprecated-list.html">Deprecated</a></li>
248<li><a href="../../../../../index-all.html">Index</a></li>
249<li><a href="../../../../../help-doc.html">Help</a></li>
250</ul>
251</div>
252<div class="subNav">
253<ul class="navList">
254<li><a href="../../../../../com/fasterxml/jackson/databind/util/CompactStringObjectMap.html" title="class in com.fasterxml.jackson.databind.util"><span class="strong">Prev Class</span></a></li>
255<li><a href="../../../../../com/fasterxml/jackson/databind/util/Converter.None.html" title="class in com.fasterxml.jackson.databind.util"><span class="strong">Next Class</span></a></li>
256</ul>
257<ul class="navList">
258<li><a href="../../../../../index.html?com/fasterxml/jackson/databind/util/Converter.html" target="_top">Frames</a></li>
259<li><a href="Converter.html" target="_top">No Frames</a></li>
260</ul>
261<ul class="navList" id="allclasses_navbar_bottom">
262<li><a href="../../../../../allclasses-noframe.html">All Classes</a></li>
263</ul>
264<div>
265<script type="text/javascript"><!--
266  allClassesLink = document.getElementById("allclasses_navbar_bottom");
267  if(window==top) {
268    allClassesLink.style.display = "block";
269  }
270  else {
271    allClassesLink.style.display = "none";
272  }
273  //-->
274</script>
275</div>
276<div>
277<ul class="subNavList">
278<li>Summary:&nbsp;</li>
279<li><a href="#nested_class_summary">Nested</a>&nbsp;|&nbsp;</li>
280<li>Field&nbsp;|&nbsp;</li>
281<li>Constr&nbsp;|&nbsp;</li>
282<li><a href="#method_summary">Method</a></li>
283</ul>
284<ul class="subNavList">
285<li>Detail:&nbsp;</li>
286<li>Field&nbsp;|&nbsp;</li>
287<li>Constr&nbsp;|&nbsp;</li>
288<li><a href="#method_detail">Method</a></li>
289</ul>
290</div>
291<a name="skip-navbar_bottom">
292<!--   -->
293</a></div>
294<!-- ======== END OF BOTTOM NAVBAR ======= -->
295<p class="legalCopy"><small>Copyright &#169; 2008&#x2013;2016 <a href="http://fasterxml.com/">FasterXML</a>. All rights reserved.</small></p>
296</body>
297</html>
298