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