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