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_79) on Sat Jan 09 21:46:10 PST 2016 --> 6<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> 7<title>JsonCreator.Mode (Jackson-annotations 2.7.0 API)</title> 8<meta name="date" content="2016-01-09"> 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="JsonCreator.Mode (Jackson-annotations 2.7.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/JsonCreator.Mode.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/JsonCreator.html" title="annotation in com.fasterxml.jackson.annotation"><span class="strong">Prev Class</span></a></li> 40<li><a href="../../../../com/fasterxml/jackson/annotation/JsonFilter.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/JsonCreator.Mode.html" target="_top">Frames</a></li> 44<li><a href="JsonCreator.Mode.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>Nested | </li> 65<li><a href="#enum_constant_summary">Enum Constants</a> | </li> 66<li>Field | </li> 67<li><a href="#method_summary">Method</a></li> 68</ul> 69<ul class="subNavList"> 70<li>Detail: </li> 71<li><a href="#enum_constant_detail">Enum Constants</a> | </li> 72<li>Field | </li> 73<li><a href="#method_detail">Method</a></li> 74</ul> 75</div> 76<a name="skip-navbar_top"> 77<!-- --> 78</a></div> 79<!-- ========= END OF TOP NAVBAR ========= --> 80<!-- ======== START OF CLASS DATA ======== --> 81<div class="header"> 82<div class="subTitle">com.fasterxml.jackson.annotation</div> 83<h2 title="Enum JsonCreator.Mode" class="title">Enum JsonCreator.Mode</h2> 84</div> 85<div class="contentContainer"> 86<ul class="inheritance"> 87<li><a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">java.lang.Object</a></li> 88<li> 89<ul class="inheritance"> 90<li><a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Enum.html?is-external=true" title="class or interface in java.lang">java.lang.Enum</a><<a href="../../../../com/fasterxml/jackson/annotation/JsonCreator.Mode.html" title="enum in com.fasterxml.jackson.annotation">JsonCreator.Mode</a>></li> 91<li> 92<ul class="inheritance"> 93<li>com.fasterxml.jackson.annotation.JsonCreator.Mode</li> 94</ul> 95</li> 96</ul> 97</li> 98</ul> 99<div class="description"> 100<ul class="blockList"> 101<li class="blockList"> 102<dl> 103<dt>All Implemented Interfaces:</dt> 104<dd><a href="http://docs.oracle.com/javase/6/docs/api/java/io/Serializable.html?is-external=true" title="class or interface in java.io">Serializable</a>, <a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Comparable.html?is-external=true" title="class or interface in java.lang">Comparable</a><<a href="../../../../com/fasterxml/jackson/annotation/JsonCreator.Mode.html" title="enum in com.fasterxml.jackson.annotation">JsonCreator.Mode</a>></dd> 105</dl> 106<dl> 107<dt>Enclosing class:</dt> 108<dd><a href="../../../../com/fasterxml/jackson/annotation/JsonCreator.html" title="annotation in com.fasterxml.jackson.annotation">JsonCreator</a></dd> 109</dl> 110<hr> 111<br> 112<pre>public static enum <span class="strong">JsonCreator.Mode</span> 113extends <a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Enum.html?is-external=true" title="class or interface in java.lang">Enum</a><<a href="../../../../com/fasterxml/jackson/annotation/JsonCreator.Mode.html" title="enum in com.fasterxml.jackson.annotation">JsonCreator.Mode</a>></pre> 114<dl><dt><span class="strong">Since:</span></dt> 115 <dd>2.5</dd></dl> 116</li> 117</ul> 118</div> 119<div class="summary"> 120<ul class="blockList"> 121<li class="blockList"> 122<!-- =========== ENUM CONSTANT SUMMARY =========== --> 123<ul class="blockList"> 124<li class="blockList"><a name="enum_constant_summary"> 125<!-- --> 126</a> 127<h3>Enum Constant Summary</h3> 128<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Enum Constant Summary table, listing enum constants, and an explanation"> 129<caption><span>Enum Constants</span><span class="tabEnd"> </span></caption> 130<tr> 131<th class="colOne" scope="col">Enum Constant and Description</th> 132</tr> 133<tr class="altColor"> 134<td class="colOne"><code><strong><a href="../../../../com/fasterxml/jackson/annotation/JsonCreator.Mode.html#DEFAULT">DEFAULT</a></strong></code> 135<div class="block">Pseudo-mode that indicates that caller is to use default heuristics for 136 choosing mode to use.</div> 137</td> 138</tr> 139<tr class="rowColor"> 140<td class="colOne"><code><strong><a href="../../../../com/fasterxml/jackson/annotation/JsonCreator.Mode.html#DELEGATING">DELEGATING</a></strong></code> 141<div class="block">Mode that indicates that if creator takes a single argument, the whole incoming 142 data value is to be bound into declared type of that argument; this "delegate" 143 value is then passed as the argument to creator.</div> 144</td> 145</tr> 146<tr class="altColor"> 147<td class="colOne"><code><strong><a href="../../../../com/fasterxml/jackson/annotation/JsonCreator.Mode.html#DISABLED">DISABLED</a></strong></code> 148<div class="block">Pseudo-mode that indicates that creator is not to be used.</div> 149</td> 150</tr> 151<tr class="rowColor"> 152<td class="colOne"><code><strong><a href="../../../../com/fasterxml/jackson/annotation/JsonCreator.Mode.html#PROPERTIES">PROPERTIES</a></strong></code> 153<div class="block">Mode that indicates that the argument(s) for creator are to be bound from matching 154 properties of incoming Object value, using creator argument names (explicit or implicit) 155 to match incoming Object properties to arguments.</div> 156</td> 157</tr> 158</table> 159</li> 160</ul> 161<!-- ========== METHOD SUMMARY =========== --> 162<ul class="blockList"> 163<li class="blockList"><a name="method_summary"> 164<!-- --> 165</a> 166<h3>Method Summary</h3> 167<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation"> 168<caption><span>Methods</span><span class="tabEnd"> </span></caption> 169<tr> 170<th class="colFirst" scope="col">Modifier and Type</th> 171<th class="colLast" scope="col">Method and Description</th> 172</tr> 173<tr class="altColor"> 174<td class="colFirst"><code>static <a href="../../../../com/fasterxml/jackson/annotation/JsonCreator.Mode.html" title="enum in com.fasterxml.jackson.annotation">JsonCreator.Mode</a></code></td> 175<td class="colLast"><code><strong><a href="../../../../com/fasterxml/jackson/annotation/JsonCreator.Mode.html#valueOf(java.lang.String)">valueOf</a></strong>(<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> name)</code> 176<div class="block">Returns the enum constant of this type with the specified name.</div> 177</td> 178</tr> 179<tr class="rowColor"> 180<td class="colFirst"><code>static <a href="../../../../com/fasterxml/jackson/annotation/JsonCreator.Mode.html" title="enum in com.fasterxml.jackson.annotation">JsonCreator.Mode</a>[]</code></td> 181<td class="colLast"><code><strong><a href="../../../../com/fasterxml/jackson/annotation/JsonCreator.Mode.html#values()">values</a></strong>()</code> 182<div class="block">Returns an array containing the constants of this enum type, in 183the order they are declared.</div> 184</td> 185</tr> 186</table> 187<ul class="blockList"> 188<li class="blockList"><a name="methods_inherited_from_class_java.lang.Enum"> 189<!-- --> 190</a> 191<h3>Methods inherited from class java.lang.<a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Enum.html?is-external=true" title="class or interface in java.lang">Enum</a></h3> 192<code><a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Enum.html?is-external=true#clone()" title="class or interface in java.lang">clone</a>, <a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Enum.html?is-external=true#compareTo(E)" title="class or interface in java.lang">compareTo</a>, <a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Enum.html?is-external=true#equals(java.lang.Object)" title="class or interface in java.lang">equals</a>, <a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Enum.html?is-external=true#finalize()" title="class or interface in java.lang">finalize</a>, <a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Enum.html?is-external=true#getDeclaringClass()" title="class or interface in java.lang">getDeclaringClass</a>, <a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Enum.html?is-external=true#hashCode()" title="class or interface in java.lang">hashCode</a>, <a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Enum.html?is-external=true#name()" title="class or interface in java.lang">name</a>, <a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Enum.html?is-external=true#ordinal()" title="class or interface in java.lang">ordinal</a>, <a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Enum.html?is-external=true#toString()" title="class or interface in java.lang">toString</a>, <a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Enum.html?is-external=true#valueOf(java.lang.Class,%20java.lang.String)" title="class or interface in java.lang">valueOf</a></code></li> 193</ul> 194<ul class="blockList"> 195<li class="blockList"><a name="methods_inherited_from_class_java.lang.Object"> 196<!-- --> 197</a> 198<h3>Methods inherited from class java.lang.<a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></h3> 199<code><a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#getClass()" title="class or interface in java.lang">getClass</a>, <a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#notify()" title="class or interface in java.lang">notify</a>, <a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#notifyAll()" title="class or interface in java.lang">notifyAll</a>, <a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#wait()" title="class or interface in java.lang">wait</a>, <a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#wait(long)" title="class or interface in java.lang">wait</a>, <a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#wait(long,%20int)" title="class or interface in java.lang">wait</a></code></li> 200</ul> 201</li> 202</ul> 203</li> 204</ul> 205</div> 206<div class="details"> 207<ul class="blockList"> 208<li class="blockList"> 209<!-- ============ ENUM CONSTANT DETAIL =========== --> 210<ul class="blockList"> 211<li class="blockList"><a name="enum_constant_detail"> 212<!-- --> 213</a> 214<h3>Enum Constant Detail</h3> 215<a name="DEFAULT"> 216<!-- --> 217</a> 218<ul class="blockList"> 219<li class="blockList"> 220<h4>DEFAULT</h4> 221<pre>public static final <a href="../../../../com/fasterxml/jackson/annotation/JsonCreator.Mode.html" title="enum in com.fasterxml.jackson.annotation">JsonCreator.Mode</a> DEFAULT</pre> 222<div class="block">Pseudo-mode that indicates that caller is to use default heuristics for 223 choosing mode to use. This typically favors use of delegating mode for 224 single-argument creators that take structured types.</div> 225</li> 226</ul> 227<a name="DELEGATING"> 228<!-- --> 229</a> 230<ul class="blockList"> 231<li class="blockList"> 232<h4>DELEGATING</h4> 233<pre>public static final <a href="../../../../com/fasterxml/jackson/annotation/JsonCreator.Mode.html" title="enum in com.fasterxml.jackson.annotation">JsonCreator.Mode</a> DELEGATING</pre> 234<div class="block">Mode that indicates that if creator takes a single argument, the whole incoming 235 data value is to be bound into declared type of that argument; this "delegate" 236 value is then passed as the argument to creator.</div> 237</li> 238</ul> 239<a name="PROPERTIES"> 240<!-- --> 241</a> 242<ul class="blockList"> 243<li class="blockList"> 244<h4>PROPERTIES</h4> 245<pre>public static final <a href="../../../../com/fasterxml/jackson/annotation/JsonCreator.Mode.html" title="enum in com.fasterxml.jackson.annotation">JsonCreator.Mode</a> PROPERTIES</pre> 246<div class="block">Mode that indicates that the argument(s) for creator are to be bound from matching 247 properties of incoming Object value, using creator argument names (explicit or implicit) 248 to match incoming Object properties to arguments. 249<p> 250 Note that this mode is currently (2.5) always used for multiple-argument creators; 251 the only ambiguous case is that of a single-argument creator.</div> 252</li> 253</ul> 254<a name="DISABLED"> 255<!-- --> 256</a> 257<ul class="blockListLast"> 258<li class="blockList"> 259<h4>DISABLED</h4> 260<pre>public static final <a href="../../../../com/fasterxml/jackson/annotation/JsonCreator.Mode.html" title="enum in com.fasterxml.jackson.annotation">JsonCreator.Mode</a> DISABLED</pre> 261<div class="block">Pseudo-mode that indicates that creator is not to be used. This can be used as a result 262 value for explicit disabling, usually either by custom annotation introspector, 263 or by annotation mix-ins (for example when choosing different creator).</div> 264</li> 265</ul> 266</li> 267</ul> 268<!-- ============ METHOD DETAIL ========== --> 269<ul class="blockList"> 270<li class="blockList"><a name="method_detail"> 271<!-- --> 272</a> 273<h3>Method Detail</h3> 274<a name="values()"> 275<!-- --> 276</a> 277<ul class="blockList"> 278<li class="blockList"> 279<h4>values</h4> 280<pre>public static <a href="../../../../com/fasterxml/jackson/annotation/JsonCreator.Mode.html" title="enum in com.fasterxml.jackson.annotation">JsonCreator.Mode</a>[] values()</pre> 281<div class="block">Returns an array containing the constants of this enum type, in 282the order they are declared. This method may be used to iterate 283over the constants as follows: 284<pre> 285for (JsonCreator.Mode c : JsonCreator.Mode.values()) 286 System.out.println(c); 287</pre></div> 288<dl><dt><span class="strong">Returns:</span></dt><dd>an array containing the constants of this enum type, in the order they are declared</dd></dl> 289</li> 290</ul> 291<a name="valueOf(java.lang.String)"> 292<!-- --> 293</a> 294<ul class="blockListLast"> 295<li class="blockList"> 296<h4>valueOf</h4> 297<pre>public static <a href="../../../../com/fasterxml/jackson/annotation/JsonCreator.Mode.html" title="enum in com.fasterxml.jackson.annotation">JsonCreator.Mode</a> valueOf(<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> name)</pre> 298<div class="block">Returns the enum constant of this type with the specified name. 299The string must match <i>exactly</i> an identifier used to declare an 300enum constant in this type. (Extraneous whitespace characters are 301not permitted.)</div> 302<dl><dt><span class="strong">Parameters:</span></dt><dd><code>name</code> - the name of the enum constant to be returned.</dd> 303<dt><span class="strong">Returns:</span></dt><dd>the enum constant with the specified name</dd> 304<dt><span class="strong">Throws:</span></dt> 305<dd><code><a href="http://docs.oracle.com/javase/6/docs/api/java/lang/IllegalArgumentException.html?is-external=true" title="class or interface in java.lang">IllegalArgumentException</a></code> - if this enum type has no constant with the specified name</dd> 306<dd><code><a href="http://docs.oracle.com/javase/6/docs/api/java/lang/NullPointerException.html?is-external=true" title="class or interface in java.lang">NullPointerException</a></code> - if the argument is null</dd></dl> 307</li> 308</ul> 309</li> 310</ul> 311</li> 312</ul> 313</div> 314</div> 315<!-- ========= END OF CLASS DATA ========= --> 316<!-- ======= START OF BOTTOM NAVBAR ====== --> 317<div class="bottomNav"><a name="navbar_bottom"> 318<!-- --> 319</a><a href="#skip-navbar_bottom" title="Skip navigation links"></a><a name="navbar_bottom_firstrow"> 320<!-- --> 321</a> 322<ul class="navList" title="Navigation"> 323<li><a href="../../../../com/fasterxml/jackson/annotation/package-summary.html">Package</a></li> 324<li class="navBarCell1Rev">Class</li> 325<li><a href="class-use/JsonCreator.Mode.html">Use</a></li> 326<li><a href="package-tree.html">Tree</a></li> 327<li><a href="../../../../deprecated-list.html">Deprecated</a></li> 328<li><a href="../../../../index-all.html">Index</a></li> 329<li><a href="../../../../help-doc.html">Help</a></li> 330</ul> 331</div> 332<div class="subNav"> 333<ul class="navList"> 334<li><a href="../../../../com/fasterxml/jackson/annotation/JsonCreator.html" title="annotation in com.fasterxml.jackson.annotation"><span class="strong">Prev Class</span></a></li> 335<li><a href="../../../../com/fasterxml/jackson/annotation/JsonFilter.html" title="annotation in com.fasterxml.jackson.annotation"><span class="strong">Next Class</span></a></li> 336</ul> 337<ul class="navList"> 338<li><a href="../../../../index.html?com/fasterxml/jackson/annotation/JsonCreator.Mode.html" target="_top">Frames</a></li> 339<li><a href="JsonCreator.Mode.html" target="_top">No Frames</a></li> 340</ul> 341<ul class="navList" id="allclasses_navbar_bottom"> 342<li><a href="../../../../allclasses-noframe.html">All Classes</a></li> 343</ul> 344<div> 345<script type="text/javascript"><!-- 346 allClassesLink = document.getElementById("allclasses_navbar_bottom"); 347 if(window==top) { 348 allClassesLink.style.display = "block"; 349 } 350 else { 351 allClassesLink.style.display = "none"; 352 } 353 //--> 354</script> 355</div> 356<div> 357<ul class="subNavList"> 358<li>Summary: </li> 359<li>Nested | </li> 360<li><a href="#enum_constant_summary">Enum Constants</a> | </li> 361<li>Field | </li> 362<li><a href="#method_summary">Method</a></li> 363</ul> 364<ul class="subNavList"> 365<li>Detail: </li> 366<li><a href="#enum_constant_detail">Enum Constants</a> | </li> 367<li>Field | </li> 368<li><a href="#method_detail">Method</a></li> 369</ul> 370</div> 371<a name="skip-navbar_bottom"> 372<!-- --> 373</a></div> 374<!-- ======== END OF BOTTOM NAVBAR ======= --> 375<p class="legalCopy"><small>Copyright © 2008–2016 <a href="http://fasterxml.com/">FasterXML</a>. All rights reserved.</small></p> 376</body> 377</html> 378