• 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 (1.8.0_162) on Tue Jan 23 20:22:12 PST 2018 -->
6<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
7<title>InjectableValues (jackson-databind 2.9.0 API)</title>
8<meta name="date" content="2018-01-23">
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="InjectableValues (jackson-databind 2.9.0 API)";
17        }
18    }
19    catch(err) {
20    }
21//-->
22var methods = {"i0":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/InjectableValues.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/DeserializationFeature.html" title="enum in com.fasterxml.jackson.databind"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
54<li><a href="../../../../com/fasterxml/jackson/databind/InjectableValues.Std.html" title="class in com.fasterxml.jackson.databind"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
55</ul>
56<ul class="navList">
57<li><a href="../../../../index.html?com/fasterxml/jackson/databind/InjectableValues.html" target="_top">Frames</a></li>
58<li><a href="InjectableValues.html" target="_top">No&nbsp;Frames</a></li>
59</ul>
60<ul class="navList" id="allclasses_navbar_top">
61<li><a href="../../../../allclasses-noframe.html">All&nbsp;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:&nbsp;</li>
78<li><a href="#nested.class.summary">Nested</a>&nbsp;|&nbsp;</li>
79<li>Field&nbsp;|&nbsp;</li>
80<li><a href="#constructor.summary">Constr</a>&nbsp;|&nbsp;</li>
81<li><a href="#method.summary">Method</a></li>
82</ul>
83<ul class="subNavList">
84<li>Detail:&nbsp;</li>
85<li>Field&nbsp;|&nbsp;</li>
86<li><a href="#constructor.detail">Constr</a>&nbsp;|&nbsp;</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</div>
97<h2 title="Class InjectableValues" class="title">Class InjectableValues</h2>
98</div>
99<div class="contentContainer">
100<ul class="inheritance">
101<li><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">java.lang.Object</a></li>
102<li>
103<ul class="inheritance">
104<li>com.fasterxml.jackson.databind.InjectableValues</li>
105</ul>
106</li>
107</ul>
108<div class="description">
109<ul class="blockList">
110<li class="blockList">
111<dl>
112<dt>Direct Known Subclasses:</dt>
113<dd><a href="../../../../com/fasterxml/jackson/databind/InjectableValues.Std.html" title="class in com.fasterxml.jackson.databind">InjectableValues.Std</a></dd>
114</dl>
115<hr>
116<br>
117<pre>public abstract class <span class="typeNameLabel">InjectableValues</span>
118extends <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></pre>
119<div class="block">Abstract class that defines API for objects that provide value to
120 "inject" during deserialization. An instance of this object</div>
121</li>
122</ul>
123</div>
124<div class="summary">
125<ul class="blockList">
126<li class="blockList">
127<!-- ======== NESTED CLASS SUMMARY ======== -->
128<ul class="blockList">
129<li class="blockList"><a name="nested.class.summary">
130<!--   -->
131</a>
132<h3>Nested Class Summary</h3>
133<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Nested Class Summary table, listing nested classes, and an explanation">
134<caption><span>Nested Classes</span><span class="tabEnd">&nbsp;</span></caption>
135<tr>
136<th class="colFirst" scope="col">Modifier and Type</th>
137<th class="colLast" scope="col">Class and Description</th>
138</tr>
139<tr class="altColor">
140<td class="colFirst"><code>static class&nbsp;</code></td>
141<td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/fasterxml/jackson/databind/InjectableValues.Std.html" title="class in com.fasterxml.jackson.databind">InjectableValues.Std</a></span></code>
142<div class="block">Simple standard implementation which uses a simple Map to
143 store values to inject, identified by simple String keys.</div>
144</td>
145</tr>
146</table>
147</li>
148</ul>
149<!-- ======== CONSTRUCTOR SUMMARY ======== -->
150<ul class="blockList">
151<li class="blockList"><a name="constructor.summary">
152<!--   -->
153</a>
154<h3>Constructor Summary</h3>
155<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation">
156<caption><span>Constructors</span><span class="tabEnd">&nbsp;</span></caption>
157<tr>
158<th class="colOne" scope="col">Constructor and Description</th>
159</tr>
160<tr class="altColor">
161<td class="colOne"><code><span class="memberNameLink"><a href="../../../../com/fasterxml/jackson/databind/InjectableValues.html#InjectableValues--">InjectableValues</a></span>()</code>&nbsp;</td>
162</tr>
163</table>
164</li>
165</ul>
166<!-- ========== METHOD SUMMARY =========== -->
167<ul class="blockList">
168<li class="blockList"><a name="method.summary">
169<!--   -->
170</a>
171<h3>Method Summary</h3>
172<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
173<caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd">&nbsp;</span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t3" class="tableTab"><span><a href="javascript:show(4);">Abstract Methods</a></span><span class="tabEnd">&nbsp;</span></span></caption>
174<tr>
175<th class="colFirst" scope="col">Modifier and Type</th>
176<th class="colLast" scope="col">Method and Description</th>
177</tr>
178<tr id="i0" class="altColor">
179<td class="colFirst"><code>abstract <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></code></td>
180<td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/fasterxml/jackson/databind/InjectableValues.html#findInjectableValue-java.lang.Object-com.fasterxml.jackson.databind.DeserializationContext-com.fasterxml.jackson.databind.BeanProperty-java.lang.Object-">findInjectableValue</a></span>(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a>&nbsp;valueId,
181                   <a href="../../../../com/fasterxml/jackson/databind/DeserializationContext.html" title="class in com.fasterxml.jackson.databind">DeserializationContext</a>&nbsp;ctxt,
182                   <a href="../../../../com/fasterxml/jackson/databind/BeanProperty.html" title="interface in com.fasterxml.jackson.databind">BeanProperty</a>&nbsp;forProperty,
183                   <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a>&nbsp;beanInstance)</code>
184<div class="block">Method called to find value identified by id <code>valueId</code> to
185 inject as value of specified property during deserialization, passing
186 POJO instance in which value will be injected if it is available
187 (will be available when injected via field or setter; not available
188 when injected via constructor or factory method argument).</div>
189</td>
190</tr>
191</table>
192<ul class="blockList">
193<li class="blockList"><a name="methods.inherited.from.class.java.lang.Object">
194<!--   -->
195</a>
196<h3>Methods inherited from class&nbsp;java.lang.<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></h3>
197<code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#clone--" title="class or interface in java.lang">clone</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#equals-java.lang.Object-" title="class or interface in java.lang">equals</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#finalize--" title="class or interface in java.lang">finalize</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#getClass--" title="class or interface in java.lang">getClass</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#hashCode--" title="class or interface in java.lang">hashCode</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#notify--" title="class or interface in java.lang">notify</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#notifyAll--" title="class or interface in java.lang">notifyAll</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#toString--" title="class or interface in java.lang">toString</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#wait--" title="class or interface in java.lang">wait</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#wait-long-" title="class or interface in java.lang">wait</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#wait-long-int-" title="class or interface in java.lang">wait</a></code></li>
198</ul>
199</li>
200</ul>
201</li>
202</ul>
203</div>
204<div class="details">
205<ul class="blockList">
206<li class="blockList">
207<!-- ========= CONSTRUCTOR DETAIL ======== -->
208<ul class="blockList">
209<li class="blockList"><a name="constructor.detail">
210<!--   -->
211</a>
212<h3>Constructor Detail</h3>
213<a name="InjectableValues--">
214<!--   -->
215</a>
216<ul class="blockListLast">
217<li class="blockList">
218<h4>InjectableValues</h4>
219<pre>public&nbsp;InjectableValues()</pre>
220</li>
221</ul>
222</li>
223</ul>
224<!-- ============ METHOD DETAIL ========== -->
225<ul class="blockList">
226<li class="blockList"><a name="method.detail">
227<!--   -->
228</a>
229<h3>Method Detail</h3>
230<a name="findInjectableValue-java.lang.Object-com.fasterxml.jackson.databind.DeserializationContext-com.fasterxml.jackson.databind.BeanProperty-java.lang.Object-">
231<!--   -->
232</a>
233<ul class="blockListLast">
234<li class="blockList">
235<h4>findInjectableValue</h4>
236<pre>public abstract&nbsp;<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a>&nbsp;findInjectableValue(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a>&nbsp;valueId,
237                                           <a href="../../../../com/fasterxml/jackson/databind/DeserializationContext.html" title="class in com.fasterxml.jackson.databind">DeserializationContext</a>&nbsp;ctxt,
238                                           <a href="../../../../com/fasterxml/jackson/databind/BeanProperty.html" title="interface in com.fasterxml.jackson.databind">BeanProperty</a>&nbsp;forProperty,
239                                           <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a>&nbsp;beanInstance)
240                                    throws <a href="../../../../com/fasterxml/jackson/databind/JsonMappingException.html" title="class in com.fasterxml.jackson.databind">JsonMappingException</a></pre>
241<div class="block">Method called to find value identified by id <code>valueId</code> to
242 inject as value of specified property during deserialization, passing
243 POJO instance in which value will be injected if it is available
244 (will be available when injected via field or setter; not available
245 when injected via constructor or factory method argument).</div>
246<dl>
247<dt><span class="paramLabel">Parameters:</span></dt>
248<dd><code>valueId</code> - Object that identifies value to inject; may be a simple
249   name or more complex identifier object, whatever provider needs</dd>
250<dd><code>ctxt</code> - Deserialization context</dd>
251<dd><code>forProperty</code> - Bean property in which value is to be injected</dd>
252<dd><code>beanInstance</code> - Bean instance that contains property to inject,
253    if available; null if bean has not yet been constructed.</dd>
254<dt><span class="throwsLabel">Throws:</span></dt>
255<dd><code><a href="../../../../com/fasterxml/jackson/databind/JsonMappingException.html" title="class in com.fasterxml.jackson.databind">JsonMappingException</a></code></dd>
256</dl>
257</li>
258</ul>
259</li>
260</ul>
261</li>
262</ul>
263</div>
264</div>
265<!-- ========= END OF CLASS DATA ========= -->
266<!-- ======= START OF BOTTOM NAVBAR ====== -->
267<div class="bottomNav"><a name="navbar.bottom">
268<!--   -->
269</a>
270<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
271<a name="navbar.bottom.firstrow">
272<!--   -->
273</a>
274<ul class="navList" title="Navigation">
275<li><a href="../../../../overview-summary.html">Overview</a></li>
276<li><a href="package-summary.html">Package</a></li>
277<li class="navBarCell1Rev">Class</li>
278<li><a href="class-use/InjectableValues.html">Use</a></li>
279<li><a href="package-tree.html">Tree</a></li>
280<li><a href="../../../../deprecated-list.html">Deprecated</a></li>
281<li><a href="../../../../index-all.html">Index</a></li>
282<li><a href="../../../../help-doc.html">Help</a></li>
283</ul>
284</div>
285<div class="subNav">
286<ul class="navList">
287<li><a href="../../../../com/fasterxml/jackson/databind/DeserializationFeature.html" title="enum in com.fasterxml.jackson.databind"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
288<li><a href="../../../../com/fasterxml/jackson/databind/InjectableValues.Std.html" title="class in com.fasterxml.jackson.databind"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
289</ul>
290<ul class="navList">
291<li><a href="../../../../index.html?com/fasterxml/jackson/databind/InjectableValues.html" target="_top">Frames</a></li>
292<li><a href="InjectableValues.html" target="_top">No&nbsp;Frames</a></li>
293</ul>
294<ul class="navList" id="allclasses_navbar_bottom">
295<li><a href="../../../../allclasses-noframe.html">All&nbsp;Classes</a></li>
296</ul>
297<div>
298<script type="text/javascript"><!--
299  allClassesLink = document.getElementById("allclasses_navbar_bottom");
300  if(window==top) {
301    allClassesLink.style.display = "block";
302  }
303  else {
304    allClassesLink.style.display = "none";
305  }
306  //-->
307</script>
308</div>
309<div>
310<ul class="subNavList">
311<li>Summary:&nbsp;</li>
312<li><a href="#nested.class.summary">Nested</a>&nbsp;|&nbsp;</li>
313<li>Field&nbsp;|&nbsp;</li>
314<li><a href="#constructor.summary">Constr</a>&nbsp;|&nbsp;</li>
315<li><a href="#method.summary">Method</a></li>
316</ul>
317<ul class="subNavList">
318<li>Detail:&nbsp;</li>
319<li>Field&nbsp;|&nbsp;</li>
320<li><a href="#constructor.detail">Constr</a>&nbsp;|&nbsp;</li>
321<li><a href="#method.detail">Method</a></li>
322</ul>
323</div>
324<a name="skip.navbar.bottom">
325<!--   -->
326</a></div>
327<!-- ======== END OF BOTTOM NAVBAR ======= -->
328<p class="legalCopy"><small>Copyright &#169; 2008&#x2013;2018 <a href="http://fasterxml.com/">FasterXML</a>. All rights reserved.</small></p>
329</body>
330</html>
331