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_29) on Mon Mar 26 18:49:10 PDT 2012 --> 6<META http-equiv="Content-Type" content="text/html; charset=UTF-8"> 7<TITLE> 8JsonSetter (Jackson-annotations 2.0.0 API) 9</TITLE> 10 11<META NAME="date" CONTENT="2012-03-26"> 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.0.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><EM> 52</EM> 53</TD> 54</TR> 55 56<TR> 57<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> 58 <A HREF="../../../../com/fasterxml/jackson/annotation/JsonRootName.html" title="annotation in com.fasterxml.jackson.annotation"><B>PREV CLASS</B></A> 59 <A HREF="../../../../com/fasterxml/jackson/annotation/JsonSubTypes.html" title="annotation in com.fasterxml.jackson.annotation"><B>NEXT CLASS</B></A></FONT></TD> 60<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> 61 <A HREF="../../../../index.html?com/fasterxml/jackson/annotation/JsonSetter.html" target="_top"><B>FRAMES</B></A> 62 <A HREF="JsonSetter.html" target="_top"><B>NO FRAMES</B></A> 63 <SCRIPT type="text/javascript"> 64 <!-- 65 if(window==top) { 66 document.writeln('<A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>'); 67 } 68 //--> 69</SCRIPT> 70<NOSCRIPT> 71 <A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A> 72</NOSCRIPT> 73 74 75</FONT></TD> 76</TR> 77<TR> 78<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> 79 SUMMARY: REQUIRED | <A HREF="#annotation_type_optional_element_summary">OPTIONAL</A></FONT></TD> 80<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> 81DETAIL: <A HREF="#annotation_type_element_detail">ELEMENT</A></FONT></TD> 82</TR> 83</TABLE> 84<A NAME="skip-navbar_top"></A> 85<!-- ========= END OF TOP NAVBAR ========= --> 86 87<HR> 88<!-- ======== START OF CLASS DATA ======== --> 89<H2> 90<FONT SIZE="-1"> 91com.fasterxml.jackson.annotation</FONT> 92<BR> 93Annotation Type JsonSetter</H2> 94<HR> 95<DL> 96<DT><PRE><FONT SIZE="-1"><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>}) 97<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>) 98</FONT>public @interface <B>JsonSetter</B></DL> 99</PRE> 100 101<P> 102Marker annotation that can be used to define a non-static, 103 single-argument method to be used as a "setter" for a logical property 104 as an alternative to recommended 105 <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). 106<p> 107 Setter means that when a property with matching name is encountered in 108 JSON content, this method will be used to set value of the property. 109<p> 110 NOTE: this annotation was briefly deprecated for version 1.5; but has 111 since been un-deprecated to both allow for asymmetric naming (possibly 112 different name when reading and writing JSON), and more importantly to 113 allow multi-argument setter method in future. 114<P> 115 116<P> 117<HR> 118 119<P> 120<!-- =========== ANNOTATION TYPE OPTIONAL MEMBER SUMMARY =========== --> 121 122<A NAME="annotation_type_optional_element_summary"><!-- --></A> 123<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> 124<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> 125<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2"> 126<B>Optional Element Summary</B></FONT></TH> 127</TR> 128<TR BGCOLOR="white" CLASS="TableRowColor"> 129<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> 130<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></FONT></TD> 131<TD><CODE><B><A HREF="../../../../com/fasterxml/jackson/annotation/JsonSetter.html#value()">value</A></B></CODE> 132 133<BR> 134 Optional default argument that defines logical property this 135 method is used to modify ("set"); this is the property 136 name used in JSON content.</TD> 137</TR> 138</TABLE> 139 140<P> 141<A NAME="value()"><!-- --></A><H3> 142value</H3> 143<PRE> 144public abstract <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> <B>value</B></PRE> 145<DL> 146<DD>Optional default argument that defines logical property this 147 method is used to modify ("set"); this is the property 148 name used in JSON content. 149<P> 150<DD><DL> 151</DL> 152</DD> 153<DD><DL> 154</DL> 155<DL> 156<DT><B>Default:</B><DD>""</DD> 157</DL> 158</DL> 159<!-- ========= END OF CLASS DATA ========= --> 160<HR> 161 162 163<!-- ======= START OF BOTTOM NAVBAR ====== --> 164<A NAME="navbar_bottom"><!-- --></A> 165<A HREF="#skip-navbar_bottom" title="Skip navigation links"></A> 166<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY=""> 167<TR> 168<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> 169<A NAME="navbar_bottom_firstrow"><!-- --></A> 170<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY=""> 171 <TR ALIGN="center" VALIGN="top"> 172 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../com/fasterxml/jackson/annotation/package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD> 173 <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD> 174 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="class-use/JsonSetter.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A> </TD> 175 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD> 176 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD> 177 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD> 178 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD> 179 </TR> 180</TABLE> 181</TD> 182<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM> 183</EM> 184</TD> 185</TR> 186 187<TR> 188<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> 189 <A HREF="../../../../com/fasterxml/jackson/annotation/JsonRootName.html" title="annotation in com.fasterxml.jackson.annotation"><B>PREV CLASS</B></A> 190 <A HREF="../../../../com/fasterxml/jackson/annotation/JsonSubTypes.html" title="annotation in com.fasterxml.jackson.annotation"><B>NEXT CLASS</B></A></FONT></TD> 191<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> 192 <A HREF="../../../../index.html?com/fasterxml/jackson/annotation/JsonSetter.html" target="_top"><B>FRAMES</B></A> 193 <A HREF="JsonSetter.html" target="_top"><B>NO FRAMES</B></A> 194 <SCRIPT type="text/javascript"> 195 <!-- 196 if(window==top) { 197 document.writeln('<A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>'); 198 } 199 //--> 200</SCRIPT> 201<NOSCRIPT> 202 <A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A> 203</NOSCRIPT> 204 205 206</FONT></TD> 207</TR> 208<TR> 209<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> 210 SUMMARY: REQUIRED | <A HREF="#annotation_type_optional_element_summary">OPTIONAL</A></FONT></TD> 211<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> 212DETAIL: <A HREF="#annotation_type_element_detail">ELEMENT</A></FONT></TD> 213</TR> 214</TABLE> 215<A NAME="skip-navbar_bottom"></A> 216<!-- ======== END OF BOTTOM NAVBAR ======= --> 217 218<HR> 219Copyright © 2012 <a href="http://fasterxml.com">fasterxml.com</a>. All Rights Reserved. 220</BODY> 221</HTML> 222