• Home
  • History
  • Annotate
  • 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 Tue Jan 23 20:10:05 PST 2018 -->
6<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
7<title>JacksonInject (Jackson-annotations 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</head>
11<body>
12<script type="text/javascript"><!--
13    if (location.href.indexOf('is-external=true') == -1) {
14        parent.document.title="JacksonInject (Jackson-annotations 2.9.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="../../../../com/fasterxml/jackson/annotation/package-summary.html">Package</a></li>
29<li class="navBarCell1Rev">Class</li>
30<li><a href="class-use/JacksonInject.html">Use</a></li>
31<li><a href="package-tree.html">Tree</a></li>
32<li><a href="../../../../deprecated-list.html">Deprecated</a></li>
33<li><a href="../../../../index-all.html">Index</a></li>
34<li><a href="../../../../help-doc.html">Help</a></li>
35</ul>
36</div>
37<div class="subNav">
38<ul class="navList">
39<li><a href="../../../../com/fasterxml/jackson/annotation/JacksonAnnotationValue.html" title="interface in com.fasterxml.jackson.annotation"><span class="strong">Prev Class</span></a></li>
40<li><a href="../../../../com/fasterxml/jackson/annotation/JacksonInject.Value.html" title="class in com.fasterxml.jackson.annotation"><span class="strong">Next Class</span></a></li>
41</ul>
42<ul class="navList">
43<li><a href="../../../../index.html?com/fasterxml/jackson/annotation/JacksonInject.html" target="_top">Frames</a></li>
44<li><a href="JacksonInject.html" target="_top">No Frames</a></li>
45</ul>
46<ul class="navList" id="allclasses_navbar_top">
47<li><a href="../../../../allclasses-noframe.html">All Classes</a></li>
48</ul>
49<div>
50<script type="text/javascript"><!--
51  allClassesLink = document.getElementById("allclasses_navbar_top");
52  if(window==top) {
53    allClassesLink.style.display = "block";
54  }
55  else {
56    allClassesLink.style.display = "none";
57  }
58  //-->
59</script>
60</div>
61<div>
62<ul class="subNavList">
63<li>Summary:&nbsp;</li>
64<li>Required&nbsp;|&nbsp;</li>
65<li><a href="#annotation_type_optional_element_summary">Optional</a></li>
66</ul>
67<ul class="subNavList">
68<li>Detail:&nbsp;</li>
69<li><a href="#annotation_type_element_detail">Element</a></li>
70</ul>
71</div>
72<a name="skip-navbar_top">
73<!--   -->
74</a></div>
75<!-- ========= END OF TOP NAVBAR ========= -->
76<!-- ======== START OF CLASS DATA ======== -->
77<div class="header">
78<div class="subTitle">com.fasterxml.jackson.annotation</div>
79<h2 title="Annotation Type JacksonInject" class="title">Annotation Type JacksonInject</h2>
80</div>
81<div class="contentContainer">
82<div class="description">
83<ul class="blockList">
84<li class="blockList">
85<hr>
86<br>
87<pre><a href="http://docs.oracle.com/javase/6/docs/api/java/lang/annotation/Target.html?is-external=true" title="class or interface in java.lang.annotation">@Target</a>(<a href="http://docs.oracle.com/javase/6/docs/api/java/lang/annotation/Target.html?is-external=true#value()" title="class or interface in java.lang.annotation">value</a>={<a href="http://docs.oracle.com/javase/6/docs/api/java/lang/annotation/ElementType.html?is-external=true#ANNOTATION_TYPE" title="class or interface in java.lang.annotation">ANNOTATION_TYPE</a>,<a href="http://docs.oracle.com/javase/6/docs/api/java/lang/annotation/ElementType.html?is-external=true#METHOD" title="class or interface in java.lang.annotation">METHOD</a>,<a href="http://docs.oracle.com/javase/6/docs/api/java/lang/annotation/ElementType.html?is-external=true#FIELD" title="class or interface in java.lang.annotation">FIELD</a>,<a href="http://docs.oracle.com/javase/6/docs/api/java/lang/annotation/ElementType.html?is-external=true#PARAMETER" title="class or interface in java.lang.annotation">PARAMETER</a>})
88<a href="http://docs.oracle.com/javase/6/docs/api/java/lang/annotation/Retention.html?is-external=true" title="class or interface in java.lang.annotation">@Retention</a>(<a href="http://docs.oracle.com/javase/6/docs/api/java/lang/annotation/Retention.html?is-external=true#value()" title="class or interface in java.lang.annotation">value</a>=<a href="http://docs.oracle.com/javase/6/docs/api/java/lang/annotation/RetentionPolicy.html?is-external=true#RUNTIME" title="class or interface in java.lang.annotation">RUNTIME</a>)
89public @interface <span class="strong">JacksonInject</span></pre>
90<div class="block">Jackson-specific annotation used for indicating that value of
91 annotated property will be "injected", i.e. set based on value
92 configured by <code>ObjectMapper</code> (usually on per-call basis).
93 Usually property is not deserialized from JSON, although it possible
94 to have injected value as default and still allow optional override
95 from JSON.</div>
96</li>
97</ul>
98</div>
99<div class="summary">
100<ul class="blockList">
101<li class="blockList">
102<!-- =========== ANNOTATION TYPE OPTIONAL MEMBER SUMMARY =========== -->
103<ul class="blockList">
104<li class="blockList"><a name="annotation_type_optional_element_summary">
105<!--   -->
106</a>
107<h3>Optional Element Summary</h3>
108<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Optional Element Summary table, listing optional elements, and an explanation">
109<caption><span>Optional Elements</span><span class="tabEnd">&nbsp;</span></caption>
110<tr>
111<th class="colFirst" scope="col">Modifier and Type</th>
112<th class="colLast" scope="col">Optional Element and Description</th>
113</tr>
114<tr class="altColor">
115<td class="colFirst"><code><a href="../../../../com/fasterxml/jackson/annotation/OptBoolean.html" title="enum in com.fasterxml.jackson.annotation">OptBoolean</a></code></td>
116<td class="colLast"><code><strong><a href="../../../../com/fasterxml/jackson/annotation/JacksonInject.html#useInput()">useInput</a></strong></code>
117<div class="block">Whether matching input value is used for annotated property or not;
118 if disabled (`OptBoolean.FALSE`), input value (if any) will be ignored;
119 otherwise it will override injected value.</div>
120</td>
121</tr>
122<tr class="rowColor">
123<td class="colFirst"><code><a href="http://docs.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td>
124<td class="colLast"><code><strong><a href="../../../../com/fasterxml/jackson/annotation/JacksonInject.html#value()">value</a></strong></code>
125<div class="block">Logical id of the value to inject; if not specified (or specified
126 as empty String), will use id based on declared type of property.</div>
127</td>
128</tr>
129</table>
130</li>
131</ul>
132</li>
133</ul>
134</div>
135<div class="details">
136<ul class="blockList">
137<li class="blockList">
138<!-- ============ ANNOTATION TYPE MEMBER DETAIL =========== -->
139<ul class="blockList">
140<li class="blockList"><a name="annotation_type_element_detail">
141<!--   -->
142</a>
143<h3>Element Detail</h3>
144<a name="value()">
145<!--   -->
146</a>
147<ul class="blockList">
148<li class="blockList">
149<h4>value</h4>
150<pre>public abstract&nbsp;<a href="http://docs.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;value</pre>
151<div class="block">Logical id of the value to inject; if not specified (or specified
152 as empty String), will use id based on declared type of property.</div>
153<dl>
154<dt>Default:</dt>
155<dd>""</dd>
156</dl>
157</li>
158</ul>
159<a name="useInput()">
160<!--   -->
161</a>
162<ul class="blockListLast">
163<li class="blockList">
164<h4>useInput</h4>
165<pre>public abstract&nbsp;<a href="../../../../com/fasterxml/jackson/annotation/OptBoolean.html" title="enum in com.fasterxml.jackson.annotation">OptBoolean</a>&nbsp;useInput</pre>
166<div class="block">Whether matching input value is used for annotated property or not;
167 if disabled (`OptBoolean.FALSE`), input value (if any) will be ignored;
168 otherwise it will override injected value.
169<p>
170 Default is `OptBoolean.DEFAULT`, which translates to `OptBoolean.TRUE`: this is
171 for backwards compatibility (2.8 and earlier always allow binding input value).</div>
172<dl><dt><span class="strong">Since:</span></dt>
173  <dd>2.9</dd></dl>
174<dl>
175<dt>Default:</dt>
176<dd>com.fasterxml.jackson.annotation.OptBoolean.DEFAULT</dd>
177</dl>
178</li>
179</ul>
180</li>
181</ul>
182</li>
183</ul>
184</div>
185</div>
186<!-- ========= END OF CLASS DATA ========= -->
187<!-- ======= START OF BOTTOM NAVBAR ====== -->
188<div class="bottomNav"><a name="navbar_bottom">
189<!--   -->
190</a><a href="#skip-navbar_bottom" title="Skip navigation links"></a><a name="navbar_bottom_firstrow">
191<!--   -->
192</a>
193<ul class="navList" title="Navigation">
194<li><a href="../../../../com/fasterxml/jackson/annotation/package-summary.html">Package</a></li>
195<li class="navBarCell1Rev">Class</li>
196<li><a href="class-use/JacksonInject.html">Use</a></li>
197<li><a href="package-tree.html">Tree</a></li>
198<li><a href="../../../../deprecated-list.html">Deprecated</a></li>
199<li><a href="../../../../index-all.html">Index</a></li>
200<li><a href="../../../../help-doc.html">Help</a></li>
201</ul>
202</div>
203<div class="subNav">
204<ul class="navList">
205<li><a href="../../../../com/fasterxml/jackson/annotation/JacksonAnnotationValue.html" title="interface in com.fasterxml.jackson.annotation"><span class="strong">Prev Class</span></a></li>
206<li><a href="../../../../com/fasterxml/jackson/annotation/JacksonInject.Value.html" title="class in com.fasterxml.jackson.annotation"><span class="strong">Next Class</span></a></li>
207</ul>
208<ul class="navList">
209<li><a href="../../../../index.html?com/fasterxml/jackson/annotation/JacksonInject.html" target="_top">Frames</a></li>
210<li><a href="JacksonInject.html" target="_top">No Frames</a></li>
211</ul>
212<ul class="navList" id="allclasses_navbar_bottom">
213<li><a href="../../../../allclasses-noframe.html">All Classes</a></li>
214</ul>
215<div>
216<script type="text/javascript"><!--
217  allClassesLink = document.getElementById("allclasses_navbar_bottom");
218  if(window==top) {
219    allClassesLink.style.display = "block";
220  }
221  else {
222    allClassesLink.style.display = "none";
223  }
224  //-->
225</script>
226</div>
227<div>
228<ul class="subNavList">
229<li>Summary:&nbsp;</li>
230<li>Required&nbsp;|&nbsp;</li>
231<li><a href="#annotation_type_optional_element_summary">Optional</a></li>
232</ul>
233<ul class="subNavList">
234<li>Detail:&nbsp;</li>
235<li><a href="#annotation_type_element_detail">Element</a></li>
236</ul>
237</div>
238<a name="skip-navbar_bottom">
239<!--   -->
240</a></div>
241<!-- ======== END OF BOTTOM NAVBAR ======= -->
242<p class="legalCopy"><small>Copyright &#169; 2008&#x2013;2018 <a href="http://fasterxml.com/">FasterXML</a>. All rights reserved.</small></p>
243</body>
244</html>
245