• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
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:11 PST 2016 -->
6<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
7<title>ObjectIdGenerator.IdKey (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="ObjectIdGenerator.IdKey (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/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:&nbsp;</li>
64<li>Nested&nbsp;|&nbsp;</li>
65<li><a href="#field_summary">Field</a>&nbsp;|&nbsp;</li>
66<li><a href="#constructor_summary">Constr</a>&nbsp;|&nbsp;</li>
67<li><a href="#method_summary">Method</a></li>
68</ul>
69<ul class="subNavList">
70<li>Detail:&nbsp;</li>
71<li><a href="#field_detail">Field</a>&nbsp;|&nbsp;</li>
72<li><a href="#constructor_detail">Constr</a>&nbsp;|&nbsp;</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://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>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://docs.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>&lt;<a href="../../../../com/fasterxml/jackson/annotation/ObjectIdGenerator.html" title="type parameter in ObjectIdGenerator">T</a>&gt;</dd>
104</dl>
105<hr>
106<br>
107<pre>public static final class <span class="strong">ObjectIdGenerator.IdKey</span>
108extends <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>
109implements <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></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">&nbsp;</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://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>
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://docs.oracle.com/javase/6/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a>&lt;?&gt;</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://docs.oracle.com/javase/6/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a>&lt;?&gt;</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">&nbsp;</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,%20java.lang.Class,%20java.lang.Object)">ObjectIdGenerator.IdKey</a></strong>(<a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a>&lt;?&gt;&nbsp;type,
166                       <a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a>&lt;?&gt;&nbsp;scope,
167                       <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>&nbsp;key)</code>&nbsp;</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">&nbsp;</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://docs.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a>&nbsp;o)</code>&nbsp;</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>&nbsp;</td>
191</tr>
192<tr class="altColor">
193<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>
194<td class="colLast"><code><strong><a href="../../../../com/fasterxml/jackson/annotation/ObjectIdGenerator.IdKey.html#toString()">toString</a></strong>()</code>&nbsp;</td>
195</tr>
196</table>
197<ul class="blockList">
198<li class="blockList"><a name="methods_inherited_from_class_java.lang.Object">
199<!--   -->
200</a>
201<h3>Methods inherited from class&nbsp;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>
202<code><a href="http://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="http://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="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>
203</ul>
204</li>
205</ul>
206</li>
207</ul>
208</div>
209<div class="details">
210<ul class="blockList">
211<li class="blockList">
212<!-- ============ FIELD DETAIL =========== -->
213<ul class="blockList">
214<li class="blockList"><a name="field_detail">
215<!--   -->
216</a>
217<h3>Field Detail</h3>
218<a name="type">
219<!--   -->
220</a>
221<ul class="blockList">
222<li class="blockList">
223<h4>type</h4>
224<pre>public final&nbsp;<a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a>&lt;?&gt; type</pre>
225<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>
226</li>
227</ul>
228<a name="scope">
229<!--   -->
230</a>
231<ul class="blockList">
232<li class="blockList">
233<h4>scope</h4>
234<pre>public final&nbsp;<a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a>&lt;?&gt; scope</pre>
235<div class="block">Scope of the Object Id (may be null, to denote global)</div>
236</li>
237</ul>
238<a name="key">
239<!--   -->
240</a>
241<ul class="blockListLast">
242<li class="blockList">
243<h4>key</h4>
244<pre>public final&nbsp;<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> key</pre>
245<div class="block">Object for which Object Id was generated: can NOT be null.</div>
246</li>
247</ul>
248</li>
249</ul>
250<!-- ========= CONSTRUCTOR DETAIL ======== -->
251<ul class="blockList">
252<li class="blockList"><a name="constructor_detail">
253<!--   -->
254</a>
255<h3>Constructor Detail</h3>
256<a name="ObjectIdGenerator.IdKey(java.lang.Class, java.lang.Class, java.lang.Object)">
257<!--   -->
258</a>
259<ul class="blockListLast">
260<li class="blockList">
261<h4>ObjectIdGenerator.IdKey</h4>
262<pre>public&nbsp;ObjectIdGenerator.IdKey(<a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a>&lt;?&gt;&nbsp;type,
263                       <a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a>&lt;?&gt;&nbsp;scope,
264                       <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>&nbsp;key)</pre>
265</li>
266</ul>
267</li>
268</ul>
269<!-- ============ METHOD DETAIL ========== -->
270<ul class="blockList">
271<li class="blockList"><a name="method_detail">
272<!--   -->
273</a>
274<h3>Method Detail</h3>
275<a name="hashCode()">
276<!--   -->
277</a>
278<ul class="blockList">
279<li class="blockList">
280<h4>hashCode</h4>
281<pre>public&nbsp;int&nbsp;hashCode()</pre>
282<dl>
283<dt><strong>Overrides:</strong></dt>
284<dd><code><a href="http://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>&nbsp;in class&nbsp;<code><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></code></dd>
285</dl>
286</li>
287</ul>
288<a name="equals(java.lang.Object)">
289<!--   -->
290</a>
291<ul class="blockList">
292<li class="blockList">
293<h4>equals</h4>
294<pre>public&nbsp;boolean&nbsp;equals(<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>&nbsp;o)</pre>
295<dl>
296<dt><strong>Overrides:</strong></dt>
297<dd><code><a href="http://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>&nbsp;in class&nbsp;<code><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></code></dd>
298</dl>
299</li>
300</ul>
301<a name="toString()">
302<!--   -->
303</a>
304<ul class="blockListLast">
305<li class="blockList">
306<h4>toString</h4>
307<pre>public&nbsp;<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>&nbsp;toString()</pre>
308<dl>
309<dt><strong>Overrides:</strong></dt>
310<dd><code><a href="http://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>&nbsp;in class&nbsp;<code><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></code></dd>
311</dl>
312</li>
313</ul>
314</li>
315</ul>
316</li>
317</ul>
318</div>
319</div>
320<!-- ========= END OF CLASS DATA ========= -->
321<!-- ======= START OF BOTTOM NAVBAR ====== -->
322<div class="bottomNav"><a name="navbar_bottom">
323<!--   -->
324</a><a href="#skip-navbar_bottom" title="Skip navigation links"></a><a name="navbar_bottom_firstrow">
325<!--   -->
326</a>
327<ul class="navList" title="Navigation">
328<li><a href="../../../../com/fasterxml/jackson/annotation/package-summary.html">Package</a></li>
329<li class="navBarCell1Rev">Class</li>
330<li><a href="class-use/ObjectIdGenerator.IdKey.html">Use</a></li>
331<li><a href="package-tree.html">Tree</a></li>
332<li><a href="../../../../deprecated-list.html">Deprecated</a></li>
333<li><a href="../../../../index-all.html">Index</a></li>
334<li><a href="../../../../help-doc.html">Help</a></li>
335</ul>
336</div>
337<div class="subNav">
338<ul class="navList">
339<li><a href="../../../../com/fasterxml/jackson/annotation/ObjectIdGenerator.html" title="class in com.fasterxml.jackson.annotation"><span class="strong">Prev Class</span></a></li>
340<li><a href="../../../../com/fasterxml/jackson/annotation/ObjectIdGenerators.html" title="class in com.fasterxml.jackson.annotation"><span class="strong">Next Class</span></a></li>
341</ul>
342<ul class="navList">
343<li><a href="../../../../index.html?com/fasterxml/jackson/annotation/ObjectIdGenerator.IdKey.html" target="_top">Frames</a></li>
344<li><a href="ObjectIdGenerator.IdKey.html" target="_top">No Frames</a></li>
345</ul>
346<ul class="navList" id="allclasses_navbar_bottom">
347<li><a href="../../../../allclasses-noframe.html">All Classes</a></li>
348</ul>
349<div>
350<script type="text/javascript"><!--
351  allClassesLink = document.getElementById("allclasses_navbar_bottom");
352  if(window==top) {
353    allClassesLink.style.display = "block";
354  }
355  else {
356    allClassesLink.style.display = "none";
357  }
358  //-->
359</script>
360</div>
361<div>
362<ul class="subNavList">
363<li>Summary:&nbsp;</li>
364<li>Nested&nbsp;|&nbsp;</li>
365<li><a href="#field_summary">Field</a>&nbsp;|&nbsp;</li>
366<li><a href="#constructor_summary">Constr</a>&nbsp;|&nbsp;</li>
367<li><a href="#method_summary">Method</a></li>
368</ul>
369<ul class="subNavList">
370<li>Detail:&nbsp;</li>
371<li><a href="#field_detail">Field</a>&nbsp;|&nbsp;</li>
372<li><a href="#constructor_detail">Constr</a>&nbsp;|&nbsp;</li>
373<li><a href="#method_detail">Method</a></li>
374</ul>
375</div>
376<a name="skip-navbar_bottom">
377<!--   -->
378</a></div>
379<!-- ======== END OF BOTTOM NAVBAR ======= -->
380<p class="legalCopy"><small>Copyright &#169; 2008&#x2013;2016 <a href="http://fasterxml.com/">FasterXML</a>. All rights reserved.</small></p>
381</body>
382</html>
383