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_25) on Thu May 29 09:45:53 PDT 2014 --> 6<meta http-equiv="Content-Type" content="text/html" charset="UTF-8"> 7<title>ObjectIdGenerator.IdKey (Jackson-annotations 2.4.0 API)</title> 8<meta name="date" content="2014-05-29"> 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="ObjectIdGenerator.IdKey (Jackson-annotations 2.4.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/ObjectIdGenerator.IdKey.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/ObjectIdGenerator.html" title="class in com.fasterxml.jackson.annotation"><span class="strong">Prev Class</span></a></li> 40<li><a href="../../../../com/fasterxml/jackson/annotation/ObjectIdGenerators.html" title="class 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/ObjectIdGenerator.IdKey.html" target="_top">Frames</a></li> 44<li><a href="ObjectIdGenerator.IdKey.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="#field_summary">Field</a> | </li> 66<li><a href="#constructor_summary">Constr</a> | </li> 67<li><a href="#method_summary">Method</a></li> 68</ul> 69<ul class="subNavList"> 70<li>Detail: </li> 71<li><a href="#field_detail">Field</a> | </li> 72<li><a href="#constructor_detail">Constr</a> | </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="Class ObjectIdGenerator.IdKey" class="title">Class ObjectIdGenerator.IdKey</h2> 84</div> 85<div class="contentContainer"> 86<ul class="inheritance"> 87<li><a href="http://download.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>com.fasterxml.jackson.annotation.ObjectIdGenerator.IdKey</li> 91</ul> 92</li> 93</ul> 94<div class="description"> 95<ul class="blockList"> 96<li class="blockList"> 97<dl> 98<dt>All Implemented Interfaces:</dt> 99<dd><a href="http://download.oracle.com/javase/6/docs/api/java/io/Serializable.html?is-external=true" title="class or interface in java.io">Serializable</a></dd> 100</dl> 101<dl> 102<dt>Enclosing class:</dt> 103<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> 104</dl> 105<hr> 106<br> 107<pre>public static final class <span class="strong">ObjectIdGenerator.IdKey</span> 108extends <a href="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a> 109implements <a href="http://download.oracle.com/javase/6/docs/api/java/io/Serializable.html?is-external=true" title="class or interface in java.io">Serializable</a></pre> 110<div class="block">Simple key class that can be used as a key for 111 ObjectId-to-POJO mappings, when multiple ObjectId types 112 and scopes are used.</div> 113<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../serialized-form.html#com.fasterxml.jackson.annotation.ObjectIdGenerator.IdKey">Serialized Form</a></dd></dl> 114</li> 115</ul> 116</div> 117<div class="summary"> 118<ul class="blockList"> 119<li class="blockList"> 120<!-- =========== FIELD SUMMARY =========== --> 121<ul class="blockList"> 122<li class="blockList"><a name="field_summary"> 123<!-- --> 124</a> 125<h3>Field Summary</h3> 126<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Field Summary table, listing fields, and an explanation"> 127<caption><span>Fields</span><span class="tabEnd"> </span></caption> 128<tr> 129<th class="colFirst" scope="col">Modifier and Type</th> 130<th class="colLast" scope="col">Field and Description</th> 131</tr> 132<tr class="altColor"> 133<td class="colFirst"><code><a href="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></code></td> 134<td class="colLast"><code><strong><a href="../../../../com/fasterxml/jackson/annotation/ObjectIdGenerator.IdKey.html#key">key</a></strong></code> 135<div class="block">Object for which Object Id was generated: can NOT be null.</div> 136</td> 137</tr> 138<tr class="rowColor"> 139<td class="colFirst"><code><a href="http://download.oracle.com/javase/6/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a><?></code></td> 140<td class="colLast"><code><strong><a href="../../../../com/fasterxml/jackson/annotation/ObjectIdGenerator.IdKey.html#scope">scope</a></strong></code> 141<div class="block">Scope of the Object Id (may be null, to denote global)</div> 142</td> 143</tr> 144<tr class="altColor"> 145<td class="colFirst"><code><a href="http://download.oracle.com/javase/6/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a><?></code></td> 146<td class="colLast"><code><strong><a href="../../../../com/fasterxml/jackson/annotation/ObjectIdGenerator.IdKey.html#type">type</a></strong></code> 147<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> 148</td> 149</tr> 150</table> 151</li> 152</ul> 153<!-- ======== CONSTRUCTOR SUMMARY ======== --> 154<ul class="blockList"> 155<li class="blockList"><a name="constructor_summary"> 156<!-- --> 157</a> 158<h3>Constructor Summary</h3> 159<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation"> 160<caption><span>Constructors</span><span class="tabEnd"> </span></caption> 161<tr> 162<th class="colOne" scope="col">Constructor and Description</th> 163</tr> 164<tr class="altColor"> 165<td class="colOne"><code><strong><a href="../../../../com/fasterxml/jackson/annotation/ObjectIdGenerator.IdKey.html#ObjectIdGenerator.IdKey(java.lang.Class, java.lang.Class, java.lang.Object)">ObjectIdGenerator.IdKey</a></strong>(<a href="http://download.oracle.com/javase/6/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a><?> type, 166 <a href="http://download.oracle.com/javase/6/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a><?> scope, 167 <a href="http://download.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> 168</tr> 169</table> 170</li> 171</ul> 172<!-- ========== METHOD SUMMARY =========== --> 173<ul class="blockList"> 174<li class="blockList"><a name="method_summary"> 175<!-- --> 176</a> 177<h3>Method Summary</h3> 178<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation"> 179<caption><span>Methods</span><span class="tabEnd"> </span></caption> 180<tr> 181<th class="colFirst" scope="col">Modifier and Type</th> 182<th class="colLast" scope="col">Method and Description</th> 183</tr> 184<tr class="altColor"> 185<td class="colFirst"><code>boolean</code></td> 186<td class="colLast"><code><strong><a href="../../../../com/fasterxml/jackson/annotation/ObjectIdGenerator.IdKey.html#equals(java.lang.Object)">equals</a></strong>(<a href="http://download.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> 187</tr> 188<tr class="rowColor"> 189<td class="colFirst"><code>int</code></td> 190<td class="colLast"><code><strong><a href="../../../../com/fasterxml/jackson/annotation/ObjectIdGenerator.IdKey.html#hashCode()">hashCode</a></strong>()</code> </td> 191</tr> 192</table> 193<ul class="blockList"> 194<li class="blockList"><a name="methods_inherited_from_class_java.lang.Object"> 195<!-- --> 196</a> 197<h3>Methods inherited from class java.lang.<a href="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></h3> 198<code><a href="http://download.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="http://download.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="http://download.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://download.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://download.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://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#toString()" title="class or interface in java.lang">toString</a>, <a href="http://download.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://download.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://download.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> 199</ul> 200</li> 201</ul> 202</li> 203</ul> 204</div> 205<div class="details"> 206<ul class="blockList"> 207<li class="blockList"> 208<!-- ============ FIELD DETAIL =========== --> 209<ul class="blockList"> 210<li class="blockList"><a name="field_detail"> 211<!-- --> 212</a> 213<h3>Field Detail</h3> 214<a name="type"> 215<!-- --> 216</a> 217<ul class="blockList"> 218<li class="blockList"> 219<h4>type</h4> 220<pre>public final <a href="http://download.oracle.com/javase/6/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a><?> type</pre> 221<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> 222</li> 223</ul> 224<a name="scope"> 225<!-- --> 226</a> 227<ul class="blockList"> 228<li class="blockList"> 229<h4>scope</h4> 230<pre>public final <a href="http://download.oracle.com/javase/6/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a><?> scope</pre> 231<div class="block">Scope of the Object Id (may be null, to denote global)</div> 232</li> 233</ul> 234<a name="key"> 235<!-- --> 236</a> 237<ul class="blockListLast"> 238<li class="blockList"> 239<h4>key</h4> 240<pre>public final <a href="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a> key</pre> 241<div class="block">Object for which Object Id was generated: can NOT be null.</div> 242</li> 243</ul> 244</li> 245</ul> 246<!-- ========= CONSTRUCTOR DETAIL ======== --> 247<ul class="blockList"> 248<li class="blockList"><a name="constructor_detail"> 249<!-- --> 250</a> 251<h3>Constructor Detail</h3> 252<a name="ObjectIdGenerator.IdKey(java.lang.Class, java.lang.Class, java.lang.Object)"> 253<!-- --> 254</a> 255<ul class="blockListLast"> 256<li class="blockList"> 257<h4>ObjectIdGenerator.IdKey</h4> 258<pre>public ObjectIdGenerator.IdKey(<a href="http://download.oracle.com/javase/6/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a><?> type, 259 <a href="http://download.oracle.com/javase/6/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a><?> scope, 260 <a href="http://download.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</li> 262</ul> 263</li> 264</ul> 265<!-- ============ METHOD DETAIL ========== --> 266<ul class="blockList"> 267<li class="blockList"><a name="method_detail"> 268<!-- --> 269</a> 270<h3>Method Detail</h3> 271<a name="hashCode()"> 272<!-- --> 273</a> 274<ul class="blockList"> 275<li class="blockList"> 276<h4>hashCode</h4> 277<pre>public int hashCode()</pre> 278<dl> 279<dt><strong>Overrides:</strong></dt> 280<dd><code><a href="http://download.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="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></code></dd> 281</dl> 282</li> 283</ul> 284<a name="equals(java.lang.Object)"> 285<!-- --> 286</a> 287<ul class="blockListLast"> 288<li class="blockList"> 289<h4>equals</h4> 290<pre>public boolean equals(<a href="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a> o)</pre> 291<dl> 292<dt><strong>Overrides:</strong></dt> 293<dd><code><a href="http://download.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="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></code></dd> 294</dl> 295</li> 296</ul> 297</li> 298</ul> 299</li> 300</ul> 301</div> 302</div> 303<!-- ========= END OF CLASS DATA ========= --> 304<!-- ======= START OF BOTTOM NAVBAR ====== --> 305<div class="bottomNav"><a name="navbar_bottom"> 306<!-- --> 307</a><a href="#skip-navbar_bottom" title="Skip navigation links"></a><a name="navbar_bottom_firstrow"> 308<!-- --> 309</a> 310<ul class="navList" title="Navigation"> 311<li><a href="../../../../com/fasterxml/jackson/annotation/package-summary.html">Package</a></li> 312<li class="navBarCell1Rev">Class</li> 313<li><a href="class-use/ObjectIdGenerator.IdKey.html">Use</a></li> 314<li><a href="package-tree.html">Tree</a></li> 315<li><a href="../../../../deprecated-list.html">Deprecated</a></li> 316<li><a href="../../../../index-all.html">Index</a></li> 317<li><a href="../../../../help-doc.html">Help</a></li> 318</ul> 319</div> 320<div class="subNav"> 321<ul class="navList"> 322<li><a href="../../../../com/fasterxml/jackson/annotation/ObjectIdGenerator.html" title="class in com.fasterxml.jackson.annotation"><span class="strong">Prev Class</span></a></li> 323<li><a href="../../../../com/fasterxml/jackson/annotation/ObjectIdGenerators.html" title="class in com.fasterxml.jackson.annotation"><span class="strong">Next Class</span></a></li> 324</ul> 325<ul class="navList"> 326<li><a href="../../../../index.html?com/fasterxml/jackson/annotation/ObjectIdGenerator.IdKey.html" target="_top">Frames</a></li> 327<li><a href="ObjectIdGenerator.IdKey.html" target="_top">No Frames</a></li> 328</ul> 329<ul class="navList" id="allclasses_navbar_bottom"> 330<li><a href="../../../../allclasses-noframe.html">All Classes</a></li> 331</ul> 332<div> 333<script type="text/javascript"><!-- 334 allClassesLink = document.getElementById("allclasses_navbar_bottom"); 335 if(window==top) { 336 allClassesLink.style.display = "block"; 337 } 338 else { 339 allClassesLink.style.display = "none"; 340 } 341 //--> 342</script> 343</div> 344<div> 345<ul class="subNavList"> 346<li>Summary: </li> 347<li>Nested | </li> 348<li><a href="#field_summary">Field</a> | </li> 349<li><a href="#constructor_summary">Constr</a> | </li> 350<li><a href="#method_summary">Method</a></li> 351</ul> 352<ul class="subNavList"> 353<li>Detail: </li> 354<li><a href="#field_detail">Field</a> | </li> 355<li><a href="#constructor_detail">Constr</a> | </li> 356<li><a href="#method_detail">Method</a></li> 357</ul> 358</div> 359<a name="skip-navbar_bottom"> 360<!-- --> 361</a></div> 362<!-- ======== END OF BOTTOM NAVBAR ======= --> 363<p class="legalCopy"><small>Copyright © 2014 <a href="http://fasterxml.com/">FasterXML</a>. All Rights Reserved.</small></p> 364</body> 365</html> 366