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) on Sun Jul 19 11:36:50 PDT 2015 --> 6<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> 7<title>JsonPOJOBuilder (jackson-databind 2.6.0 API)</title> 8<meta name="date" content="2015-07-19"> 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="JsonPOJOBuilder (jackson-databind 2.6.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="../../../../../overview-summary.html">Overview</a></li> 36<li><a href="package-summary.html">Package</a></li> 37<li class="navBarCell1Rev">Class</li> 38<li><a href="class-use/JsonPOJOBuilder.html">Use</a></li> 39<li><a href="package-tree.html">Tree</a></li> 40<li><a href="../../../../../deprecated-list.html">Deprecated</a></li> 41<li><a href="../../../../../index-all.html">Index</a></li> 42<li><a href="../../../../../help-doc.html">Help</a></li> 43</ul> 44</div> 45<div class="subNav"> 46<ul class="navList"> 47<li><a href="../../../../../com/fasterxml/jackson/databind/annotation/JsonNaming.html" title="annotation in com.fasterxml.jackson.databind.annotation"><span class="typeNameLink">Prev Class</span></a></li> 48<li><a href="../../../../../com/fasterxml/jackson/databind/annotation/JsonPOJOBuilder.Value.html" title="class in com.fasterxml.jackson.databind.annotation"><span class="typeNameLink">Next Class</span></a></li> 49</ul> 50<ul class="navList"> 51<li><a href="../../../../../index.html?com/fasterxml/jackson/databind/annotation/JsonPOJOBuilder.html" target="_top">Frames</a></li> 52<li><a href="JsonPOJOBuilder.html" target="_top">No Frames</a></li> 53</ul> 54<ul class="navList" id="allclasses_navbar_top"> 55<li><a href="../../../../../allclasses-noframe.html">All Classes</a></li> 56</ul> 57<div> 58<script type="text/javascript"><!-- 59 allClassesLink = document.getElementById("allclasses_navbar_top"); 60 if(window==top) { 61 allClassesLink.style.display = "block"; 62 } 63 else { 64 allClassesLink.style.display = "none"; 65 } 66 //--> 67</script> 68</div> 69<div> 70<ul class="subNavList"> 71<li>Summary: </li> 72<li>Field | </li> 73<li>Required | </li> 74<li><a href="#annotation.type.optional.element.summary">Optional</a></li> 75</ul> 76<ul class="subNavList"> 77<li>Detail: </li> 78<li>Field | </li> 79<li><a href="#annotation.type.element.detail">Element</a></li> 80</ul> 81</div> 82<a name="skip.navbar.top"> 83<!-- --> 84</a></div> 85<!-- ========= END OF TOP NAVBAR ========= --> 86<!-- ======== START OF CLASS DATA ======== --> 87<div class="header"> 88<div class="subTitle">com.fasterxml.jackson.databind.annotation</div> 89<h2 title="Annotation Type JsonPOJOBuilder" class="title">Annotation Type JsonPOJOBuilder</h2> 90</div> 91<div class="contentContainer"> 92<div class="description"> 93<ul class="blockList"> 94<li class="blockList"> 95<hr> 96<br> 97<pre><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>) 99public @interface <span class="memberNameLabel">JsonPOJOBuilder</span></pre> 100<div class="block">Annotation used to configure details of a Builder class: 101 instances of which are used as Builders for deserialized 102 POJO values, instead of POJOs being instantiated using 103 constructors or factory methods. 104 Note that this annotation is NOT used to define what is 105 the Builder class for a POJO: rather, this is determined 106 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>. 107<p> 108 Annotation is typically used if the naming convention 109 of a Builder class is different from defaults: 110<ul> 111 </ul></div> 112<dl> 113<dt><span class="simpleTagLabel">Since:</span></dt> 114<dd>2.0</dd> 115</dl> 116</li> 117</ul> 118</div> 119<div class="summary"> 120<ul class="blockList"> 121<li class="blockList"> 122<!-- =========== ANNOTATION TYPE OPTIONAL MEMBER SUMMARY =========== --> 123<ul class="blockList"> 124<li class="blockList"><a name="annotation.type.optional.element.summary"> 125<!-- --> 126</a> 127<h3>Optional Element Summary</h3> 128<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Optional Element Summary table, listing optional elements, and an explanation"> 129<caption><span>Optional Elements</span><span class="tabEnd"> </span></caption> 130<tr> 131<th class="colFirst" scope="col">Modifier and Type</th> 132<th class="colLast" scope="col">Optional Element and Description</th> 133</tr> 134<tr class="altColor"> 135<td class="colFirst"><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></td> 136<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../com/fasterxml/jackson/databind/annotation/JsonPOJOBuilder.html#buildMethodName--">buildMethodName</a></span></code> 137<div class="block">Property to use for re-defining which zero-argument method 138 is considered the actual "build-method": method called after 139 all data has been bound, and the actual instance needs to 140 be instantiated.</div> 141</td> 142</tr> 143<tr class="rowColor"> 144<td class="colFirst"><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></td> 145<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../com/fasterxml/jackson/databind/annotation/JsonPOJOBuilder.html#withPrefix--">withPrefix</a></span></code> 146<div class="block">Property used for (re)defining name prefix to use for 147 auto-detecting "with-methods": methods that are similar to 148 "set-methods" (in that they take an argument), but that 149 may also return the new builder instance to use 150 (which may be 'this', or a new modified builder instance).</div> 151</td> 152</tr> 153</table> 154</li> 155</ul> 156</li> 157</ul> 158</div> 159<div class="details"> 160<ul class="blockList"> 161<li class="blockList"> 162<!-- ============ ANNOTATION TYPE MEMBER DETAIL =========== --> 163<ul class="blockList"> 164<li class="blockList"><a name="annotation.type.element.detail"> 165<!-- --> 166</a> 167<h3>Element Detail</h3> 168<a name="buildMethodName--"> 169<!-- --> 170</a> 171<ul class="blockList"> 172<li class="blockList"> 173<h4>buildMethodName</h4> 174<pre>public 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> buildMethodName</pre> 175<div class="block">Property to use for re-defining which zero-argument method 176 is considered the actual "build-method": method called after 177 all data has been bound, and the actual instance needs to 178 be instantiated. 179<p> 180 Default value is "build".</div> 181<dl> 182<dt>Default:</dt> 183<dd>"build"</dd> 184</dl> 185</li> 186</ul> 187</li> 188</ul> 189<ul class="blockList"> 190<li class="blockList"><a name="withPrefix--"> 191<!-- --> 192</a> 193<ul class="blockListLast"> 194<li class="blockList"> 195<h4>withPrefix</h4> 196<pre>public 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> withPrefix</pre> 197<div class="block">Property used for (re)defining name prefix to use for 198 auto-detecting "with-methods": methods that are similar to 199 "set-methods" (in that they take an argument), but that 200 may also return the new builder instance to use 201 (which may be 'this', or a new modified builder instance). 202 Note that in addition to this prefix, it is also possible 203 to use <code>JsonProperty</code> 204 annotation to indicate "with-methods" (as well as 205 <code>JsonSetter</code>). 206<p> 207 Default value is "with", so that method named "withValue()" 208 would be used for binding JSON property "value" (using type 209 indicated by the argument; or one defined with annotations.</div> 210<dl> 211<dt>Default:</dt> 212<dd>"with"</dd> 213</dl> 214</li> 215</ul> 216</li> 217</ul> 218</li> 219</ul> 220</div> 221</div> 222<!-- ========= END OF CLASS DATA ========= --> 223<!-- ======= START OF BOTTOM NAVBAR ====== --> 224<div class="bottomNav"><a name="navbar.bottom"> 225<!-- --> 226</a> 227<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div> 228<a name="navbar.bottom.firstrow"> 229<!-- --> 230</a> 231<ul class="navList" title="Navigation"> 232<li><a href="../../../../../overview-summary.html">Overview</a></li> 233<li><a href="package-summary.html">Package</a></li> 234<li class="navBarCell1Rev">Class</li> 235<li><a href="class-use/JsonPOJOBuilder.html">Use</a></li> 236<li><a href="package-tree.html">Tree</a></li> 237<li><a href="../../../../../deprecated-list.html">Deprecated</a></li> 238<li><a href="../../../../../index-all.html">Index</a></li> 239<li><a href="../../../../../help-doc.html">Help</a></li> 240</ul> 241</div> 242<div class="subNav"> 243<ul class="navList"> 244<li><a href="../../../../../com/fasterxml/jackson/databind/annotation/JsonNaming.html" title="annotation in com.fasterxml.jackson.databind.annotation"><span class="typeNameLink">Prev Class</span></a></li> 245<li><a href="../../../../../com/fasterxml/jackson/databind/annotation/JsonPOJOBuilder.Value.html" title="class in com.fasterxml.jackson.databind.annotation"><span class="typeNameLink">Next Class</span></a></li> 246</ul> 247<ul class="navList"> 248<li><a href="../../../../../index.html?com/fasterxml/jackson/databind/annotation/JsonPOJOBuilder.html" target="_top">Frames</a></li> 249<li><a href="JsonPOJOBuilder.html" target="_top">No Frames</a></li> 250</ul> 251<ul class="navList" id="allclasses_navbar_bottom"> 252<li><a href="../../../../../allclasses-noframe.html">All Classes</a></li> 253</ul> 254<div> 255<script type="text/javascript"><!-- 256 allClassesLink = document.getElementById("allclasses_navbar_bottom"); 257 if(window==top) { 258 allClassesLink.style.display = "block"; 259 } 260 else { 261 allClassesLink.style.display = "none"; 262 } 263 //--> 264</script> 265</div> 266<div> 267<ul class="subNavList"> 268<li>Summary: </li> 269<li>Field | </li> 270<li>Required | </li> 271<li><a href="#annotation.type.optional.element.summary">Optional</a></li> 272</ul> 273<ul class="subNavList"> 274<li>Detail: </li> 275<li>Field | </li> 276<li><a href="#annotation.type.element.detail">Element</a></li> 277</ul> 278</div> 279<a name="skip.navbar.bottom"> 280<!-- --> 281</a></div> 282<!-- ======== END OF BOTTOM NAVBAR ======= --> 283<p class="legalCopy"><small>Copyright © 2014–2015 <a href="http://fasterxml.com/">FasterXML</a>. All rights reserved.</small></p> 284</body> 285</html> 286