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