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 Wed Sep 25 19:26:35 PDT 2019 --> 6<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> 7<title>ObjectIdGenerator.IdKey (Jackson-annotations 2.10.0 API)</title> 8<meta name="date" content="2019-09-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="ObjectIdGenerator.IdKey (Jackson-annotations 2.10.0 API)"; 17 } 18 } 19 catch(err) { 20 } 21//--> 22var methods = {"i0":10,"i1":10,"i2":10}; 23var tabs = {65535:["t0","All Methods"],2:["t2","Instance 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/ObjectIdGenerator.IdKey.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/ObjectIdGenerator.html" title="class in com.fasterxml.jackson.annotation"><span class="typeNameLink">Prev Class</span></a></li> 53<li><a href="../../../../com/fasterxml/jackson/annotation/ObjectIdGenerators.html" title="class 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/ObjectIdGenerator.IdKey.html" target="_top">Frames</a></li> 57<li><a href="ObjectIdGenerator.IdKey.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="#field.summary">Field</a> | </li> 79<li><a href="#constructor.summary">Constr</a> | </li> 80<li><a href="#method.summary">Method</a></li> 81</ul> 82<ul class="subNavList"> 83<li>Detail: </li> 84<li><a href="#field.detail">Field</a> | </li> 85<li><a href="#constructor.detail">Constr</a> | </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="Class ObjectIdGenerator.IdKey" class="title">Class ObjectIdGenerator.IdKey</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>com.fasterxml.jackson.annotation.ObjectIdGenerator.IdKey</li> 104</ul> 105</li> 106</ul> 107<div class="description"> 108<ul class="blockList"> 109<li class="blockList"> 110<dl> 111<dt>All Implemented Interfaces:</dt> 112<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></dd> 113</dl> 114<dl> 115<dt>Enclosing class:</dt> 116<dd><a href="../../../../com/fasterxml/jackson/annotation/ObjectIdGenerator.html" title="class in com.fasterxml.jackson.annotation">ObjectIdGenerator</a><<a href="../../../../com/fasterxml/jackson/annotation/ObjectIdGenerator.html" title="type parameter in ObjectIdGenerator">T</a>></dd> 117</dl> 118<hr> 119<br> 120<pre>public static final class <span class="typeNameLabel">ObjectIdGenerator.IdKey</span> 121extends <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> 122implements <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></pre> 123<div class="block">Simple key class that can be used as a key for 124 ObjectId-to-POJO mappings, when multiple ObjectId types 125 and scopes are used.</div> 126<dl> 127<dt><span class="seeLabel">See Also:</span></dt> 128<dd><a href="../../../../serialized-form.html#com.fasterxml.jackson.annotation.ObjectIdGenerator.IdKey">Serialized Form</a></dd> 129</dl> 130</li> 131</ul> 132</div> 133<div class="summary"> 134<ul class="blockList"> 135<li class="blockList"> 136<!-- =========== FIELD SUMMARY =========== --> 137<ul class="blockList"> 138<li class="blockList"><a name="field.summary"> 139<!-- --> 140</a> 141<h3>Field Summary</h3> 142<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Field Summary table, listing fields, and an explanation"> 143<caption><span>Fields</span><span class="tabEnd"> </span></caption> 144<tr> 145<th class="colFirst" scope="col">Modifier and Type</th> 146<th class="colLast" scope="col">Field and Description</th> 147</tr> 148<tr class="altColor"> 149<td class="colFirst"><code><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></code></td> 150<td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/fasterxml/jackson/annotation/ObjectIdGenerator.IdKey.html#key">key</a></span></code> 151<div class="block">Object for which Object Id was generated: can NOT be null.</div> 152</td> 153</tr> 154<tr class="rowColor"> 155<td class="colFirst"><code><a href="https://docs.oracle.com/javase/6/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a><?></code></td> 156<td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/fasterxml/jackson/annotation/ObjectIdGenerator.IdKey.html#scope">scope</a></span></code> 157<div class="block">Scope of the Object Id (may be null, to denote global)</div> 158</td> 159</tr> 160<tr class="altColor"> 161<td class="colFirst"><code><a href="https://docs.oracle.com/javase/6/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a><?></code></td> 162<td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/fasterxml/jackson/annotation/ObjectIdGenerator.IdKey.html#type">type</a></span></code> 163<div class="block">Type of <a href="../../../../com/fasterxml/jackson/annotation/ObjectIdGenerator.html" title="class in com.fasterxml.jackson.annotation"><code>ObjectIdGenerator</code></a> used for generating Object Id</div> 164</td> 165</tr> 166</table> 167</li> 168</ul> 169<!-- ======== CONSTRUCTOR SUMMARY ======== --> 170<ul class="blockList"> 171<li class="blockList"><a name="constructor.summary"> 172<!-- --> 173</a> 174<h3>Constructor Summary</h3> 175<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation"> 176<caption><span>Constructors</span><span class="tabEnd"> </span></caption> 177<tr> 178<th class="colOne" scope="col">Constructor and Description</th> 179</tr> 180<tr class="altColor"> 181<td class="colOne"><code><span class="memberNameLink"><a href="../../../../com/fasterxml/jackson/annotation/ObjectIdGenerator.IdKey.html#IdKey-java.lang.Class-java.lang.Class-java.lang.Object-">IdKey</a></span>(<a href="https://docs.oracle.com/javase/6/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a><?> type, 182 <a href="https://docs.oracle.com/javase/6/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a><?> scope, 183 <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> key)</code> </td> 184</tr> 185</table> 186</li> 187</ul> 188<!-- ========== METHOD SUMMARY =========== --> 189<ul class="blockList"> 190<li class="blockList"><a name="method.summary"> 191<!-- --> 192</a> 193<h3>Method Summary</h3> 194<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation"> 195<caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd"> </span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance 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> 196<tr> 197<th class="colFirst" scope="col">Modifier and Type</th> 198<th class="colLast" scope="col">Method and Description</th> 199</tr> 200<tr id="i0" class="altColor"> 201<td class="colFirst"><code>boolean</code></td> 202<td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/fasterxml/jackson/annotation/ObjectIdGenerator.IdKey.html#equals-java.lang.Object-">equals</a></span>(<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> o)</code> </td> 203</tr> 204<tr id="i1" class="rowColor"> 205<td class="colFirst"><code>int</code></td> 206<td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/fasterxml/jackson/annotation/ObjectIdGenerator.IdKey.html#hashCode--">hashCode</a></span>()</code> </td> 207</tr> 208<tr id="i2" class="altColor"> 209<td class="colFirst"><code><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></code></td> 210<td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/fasterxml/jackson/annotation/ObjectIdGenerator.IdKey.html#toString--">toString</a></span>()</code> </td> 211</tr> 212</table> 213<ul class="blockList"> 214<li class="blockList"><a name="methods.inherited.from.class.java.lang.Object"> 215<!-- --> 216</a> 217<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> 218<code><a href="https://docs.oracle.com/javase/6/docs/api/java/lang/Object.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/Object.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/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> 219</ul> 220</li> 221</ul> 222</li> 223</ul> 224</div> 225<div class="details"> 226<ul class="blockList"> 227<li class="blockList"> 228<!-- ============ FIELD DETAIL =========== --> 229<ul class="blockList"> 230<li class="blockList"><a name="field.detail"> 231<!-- --> 232</a> 233<h3>Field Detail</h3> 234<a name="type"> 235<!-- --> 236</a> 237<ul class="blockList"> 238<li class="blockList"> 239<h4>type</h4> 240<pre>public final <a href="https://docs.oracle.com/javase/6/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a><?> type</pre> 241<div class="block">Type of <a href="../../../../com/fasterxml/jackson/annotation/ObjectIdGenerator.html" title="class in com.fasterxml.jackson.annotation"><code>ObjectIdGenerator</code></a> used for generating Object Id</div> 242</li> 243</ul> 244<a name="scope"> 245<!-- --> 246</a> 247<ul class="blockList"> 248<li class="blockList"> 249<h4>scope</h4> 250<pre>public final <a href="https://docs.oracle.com/javase/6/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a><?> scope</pre> 251<div class="block">Scope of the Object Id (may be null, to denote global)</div> 252</li> 253</ul> 254<a name="key"> 255<!-- --> 256</a> 257<ul class="blockListLast"> 258<li class="blockList"> 259<h4>key</h4> 260<pre>public final <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> key</pre> 261<div class="block">Object for which Object Id was generated: can NOT be null.</div> 262</li> 263</ul> 264</li> 265</ul> 266<!-- ========= CONSTRUCTOR DETAIL ======== --> 267<ul class="blockList"> 268<li class="blockList"><a name="constructor.detail"> 269<!-- --> 270</a> 271<h3>Constructor Detail</h3> 272<a name="IdKey-java.lang.Class-java.lang.Class-java.lang.Object-"> 273<!-- --> 274</a> 275<ul class="blockListLast"> 276<li class="blockList"> 277<h4>IdKey</h4> 278<pre>public IdKey(<a href="https://docs.oracle.com/javase/6/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a><?> type, 279 <a href="https://docs.oracle.com/javase/6/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a><?> scope, 280 <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> key)</pre> 281</li> 282</ul> 283</li> 284</ul> 285<!-- ============ METHOD DETAIL ========== --> 286<ul class="blockList"> 287<li class="blockList"><a name="method.detail"> 288<!-- --> 289</a> 290<h3>Method Detail</h3> 291<a name="hashCode--"> 292<!-- --> 293</a> 294<ul class="blockList"> 295<li class="blockList"> 296<h4>hashCode</h4> 297<pre>public int hashCode()</pre> 298<dl> 299<dt><span class="overrideSpecifyLabel">Overrides:</span></dt> 300<dd><code><a href="https://docs.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#hashCode--" title="class or interface in java.lang">hashCode</a></code> in class <code><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></code></dd> 301</dl> 302</li> 303</ul> 304<a name="equals-java.lang.Object-"> 305<!-- --> 306</a> 307<ul class="blockList"> 308<li class="blockList"> 309<h4>equals</h4> 310<pre>public boolean equals(<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> o)</pre> 311<dl> 312<dt><span class="overrideSpecifyLabel">Overrides:</span></dt> 313<dd><code><a href="https://docs.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#equals-java.lang.Object-" title="class or interface in java.lang">equals</a></code> in class <code><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></code></dd> 314</dl> 315</li> 316</ul> 317<a name="toString--"> 318<!-- --> 319</a> 320<ul class="blockListLast"> 321<li class="blockList"> 322<h4>toString</h4> 323<pre>public <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> toString()</pre> 324<dl> 325<dt><span class="overrideSpecifyLabel">Overrides:</span></dt> 326<dd><code><a href="https://docs.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#toString--" title="class or interface in java.lang">toString</a></code> in class <code><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></code></dd> 327</dl> 328</li> 329</ul> 330</li> 331</ul> 332</li> 333</ul> 334</div> 335</div> 336<!-- ========= END OF CLASS DATA ========= --> 337<!-- ======= START OF BOTTOM NAVBAR ====== --> 338<div class="bottomNav"><a name="navbar.bottom"> 339<!-- --> 340</a> 341<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div> 342<a name="navbar.bottom.firstrow"> 343<!-- --> 344</a> 345<ul class="navList" title="Navigation"> 346<li><a href="../../../../com/fasterxml/jackson/annotation/package-summary.html">Package</a></li> 347<li class="navBarCell1Rev">Class</li> 348<li><a href="class-use/ObjectIdGenerator.IdKey.html">Use</a></li> 349<li><a href="package-tree.html">Tree</a></li> 350<li><a href="../../../../deprecated-list.html">Deprecated</a></li> 351<li><a href="../../../../index-all.html">Index</a></li> 352<li><a href="../../../../help-doc.html">Help</a></li> 353</ul> 354</div> 355<div class="subNav"> 356<ul class="navList"> 357<li><a href="../../../../com/fasterxml/jackson/annotation/ObjectIdGenerator.html" title="class in com.fasterxml.jackson.annotation"><span class="typeNameLink">Prev Class</span></a></li> 358<li><a href="../../../../com/fasterxml/jackson/annotation/ObjectIdGenerators.html" title="class in com.fasterxml.jackson.annotation"><span class="typeNameLink">Next Class</span></a></li> 359</ul> 360<ul class="navList"> 361<li><a href="../../../../index.html?com/fasterxml/jackson/annotation/ObjectIdGenerator.IdKey.html" target="_top">Frames</a></li> 362<li><a href="ObjectIdGenerator.IdKey.html" target="_top">No Frames</a></li> 363</ul> 364<ul class="navList" id="allclasses_navbar_bottom"> 365<li><a href="../../../../allclasses-noframe.html">All Classes</a></li> 366</ul> 367<div> 368<script type="text/javascript"><!-- 369 allClassesLink = document.getElementById("allclasses_navbar_bottom"); 370 if(window==top) { 371 allClassesLink.style.display = "block"; 372 } 373 else { 374 allClassesLink.style.display = "none"; 375 } 376 //--> 377</script> 378</div> 379<div> 380<ul class="subNavList"> 381<li>Summary: </li> 382<li>Nested | </li> 383<li><a href="#field.summary">Field</a> | </li> 384<li><a href="#constructor.summary">Constr</a> | </li> 385<li><a href="#method.summary">Method</a></li> 386</ul> 387<ul class="subNavList"> 388<li>Detail: </li> 389<li><a href="#field.detail">Field</a> | </li> 390<li><a href="#constructor.detail">Constr</a> | </li> 391<li><a href="#method.detail">Method</a></li> 392</ul> 393</div> 394<a name="skip.navbar.bottom"> 395<!-- --> 396</a></div> 397<!-- ======== END OF BOTTOM NAVBAR ======= --> 398<p class="legalCopy"><small>Copyright © 2008–2019 <a href="http://fasterxml.com/">FasterXML</a>. All rights reserved.</small></p> 399</body> 400</html> 401