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 19:07:11 PDT 2012 --> 6<META http-equiv="Content-Type" content="text/html; charset=UTF-8"> 7<TITLE> 8JsonPOJOBuilder (jackson-databind 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="JsonPOJOBuilder (jackson-databind 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="../../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD> 42 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD> 43 <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD> 44 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="class-use/JsonPOJOBuilder.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A> </TD> 45 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD> 46 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD> 47 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD> 48 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD> 49 </TR> 50</TABLE> 51</TD> 52<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM> 53</EM> 54</TD> 55</TR> 56 57<TR> 58<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> 59 <A HREF="../../../../../com/fasterxml/jackson/databind/annotation/JsonDeserialize.html" title="annotation in com.fasterxml.jackson.databind.annotation"><B>PREV CLASS</B></A> 60 <A HREF="../../../../../com/fasterxml/jackson/databind/annotation/JsonPOJOBuilder.Value.html" title="class in com.fasterxml.jackson.databind.annotation"><B>NEXT CLASS</B></A></FONT></TD> 61<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> 62 <A HREF="../../../../../index.html?com/fasterxml/jackson/databind/annotation/JsonPOJOBuilder.html" target="_top"><B>FRAMES</B></A> 63 <A HREF="JsonPOJOBuilder.html" target="_top"><B>NO FRAMES</B></A> 64 <SCRIPT type="text/javascript"> 65 <!-- 66 if(window==top) { 67 document.writeln('<A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>'); 68 } 69 //--> 70</SCRIPT> 71<NOSCRIPT> 72 <A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A> 73</NOSCRIPT> 74 75 76</FONT></TD> 77</TR> 78<TR> 79<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> 80 SUMMARY: REQUIRED | <A HREF="#annotation_type_optional_element_summary">OPTIONAL</A></FONT></TD> 81<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> 82DETAIL: <A HREF="#annotation_type_element_detail">ELEMENT</A></FONT></TD> 83</TR> 84</TABLE> 85<A NAME="skip-navbar_top"></A> 86<!-- ========= END OF TOP NAVBAR ========= --> 87 88<HR> 89<!-- ======== START OF CLASS DATA ======== --> 90<H2> 91<FONT SIZE="-1"> 92com.fasterxml.jackson.databind.annotation</FONT> 93<BR> 94Annotation Type JsonPOJOBuilder</H2> 95<HR> 96<DL> 97<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#TYPE" title="class or interface in java.lang.annotation">TYPE</A>}) 98<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>) 99</FONT>public @interface <B>JsonPOJOBuilder</B></DL> 100</PRE> 101 102<P> 103Annotation used to configure details of a Builder class: 104 instances of which are used as Builders for deserialized 105 POJO values, instead of POJOs being instantiated using 106 constructors or factory methods. 107 Note that this annotation is NOT used to define what is 108 the Builder class for a POJO: rather, this is determined 109 by <A HREF="../../../../../com/fasterxml/jackson/databind/annotation/JsonDeserialize.html#builder()"><CODE>JsonDeserialize.builder()</CODE></A> property of <A HREF="../../../../../com/fasterxml/jackson/databind/annotation/JsonDeserialize.html" title="annotation in com.fasterxml.jackson.databind.annotation"><CODE>JsonDeserialize</CODE></A>. 110<p> 111 Annotation is typically used if the naming convention 112 of a Builder class is different from defaults: 113<ul> 114 </ul> 115<P> 116 117<P> 118<DL> 119<DT><B>Since:</B></DT> 120 <DD>2.0</DD> 121</DL> 122<HR> 123 124<P> 125<!-- =========== ANNOTATION TYPE OPTIONAL MEMBER SUMMARY =========== --> 126 127<A NAME="annotation_type_optional_element_summary"><!-- --></A> 128<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> 129<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> 130<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2"> 131<B>Optional Element Summary</B></FONT></TH> 132</TR> 133<TR BGCOLOR="white" CLASS="TableRowColor"> 134<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> 135<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> 136<TD><CODE><B><A HREF="../../../../../com/fasterxml/jackson/databind/annotation/JsonPOJOBuilder.html#buildMethodName()">buildMethodName</A></B></CODE> 137 138<BR> 139 Property to use for re-defining which zero-argument method 140 is considered the actual "build-method": method called after 141 all data has been bound, and the actual instance needs to 142 be instantiated.</TD> 143</TR> 144<TR BGCOLOR="white" CLASS="TableRowColor"> 145<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> 146<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> 147<TD><CODE><B><A HREF="../../../../../com/fasterxml/jackson/databind/annotation/JsonPOJOBuilder.html#withPrefix()">withPrefix</A></B></CODE> 148 149<BR> 150 Property used for (re)defining name prefix to use for 151 auto-detecting "with-methods": methods that are similar to 152 "set-methods" (in that they take an argument), but that 153 may also return the new builder instance to use 154 (which may be 'this', or a new modified builder instance).</TD> 155</TR> 156</TABLE> 157 158<P> 159<A NAME="buildMethodName()"><!-- --></A><H3> 160buildMethodName</H3> 161<PRE> 162public 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>buildMethodName</B></PRE> 163<DL> 164<DD>Property to use for re-defining which zero-argument method 165 is considered the actual "build-method": method called after 166 all data has been bound, and the actual instance needs to 167 be instantiated. 168<p> 169 Default value is "build". 170<P> 171<DD><DL> 172</DL> 173</DD> 174<DD><DL> 175</DL> 176<DL> 177<DT><B>Default:</B><DD>"build"</DD> 178</DL> 179</DL> 180<HR> 181 182<A NAME="withPrefix()"><!-- --></A><H3> 183withPrefix</H3> 184<PRE> 185public 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>withPrefix</B></PRE> 186<DL> 187<DD>Property used for (re)defining name prefix to use for 188 auto-detecting "with-methods": methods that are similar to 189 "set-methods" (in that they take an argument), but that 190 may also return the new builder instance to use 191 (which may be 'this', or a new modified builder instance). 192 Note that in addition to this prefix, it is also possible 193 to use <CODE>JsonProperty</CODE> 194 annotation to indicate "with-methods" (as well as 195 <CODE>JsonSetter</CODE>). 196<p> 197 Default value is "with", so that method named "withValue()" 198 would be used for binding JSON property "value" (using type 199 indicated by the argument; or one defined with annotations. 200<P> 201<DD><DL> 202</DL> 203</DD> 204<DD><DL> 205</DL> 206<DL> 207<DT><B>Default:</B><DD>"with"</DD> 208</DL> 209</DL> 210<!-- ========= END OF CLASS DATA ========= --> 211<HR> 212 213 214<!-- ======= START OF BOTTOM NAVBAR ====== --> 215<A NAME="navbar_bottom"><!-- --></A> 216<A HREF="#skip-navbar_bottom" title="Skip navigation links"></A> 217<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY=""> 218<TR> 219<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> 220<A NAME="navbar_bottom_firstrow"><!-- --></A> 221<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY=""> 222 <TR ALIGN="center" VALIGN="top"> 223 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD> 224 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD> 225 <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD> 226 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="class-use/JsonPOJOBuilder.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A> </TD> 227 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD> 228 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD> 229 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD> 230 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD> 231 </TR> 232</TABLE> 233</TD> 234<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM> 235</EM> 236</TD> 237</TR> 238 239<TR> 240<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> 241 <A HREF="../../../../../com/fasterxml/jackson/databind/annotation/JsonDeserialize.html" title="annotation in com.fasterxml.jackson.databind.annotation"><B>PREV CLASS</B></A> 242 <A HREF="../../../../../com/fasterxml/jackson/databind/annotation/JsonPOJOBuilder.Value.html" title="class in com.fasterxml.jackson.databind.annotation"><B>NEXT CLASS</B></A></FONT></TD> 243<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> 244 <A HREF="../../../../../index.html?com/fasterxml/jackson/databind/annotation/JsonPOJOBuilder.html" target="_top"><B>FRAMES</B></A> 245 <A HREF="JsonPOJOBuilder.html" target="_top"><B>NO FRAMES</B></A> 246 <SCRIPT type="text/javascript"> 247 <!-- 248 if(window==top) { 249 document.writeln('<A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>'); 250 } 251 //--> 252</SCRIPT> 253<NOSCRIPT> 254 <A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A> 255</NOSCRIPT> 256 257 258</FONT></TD> 259</TR> 260<TR> 261<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> 262 SUMMARY: REQUIRED | <A HREF="#annotation_type_optional_element_summary">OPTIONAL</A></FONT></TD> 263<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> 264DETAIL: <A HREF="#annotation_type_element_detail">ELEMENT</A></FONT></TD> 265</TR> 266</TABLE> 267<A NAME="skip-navbar_bottom"></A> 268<!-- ======== END OF BOTTOM NAVBAR ======= --> 269 270<HR> 271Copyright © 2012 <a href="http://fasterxml.com">fasterxml.com</a>. All Rights Reserved. 272</BODY> 273</HTML> 274