1<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> 2<!--NewPage--> 3<HTML> 4<HEAD> 5<!-- Generated by javadoc (build 1.6.0_35) on Fri Oct 05 20:53:29 PDT 2012 --> 6<META http-equiv="Content-Type" content="text/html; charset=UTF-8"> 7<TITLE> 8JsonSetter (Jackson-annotations 2.1.0 API) 9</TITLE> 10 11<META NAME="date" CONTENT="2012-10-05"> 12 13<LINK REL ="stylesheet" TYPE="text/css" HREF="../../../../stylesheet.css" TITLE="Style"> 14 15<SCRIPT type="text/javascript"> 16function windowTitle() 17{ 18 if (location.href.indexOf('is-external=true') == -1) { 19 parent.document.title="JsonSetter (Jackson-annotations 2.1.0 API)"; 20 } 21} 22</SCRIPT> 23<NOSCRIPT> 24</NOSCRIPT> 25 26</HEAD> 27 28<BODY BGCOLOR="white" onload="windowTitle();"> 29<HR> 30 31 32<!-- ========= START OF TOP NAVBAR ======= --> 33<A NAME="navbar_top"><!-- --></A> 34<A HREF="#skip-navbar_top" title="Skip navigation links"></A> 35<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY=""> 36<TR> 37<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> 38<A NAME="navbar_top_firstrow"><!-- --></A> 39<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY=""> 40 <TR ALIGN="center" VALIGN="top"> 41 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../com/fasterxml/jackson/annotation/package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD> 42 <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD> 43 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="class-use/JsonSetter.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A> </TD> 44 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD> 45 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD> 46 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD> 47 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD> 48 </TR> 49</TABLE> 50</TD> 51<TD ALIGN="right" VALIGN="top" ROWSPAN=3><script type="text/javascript"><!-- 52google_ad_client = "pub-1467773697956887"; 53/* Jackson-ad-small */ 54google_ad_slot = "6699487946"; 55google_ad_width = 234; 56google_ad_height = 60; 57//--> 58</script> 59<script type="text/javascript" 60src="http://pagead2.googlesyndication.com/pagead/show_ads.js"> 61</script> 62</TD> 63</TR> 64 65<TR> 66<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> 67 <A HREF="../../../../com/fasterxml/jackson/annotation/JsonRootName.html" title="annotation in com.fasterxml.jackson.annotation"><B>PREV CLASS</B></A> 68 <A HREF="../../../../com/fasterxml/jackson/annotation/JsonSubTypes.html" title="annotation in com.fasterxml.jackson.annotation"><B>NEXT CLASS</B></A></FONT></TD> 69<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> 70 <A HREF="../../../../index.html?com/fasterxml/jackson/annotation/JsonSetter.html" target="_top"><B>FRAMES</B></A> 71 <A HREF="JsonSetter.html" target="_top"><B>NO FRAMES</B></A> 72 <SCRIPT type="text/javascript"> 73 <!-- 74 if(window==top) { 75 document.writeln('<A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>'); 76 } 77 //--> 78</SCRIPT> 79<NOSCRIPT> 80 <A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A> 81</NOSCRIPT> 82 83 84</FONT></TD> 85</TR> 86<TR> 87<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> 88 SUMMARY: REQUIRED | <A HREF="#annotation_type_optional_element_summary">OPTIONAL</A></FONT></TD> 89<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> 90DETAIL: <A HREF="#annotation_type_element_detail">ELEMENT</A></FONT></TD> 91</TR> 92</TABLE> 93<A NAME="skip-navbar_top"></A> 94<!-- ========= END OF TOP NAVBAR ========= --> 95 96<HR> 97<!-- ======== START OF CLASS DATA ======== --> 98<H2> 99<FONT SIZE="-1"> 100com.fasterxml.jackson.annotation</FONT> 101<BR> 102Annotation Type JsonSetter</H2> 103<HR> 104<DL> 105<DT><PRE><FONT SIZE="-1"><A HREF="http://download.oracle.com/javase/1.5.0/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/1.5.0/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/1.5.0/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/1.5.0/docs/api/java/lang/annotation/ElementType.html?is-external=true#METHOD" title="class or interface in java.lang.annotation">METHOD</A>}) 106<A HREF="http://download.oracle.com/javase/1.5.0/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/1.5.0/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/1.5.0/docs/api/java/lang/annotation/RetentionPolicy.html?is-external=true#RUNTIME" title="class or interface in java.lang.annotation">RUNTIME</A>) 107</FONT>public @interface <B>JsonSetter</B></DL> 108</PRE> 109 110<P> 111Marker annotation that can be used to define a non-static, 112 single-argument method to be used as a "setter" for a logical property 113 as an alternative to recommended 114 <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). 115<p> 116 Setter means that when a property with matching name is encountered in 117 JSON content, this method will be used to set value of the property. 118<p> 119 NOTE: this annotation was briefly deprecated for version 1.5; but has 120 since been un-deprecated to both allow for asymmetric naming (possibly 121 different name when reading and writing JSON), and more importantly to 122 allow multi-argument setter method in future. 123<P> 124 125<P> 126<HR> 127 128<P> 129<!-- =========== ANNOTATION TYPE OPTIONAL MEMBER SUMMARY =========== --> 130 131<A NAME="annotation_type_optional_element_summary"><!-- --></A> 132<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> 133<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> 134<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2"> 135<B>Optional Element Summary</B></FONT></TH> 136</TR> 137<TR BGCOLOR="white" CLASS="TableRowColor"> 138<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> 139<CODE> <A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A></CODE></FONT></TD> 140<TD><CODE><B><A HREF="../../../../com/fasterxml/jackson/annotation/JsonSetter.html#value()">value</A></B></CODE> 141 142<BR> 143 Optional default argument that defines logical property this 144 method is used to modify ("set"); this is the property 145 name used in JSON content.</TD> 146</TR> 147</TABLE> 148 149<P> 150<A NAME="value()"><!-- --></A><H3> 151value</H3> 152<PRE> 153public abstract <A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> <B>value</B></PRE> 154<DL> 155<DD>Optional default argument that defines logical property this 156 method is used to modify ("set"); this is the property 157 name used in JSON content. 158<P> 159<DD><DL> 160</DL> 161</DD> 162<DD><DL> 163</DL> 164<DL> 165<DT><B>Default:</B><DD>""</DD> 166</DL> 167</DL> 168<!-- ========= END OF CLASS DATA ========= --> 169<HR> 170 171 172<!-- ======= START OF BOTTOM NAVBAR ====== --> 173<A NAME="navbar_bottom"><!-- --></A> 174<A HREF="#skip-navbar_bottom" title="Skip navigation links"></A> 175<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY=""> 176<TR><td rowspan='3'><script type="text/javascript"><!-- 177google_ad_client = "pub-1467773697956887"; 178/* Jackson-ad-small */ 179google_ad_slot = "6699487946"; 180google_ad_width = 234; 181google_ad_height = 60; 182//--> 183</script> 184<script type="text/javascript" 185src="http://pagead2.googlesyndication.com/pagead/show_ads.js"> 186</script> 187<!-- GA --> 188<script type="text/javascript"> 189var gaJsHost = (("https:" == document.location.protocol) ? "https://ssl." : "http://www."); 190document.write(unescape("%3Cscript src='" + gaJsHost + "google-analytics.com/ga.js' type='text/javascript'%3E%3C/script%3E")); 191</script> 192<script type="text/javascript"> 193try { 194var pageTracker = _gat._getTracker("UA-140287-6"); 195pageTracker._trackPageview(); 196} catch(err) {} 197</script> 198</td> 199<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> 200<A NAME="navbar_bottom_firstrow"><!-- --></A> 201<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY=""> 202 <TR ALIGN="center" VALIGN="top"> 203 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../com/fasterxml/jackson/annotation/package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD> 204 <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD> 205 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="class-use/JsonSetter.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A> </TD> 206 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD> 207 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD> 208 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD> 209 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD> 210 </TR> 211</TABLE> 212</TD> 213<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM> 214</EM> 215</TD> 216</TR> 217 218<TR> 219<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> 220 <A HREF="../../../../com/fasterxml/jackson/annotation/JsonRootName.html" title="annotation in com.fasterxml.jackson.annotation"><B>PREV CLASS</B></A> 221 <A HREF="../../../../com/fasterxml/jackson/annotation/JsonSubTypes.html" title="annotation in com.fasterxml.jackson.annotation"><B>NEXT CLASS</B></A></FONT></TD> 222<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> 223 <A HREF="../../../../index.html?com/fasterxml/jackson/annotation/JsonSetter.html" target="_top"><B>FRAMES</B></A> 224 <A HREF="JsonSetter.html" target="_top"><B>NO FRAMES</B></A> 225 <SCRIPT type="text/javascript"> 226 <!-- 227 if(window==top) { 228 document.writeln('<A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>'); 229 } 230 //--> 231</SCRIPT> 232<NOSCRIPT> 233 <A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A> 234</NOSCRIPT> 235 236 237</FONT></TD> 238</TR> 239<TR> 240<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> 241 SUMMARY: REQUIRED | <A HREF="#annotation_type_optional_element_summary">OPTIONAL</A></FONT></TD> 242<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> 243DETAIL: <A HREF="#annotation_type_element_detail">ELEMENT</A></FONT></TD> 244</TR> 245</TABLE> 246<A NAME="skip-navbar_bottom"></A> 247<!-- ======== END OF BOTTOM NAVBAR ======= --> 248 249<HR> 250Copyright © 2012 <a href="http://fasterxml.com/">FasterXML</a>. All Rights Reserved. 251</BODY> 252</HTML> 253