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_55) on Thu Jan 01 15:31:15 PST 2015 --> 6<meta http-equiv="Content-Type" content="text/html" charset="UTF-8"> 7<title>JsonSetter (Jackson-annotations 2.5.0 API)</title> 8<meta name="date" content="2015-01-01"> 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="JsonSetter (Jackson-annotations 2.5.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/JsonSetter.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/JsonRootName.html" title="annotation in com.fasterxml.jackson.annotation"><span class="strong">Prev Class</span></a></li> 40<li><a href="../../../../com/fasterxml/jackson/annotation/JsonSubTypes.html" title="annotation 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/JsonSetter.html" target="_top">Frames</a></li> 44<li><a href="JsonSetter.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: </li> 64<li>Required | </li> 65<li><a href="#annotation_type_optional_element_summary">Optional</a></li> 66</ul> 67<ul class="subNavList"> 68<li>Detail: </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 JsonSetter" class="title">Annotation Type JsonSetter</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://download.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://download.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://download.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://download.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>}) 88<a href="http://download.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://download.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://download.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">JsonSetter</span></pre> 90<div class="block">Marker annotation that can be used to define a non-static, 91 single-argument method to be used as a "setter" for a logical property 92 as an alternative to recommended 93 <a href="../../../../com/fasterxml/jackson/annotation/JsonProperty.html" title="annotation in com.fasterxml.jackson.annotation"><code>JsonProperty</code></a> annotation (which was introduced in version 1.1). 94<p> 95 Setter means that when a property with matching name is encountered in 96 JSON content, this method will be used to set value of the property. 97<p> 98 NOTE: this annotation was briefly deprecated for version 1.5; but has 99 since been un-deprecated to both allow for asymmetric naming (possibly 100 different name when reading and writing JSON), and more importantly to 101 allow multi-argument setter method in future.</div> 102</li> 103</ul> 104</div> 105<div class="summary"> 106<ul class="blockList"> 107<li class="blockList"> 108<!-- =========== ANNOTATION TYPE OPTIONAL MEMBER SUMMARY =========== --> 109<ul class="blockList"> 110<li class="blockList"><a name="annotation_type_optional_element_summary"> 111<!-- --> 112</a> 113<h3>Optional Element Summary</h3> 114<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Optional Element Summary table, listing optional elements, and an explanation"> 115<caption><span>Optional Elements</span><span class="tabEnd"> </span></caption> 116<tr> 117<th class="colFirst" scope="col">Modifier and Type</th> 118<th class="colLast" scope="col">Optional Element and Description</th> 119</tr> 120<tr class="altColor"> 121<td class="colFirst"><code><a href="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td> 122<td class="colLast"><code><strong><a href="../../../../com/fasterxml/jackson/annotation/JsonSetter.html#value()">value</a></strong></code> 123<div class="block">Optional default argument that defines logical property this 124 method is used to modify ("set"); this is the property 125 name used in JSON content.</div> 126</td> 127</tr> 128</table> 129</li> 130</ul> 131</li> 132</ul> 133</div> 134<div class="details"> 135<ul class="blockList"> 136<li class="blockList"> 137<!-- ============ ANNOTATION TYPE MEMBER DETAIL =========== --> 138<ul class="blockList"> 139<li class="blockList"><a name="annotation_type_element_detail"> 140<!-- --> 141</a> 142<h3>Element Detail</h3> 143<a name="value()"> 144<!-- --> 145</a> 146<ul class="blockListLast"> 147<li class="blockList"> 148<h4>value</h4> 149<pre>public abstract <a href="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> value</pre> 150<div class="block">Optional default argument that defines logical property this 151 method is used to modify ("set"); this is the property 152 name used in JSON content.</div> 153<dl> 154<dt>Default:</dt> 155<dd>""</dd> 156</dl> 157</li> 158</ul> 159</li> 160</ul> 161</li> 162</ul> 163</div> 164</div> 165<!-- ========= END OF CLASS DATA ========= --> 166<!-- ======= START OF BOTTOM NAVBAR ====== --> 167<div class="bottomNav"><a name="navbar_bottom"> 168<!-- --> 169</a><a href="#skip-navbar_bottom" title="Skip navigation links"></a><a name="navbar_bottom_firstrow"> 170<!-- --> 171</a> 172<ul class="navList" title="Navigation"> 173<li><a href="../../../../com/fasterxml/jackson/annotation/package-summary.html">Package</a></li> 174<li class="navBarCell1Rev">Class</li> 175<li><a href="class-use/JsonSetter.html">Use</a></li> 176<li><a href="package-tree.html">Tree</a></li> 177<li><a href="../../../../deprecated-list.html">Deprecated</a></li> 178<li><a href="../../../../index-all.html">Index</a></li> 179<li><a href="../../../../help-doc.html">Help</a></li> 180</ul> 181</div> 182<div class="subNav"> 183<ul class="navList"> 184<li><a href="../../../../com/fasterxml/jackson/annotation/JsonRootName.html" title="annotation in com.fasterxml.jackson.annotation"><span class="strong">Prev Class</span></a></li> 185<li><a href="../../../../com/fasterxml/jackson/annotation/JsonSubTypes.html" title="annotation in com.fasterxml.jackson.annotation"><span class="strong">Next Class</span></a></li> 186</ul> 187<ul class="navList"> 188<li><a href="../../../../index.html?com/fasterxml/jackson/annotation/JsonSetter.html" target="_top">Frames</a></li> 189<li><a href="JsonSetter.html" target="_top">No Frames</a></li> 190</ul> 191<ul class="navList" id="allclasses_navbar_bottom"> 192<li><a href="../../../../allclasses-noframe.html">All Classes</a></li> 193</ul> 194<div> 195<script type="text/javascript"><!-- 196 allClassesLink = document.getElementById("allclasses_navbar_bottom"); 197 if(window==top) { 198 allClassesLink.style.display = "block"; 199 } 200 else { 201 allClassesLink.style.display = "none"; 202 } 203 //--> 204</script> 205</div> 206<div> 207<ul class="subNavList"> 208<li>Summary: </li> 209<li>Required | </li> 210<li><a href="#annotation_type_optional_element_summary">Optional</a></li> 211</ul> 212<ul class="subNavList"> 213<li>Detail: </li> 214<li><a href="#annotation_type_element_detail">Element</a></li> 215</ul> 216</div> 217<a name="skip-navbar_bottom"> 218<!-- --> 219</a></div> 220<!-- ======== END OF BOTTOM NAVBAR ======= --> 221<p class="legalCopy"><small>Copyright © 2014-2015 <a href="http://fasterxml.com/">FasterXML</a>. All Rights Reserved.</small></p> 222</body> 223</html> 224