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 Sat Apr 25 16:37:31 PDT 2020 --> 6<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> 7<title>JsonSetter (Jackson-annotations 2.11.0 API)</title> 8<meta name="date" content="2020-04-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="JsonSetter (Jackson-annotations 2.11.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/JsonSetter.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/JsonRootName.html" title="annotation in com.fasterxml.jackson.annotation"><span class="typeNameLink">Prev Class</span></a></li> 47<li><a href="../../../../com/fasterxml/jackson/annotation/JsonSetter.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/JsonSetter.html" target="_top">Frames</a></li> 51<li><a href="JsonSetter.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 JsonSetter" class="title">Annotation Type JsonSetter</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#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#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#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">JsonSetter</span></pre> 99<div class="block">Annotation that can be used to define a non-static, 100 single-argument method to be used as a "setter" for a logical property 101 as an alternative to recommended 102 <a href="../../../../com/fasterxml/jackson/annotation/JsonProperty.html" title="annotation in com.fasterxml.jackson.annotation"><code>JsonProperty</code></a> annotation; 103 or (as of 2.9 and later), specify additional aspects of the 104 assigning property a value during serialization.</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/Nulls.html" title="enum in com.fasterxml.jackson.annotation">Nulls</a></code></td> 125<td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/fasterxml/jackson/annotation/JsonSetter.html#contentNulls--">contentNulls</a></span></code> 126<div class="block">Specifies action to take when input to match into content value 127 (of a <a href="https://docs.oracle.com/javase/6/docs/api/java/util/Collection.html?is-external=true" title="class or interface in java.util"><code>Collection</code></a>, <a href="https://docs.oracle.com/javase/6/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util"><code>Map</code></a>, array, 128 or referential value) contains explicit `null` value 129 (if format has one) to bind.</div> 130</td> 131</tr> 132<tr class="rowColor"> 133<td class="colFirst"><code><a href="../../../../com/fasterxml/jackson/annotation/Nulls.html" title="enum in com.fasterxml.jackson.annotation">Nulls</a></code></td> 134<td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/fasterxml/jackson/annotation/JsonSetter.html#nulls--">nulls</a></span></code> 135<div class="block">Specifies action to take when input contains explicit `null` value 136 (if format has one).</div> 137</td> 138</tr> 139<tr class="altColor"> 140<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> 141<td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/fasterxml/jackson/annotation/JsonSetter.html#value--">value</a></span></code> 142<div class="block">Optional default argument that defines logical property this 143 method is used to modify ("set"); this is the property 144 name used in JSON content.</div> 145</td> 146</tr> 147</table> 148</li> 149</ul> 150</li> 151</ul> 152</div> 153<div class="details"> 154<ul class="blockList"> 155<li class="blockList"> 156<!-- ============ ANNOTATION TYPE MEMBER DETAIL =========== --> 157<ul class="blockList"> 158<li class="blockList"><a name="annotation.type.element.detail"> 159<!-- --> 160</a> 161<h3>Element Detail</h3> 162<a name="value--"> 163<!-- --> 164</a> 165<ul class="blockList"> 166<li class="blockList"> 167<h4>value</h4> 168<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> 169<div class="block">Optional default argument that defines logical property this 170 method is used to modify ("set"); this is the property 171 name used in JSON content.</div> 172<dl> 173<dt>Default:</dt> 174<dd>""</dd> 175</dl> 176</li> 177</ul> 178</li> 179</ul> 180<ul class="blockList"> 181<li class="blockList"><a name="nulls--"> 182<!-- --> 183</a> 184<ul class="blockList"> 185<li class="blockList"> 186<h4>nulls</h4> 187<pre>public abstract <a href="../../../../com/fasterxml/jackson/annotation/Nulls.html" title="enum in com.fasterxml.jackson.annotation">Nulls</a> nulls</pre> 188<div class="block">Specifies action to take when input contains explicit `null` value 189 (if format has one). 190 Default action, in absence of any explicit configuration, 191 is usually <a href="../../../../com/fasterxml/jackson/annotation/Nulls.html#SET"><code>Nulls.SET</code></a>, meaning that the `null` is set as 192 value using setter. 193<p> 194 NOTE: is not usually used in case property value is missing, unless 195 data format specifies that there is defaulting which would result 196 in an explicit null assignment.</div> 197<dl> 198<dt>Default:</dt> 199<dd>com.fasterxml.jackson.annotation.Nulls.DEFAULT</dd> 200</dl> 201</li> 202</ul> 203</li> 204</ul> 205<ul class="blockList"> 206<li class="blockList"><a name="contentNulls--"> 207<!-- --> 208</a> 209<ul class="blockListLast"> 210<li class="blockList"> 211<h4>contentNulls</h4> 212<pre>public abstract <a href="../../../../com/fasterxml/jackson/annotation/Nulls.html" title="enum in com.fasterxml.jackson.annotation">Nulls</a> contentNulls</pre> 213<div class="block">Specifies action to take when input to match into content value 214 (of a <a href="https://docs.oracle.com/javase/6/docs/api/java/util/Collection.html?is-external=true" title="class or interface in java.util"><code>Collection</code></a>, <a href="https://docs.oracle.com/javase/6/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util"><code>Map</code></a>, array, 215 or referential value) contains explicit `null` value 216 (if format has one) to bind. 217 Default action, in absence of any explicit configuration, 218 is usually <a href="../../../../com/fasterxml/jackson/annotation/Nulls.html#SET"><code>Nulls.SET</code></a>, meaning that the `null` is included as usual.</div> 219<dl> 220<dt>Default:</dt> 221<dd>com.fasterxml.jackson.annotation.Nulls.DEFAULT</dd> 222</dl> 223</li> 224</ul> 225</li> 226</ul> 227</li> 228</ul> 229</div> 230</div> 231<!-- ========= END OF CLASS DATA ========= --> 232<!-- ======= START OF BOTTOM NAVBAR ====== --> 233<div class="bottomNav"><a name="navbar.bottom"> 234<!-- --> 235</a> 236<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div> 237<a name="navbar.bottom.firstrow"> 238<!-- --> 239</a> 240<ul class="navList" title="Navigation"> 241<li><a href="../../../../com/fasterxml/jackson/annotation/package-summary.html">Package</a></li> 242<li class="navBarCell1Rev">Class</li> 243<li><a href="class-use/JsonSetter.html">Use</a></li> 244<li><a href="package-tree.html">Tree</a></li> 245<li><a href="../../../../deprecated-list.html">Deprecated</a></li> 246<li><a href="../../../../index-all.html">Index</a></li> 247<li><a href="../../../../help-doc.html">Help</a></li> 248</ul> 249</div> 250<div class="subNav"> 251<ul class="navList"> 252<li><a href="../../../../com/fasterxml/jackson/annotation/JsonRootName.html" title="annotation in com.fasterxml.jackson.annotation"><span class="typeNameLink">Prev Class</span></a></li> 253<li><a href="../../../../com/fasterxml/jackson/annotation/JsonSetter.Value.html" title="class in com.fasterxml.jackson.annotation"><span class="typeNameLink">Next Class</span></a></li> 254</ul> 255<ul class="navList"> 256<li><a href="../../../../index.html?com/fasterxml/jackson/annotation/JsonSetter.html" target="_top">Frames</a></li> 257<li><a href="JsonSetter.html" target="_top">No Frames</a></li> 258</ul> 259<ul class="navList" id="allclasses_navbar_bottom"> 260<li><a href="../../../../allclasses-noframe.html">All Classes</a></li> 261</ul> 262<div> 263<script type="text/javascript"><!-- 264 allClassesLink = document.getElementById("allclasses_navbar_bottom"); 265 if(window==top) { 266 allClassesLink.style.display = "block"; 267 } 268 else { 269 allClassesLink.style.display = "none"; 270 } 271 //--> 272</script> 273</div> 274<div> 275<ul class="subNavList"> 276<li>Summary: </li> 277<li>Field | </li> 278<li>Required | </li> 279<li><a href="#annotation.type.optional.element.summary">Optional</a></li> 280</ul> 281<ul class="subNavList"> 282<li>Detail: </li> 283<li>Field | </li> 284<li><a href="#annotation.type.element.detail">Element</a></li> 285</ul> 286</div> 287<a name="skip.navbar.bottom"> 288<!-- --> 289</a></div> 290<!-- ======== END OF BOTTOM NAVBAR ======= --> 291<p class="legalCopy"><small>Copyright © 2008–2020 <a href="http://fasterxml.com/">FasterXML</a>. All rights reserved.</small></p> 292</body> 293</html> 294