• 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 (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>ObjectIdGenerators (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="ObjectIdGenerators (Jackson-annotations 2.10.0 API)";
17        }
18    }
19    catch(err) {
20    }
21//-->
22</script>
23<noscript>
24<div>JavaScript is disabled on your browser.</div>
25</noscript>
26<!-- ========= START OF TOP NAVBAR ======= -->
27<div class="topNav"><a name="navbar.top">
28<!--   -->
29</a>
30<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div>
31<a name="navbar.top.firstrow">
32<!--   -->
33</a>
34<ul class="navList" title="Navigation">
35<li><a href="../../../../com/fasterxml/jackson/annotation/package-summary.html">Package</a></li>
36<li class="navBarCell1Rev">Class</li>
37<li><a href="class-use/ObjectIdGenerators.html">Use</a></li>
38<li><a href="package-tree.html">Tree</a></li>
39<li><a href="../../../../deprecated-list.html">Deprecated</a></li>
40<li><a href="../../../../index-all.html">Index</a></li>
41<li><a href="../../../../help-doc.html">Help</a></li>
42</ul>
43</div>
44<div class="subNav">
45<ul class="navList">
46<li><a href="../../../../com/fasterxml/jackson/annotation/ObjectIdGenerator.IdKey.html" title="class in com.fasterxml.jackson.annotation"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
47<li><a href="../../../../com/fasterxml/jackson/annotation/ObjectIdGenerators.IntSequenceGenerator.html" title="class in com.fasterxml.jackson.annotation"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
48</ul>
49<ul class="navList">
50<li><a href="../../../../index.html?com/fasterxml/jackson/annotation/ObjectIdGenerators.html" target="_top">Frames</a></li>
51<li><a href="ObjectIdGenerators.html" target="_top">No&nbsp;Frames</a></li>
52</ul>
53<ul class="navList" id="allclasses_navbar_top">
54<li><a href="../../../../allclasses-noframe.html">All&nbsp;Classes</a></li>
55</ul>
56<div>
57<script type="text/javascript"><!--
58  allClassesLink = document.getElementById("allclasses_navbar_top");
59  if(window==top) {
60    allClassesLink.style.display = "block";
61  }
62  else {
63    allClassesLink.style.display = "none";
64  }
65  //-->
66</script>
67</div>
68<div>
69<ul class="subNavList">
70<li>Summary:&nbsp;</li>
71<li><a href="#nested.class.summary">Nested</a>&nbsp;|&nbsp;</li>
72<li>Field&nbsp;|&nbsp;</li>
73<li><a href="#constructor.summary">Constr</a>&nbsp;|&nbsp;</li>
74<li><a href="#methods.inherited.from.class.java.lang.Object">Method</a></li>
75</ul>
76<ul class="subNavList">
77<li>Detail:&nbsp;</li>
78<li>Field&nbsp;|&nbsp;</li>
79<li><a href="#constructor.detail">Constr</a>&nbsp;|&nbsp;</li>
80<li>Method</li>
81</ul>
82</div>
83<a name="skip.navbar.top">
84<!--   -->
85</a></div>
86<!-- ========= END OF TOP NAVBAR ========= -->
87<!-- ======== START OF CLASS DATA ======== -->
88<div class="header">
89<div class="subTitle">com.fasterxml.jackson.annotation</div>
90<h2 title="Class ObjectIdGenerators" class="title">Class ObjectIdGenerators</h2>
91</div>
92<div class="contentContainer">
93<ul class="inheritance">
94<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>
95<li>
96<ul class="inheritance">
97<li>com.fasterxml.jackson.annotation.ObjectIdGenerators</li>
98</ul>
99</li>
100</ul>
101<div class="description">
102<ul class="blockList">
103<li class="blockList">
104<hr>
105<br>
106<pre>public class <span class="typeNameLabel">ObjectIdGenerators</span>
107extends <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></pre>
108<div class="block">Container class for standard <a href="../../../../com/fasterxml/jackson/annotation/ObjectIdGenerator.html" title="class in com.fasterxml.jackson.annotation"><code>ObjectIdGenerator</code></a> implementations:
109<ul>
110  <li><a href="../../../../com/fasterxml/jackson/annotation/ObjectIdGenerators.IntSequenceGenerator.html" title="class in com.fasterxml.jackson.annotation"><code>ObjectIdGenerators.IntSequenceGenerator</code></a>
111  <li><a href="../../../../com/fasterxml/jackson/annotation/ObjectIdGenerators.PropertyGenerator.html" title="class in com.fasterxml.jackson.annotation"><code>ObjectIdGenerators.PropertyGenerator</code></a>
112  <li><a href="../../../../com/fasterxml/jackson/annotation/ObjectIdGenerators.StringIdGenerator.html" title="class in com.fasterxml.jackson.annotation"><code>ObjectIdGenerators.StringIdGenerator</code></a> (since 2.7)
113  <li><a href="../../../../com/fasterxml/jackson/annotation/ObjectIdGenerators.UUIDGenerator.html" title="class in com.fasterxml.jackson.annotation"><code>ObjectIdGenerators.UUIDGenerator</code></a>
114</ul>
115<p>
116 NOTE: <a href="../../../../com/fasterxml/jackson/annotation/ObjectIdGenerators.PropertyGenerator.html" title="class in com.fasterxml.jackson.annotation"><code>ObjectIdGenerators.PropertyGenerator</code></a> applicability is limited in one case: it can only
117 be used on polymorphic base types (ones indicated using <a href="../../../../com/fasterxml/jackson/annotation/JsonTypeInfo.html" title="annotation in com.fasterxml.jackson.annotation"><code>JsonTypeInfo</code></a> or
118 default typing) via class annotations: property annotation will fail due to lack
119 of access to property, needed to determine type of Object Id for deserialization.
120 This limitation may be lifted in future versions but it is the limitation at least
121 up to and including Jackson 2.9.</div>
122</li>
123</ul>
124</div>
125<div class="summary">
126<ul class="blockList">
127<li class="blockList">
128<!-- ======== NESTED CLASS SUMMARY ======== -->
129<ul class="blockList">
130<li class="blockList"><a name="nested.class.summary">
131<!--   -->
132</a>
133<h3>Nested Class Summary</h3>
134<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Nested Class Summary table, listing nested classes, and an explanation">
135<caption><span>Nested Classes</span><span class="tabEnd">&nbsp;</span></caption>
136<tr>
137<th class="colFirst" scope="col">Modifier and Type</th>
138<th class="colLast" scope="col">Class and Description</th>
139</tr>
140<tr class="altColor">
141<td class="colFirst"><code>static class&nbsp;</code></td>
142<td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/fasterxml/jackson/annotation/ObjectIdGenerators.IntSequenceGenerator.html" title="class in com.fasterxml.jackson.annotation">ObjectIdGenerators.IntSequenceGenerator</a></span></code>
143<div class="block">Simple sequence-number based generator, which uses basic Java
144 <code>int</code>s (starting with value 1) as Object Identifiers.</div>
145</td>
146</tr>
147<tr class="rowColor">
148<td class="colFirst"><code>static class&nbsp;</code></td>
149<td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/fasterxml/jackson/annotation/ObjectIdGenerators.None.html" title="class in com.fasterxml.jackson.annotation">ObjectIdGenerators.None</a></span></code>
150<div class="block">Abstract marker class used to allow explicitly specifying
151 that no generator is used; which also implies that no
152 Object Id is to be included or used.</div>
153</td>
154</tr>
155<tr class="altColor">
156<td class="colFirst"><code>static class&nbsp;</code></td>
157<td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/fasterxml/jackson/annotation/ObjectIdGenerators.PropertyGenerator.html" title="class in com.fasterxml.jackson.annotation">ObjectIdGenerators.PropertyGenerator</a></span></code>
158<div class="block">Abstract place-holder class which is used to denote case
159 where Object Identifier to use comes from a POJO property
160 (getter method or field).</div>
161</td>
162</tr>
163<tr class="rowColor">
164<td class="colFirst"><code>static class&nbsp;</code></td>
165<td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/fasterxml/jackson/annotation/ObjectIdGenerators.StringIdGenerator.html" title="class in com.fasterxml.jackson.annotation">ObjectIdGenerators.StringIdGenerator</a></span></code>
166<div class="block">Implementation that will accept arbitrary (but unique) String Ids on
167 deserialization, and (by default) use random UUID generation similar
168 to <a href="../../../../com/fasterxml/jackson/annotation/ObjectIdGenerators.UUIDGenerator.html" title="class in com.fasterxml.jackson.annotation"><code>ObjectIdGenerators.UUIDGenerator</code></a> for generation ids.</div>
169</td>
170</tr>
171<tr class="altColor">
172<td class="colFirst"><code>static class&nbsp;</code></td>
173<td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/fasterxml/jackson/annotation/ObjectIdGenerators.UUIDGenerator.html" title="class in com.fasterxml.jackson.annotation">ObjectIdGenerators.UUIDGenerator</a></span></code>
174<div class="block">Implementation that just uses <a href="https://docs.oracle.com/javase/6/docs/api/java/util/UUID.html?is-external=true" title="class or interface in java.util"><code>UUID</code></a>s as reliably
175 unique identifiers: downside is that resulting String is
176 36 characters long.</div>
177</td>
178</tr>
179</table>
180</li>
181</ul>
182<!-- ======== CONSTRUCTOR SUMMARY ======== -->
183<ul class="blockList">
184<li class="blockList"><a name="constructor.summary">
185<!--   -->
186</a>
187<h3>Constructor Summary</h3>
188<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation">
189<caption><span>Constructors</span><span class="tabEnd">&nbsp;</span></caption>
190<tr>
191<th class="colOne" scope="col">Constructor and Description</th>
192</tr>
193<tr class="altColor">
194<td class="colOne"><code><span class="memberNameLink"><a href="../../../../com/fasterxml/jackson/annotation/ObjectIdGenerators.html#ObjectIdGenerators--">ObjectIdGenerators</a></span>()</code>&nbsp;</td>
195</tr>
196</table>
197</li>
198</ul>
199<!-- ========== METHOD SUMMARY =========== -->
200<ul class="blockList">
201<li class="blockList"><a name="method.summary">
202<!--   -->
203</a>
204<h3>Method Summary</h3>
205<ul class="blockList">
206<li class="blockList"><a name="methods.inherited.from.class.java.lang.Object">
207<!--   -->
208</a>
209<h3>Methods inherited from class&nbsp;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>
210<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#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/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#hashCode--" title="class or interface in java.lang">hashCode</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#toString--" title="class or interface in java.lang">toString</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>
211</ul>
212</li>
213</ul>
214</li>
215</ul>
216</div>
217<div class="details">
218<ul class="blockList">
219<li class="blockList">
220<!-- ========= CONSTRUCTOR DETAIL ======== -->
221<ul class="blockList">
222<li class="blockList"><a name="constructor.detail">
223<!--   -->
224</a>
225<h3>Constructor Detail</h3>
226<a name="ObjectIdGenerators--">
227<!--   -->
228</a>
229<ul class="blockListLast">
230<li class="blockList">
231<h4>ObjectIdGenerators</h4>
232<pre>public&nbsp;ObjectIdGenerators()</pre>
233</li>
234</ul>
235</li>
236</ul>
237</li>
238</ul>
239</div>
240</div>
241<!-- ========= END OF CLASS DATA ========= -->
242<!-- ======= START OF BOTTOM NAVBAR ====== -->
243<div class="bottomNav"><a name="navbar.bottom">
244<!--   -->
245</a>
246<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
247<a name="navbar.bottom.firstrow">
248<!--   -->
249</a>
250<ul class="navList" title="Navigation">
251<li><a href="../../../../com/fasterxml/jackson/annotation/package-summary.html">Package</a></li>
252<li class="navBarCell1Rev">Class</li>
253<li><a href="class-use/ObjectIdGenerators.html">Use</a></li>
254<li><a href="package-tree.html">Tree</a></li>
255<li><a href="../../../../deprecated-list.html">Deprecated</a></li>
256<li><a href="../../../../index-all.html">Index</a></li>
257<li><a href="../../../../help-doc.html">Help</a></li>
258</ul>
259</div>
260<div class="subNav">
261<ul class="navList">
262<li><a href="../../../../com/fasterxml/jackson/annotation/ObjectIdGenerator.IdKey.html" title="class in com.fasterxml.jackson.annotation"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
263<li><a href="../../../../com/fasterxml/jackson/annotation/ObjectIdGenerators.IntSequenceGenerator.html" title="class in com.fasterxml.jackson.annotation"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
264</ul>
265<ul class="navList">
266<li><a href="../../../../index.html?com/fasterxml/jackson/annotation/ObjectIdGenerators.html" target="_top">Frames</a></li>
267<li><a href="ObjectIdGenerators.html" target="_top">No&nbsp;Frames</a></li>
268</ul>
269<ul class="navList" id="allclasses_navbar_bottom">
270<li><a href="../../../../allclasses-noframe.html">All&nbsp;Classes</a></li>
271</ul>
272<div>
273<script type="text/javascript"><!--
274  allClassesLink = document.getElementById("allclasses_navbar_bottom");
275  if(window==top) {
276    allClassesLink.style.display = "block";
277  }
278  else {
279    allClassesLink.style.display = "none";
280  }
281  //-->
282</script>
283</div>
284<div>
285<ul class="subNavList">
286<li>Summary:&nbsp;</li>
287<li><a href="#nested.class.summary">Nested</a>&nbsp;|&nbsp;</li>
288<li>Field&nbsp;|&nbsp;</li>
289<li><a href="#constructor.summary">Constr</a>&nbsp;|&nbsp;</li>
290<li><a href="#methods.inherited.from.class.java.lang.Object">Method</a></li>
291</ul>
292<ul class="subNavList">
293<li>Detail:&nbsp;</li>
294<li>Field&nbsp;|&nbsp;</li>
295<li><a href="#constructor.detail">Constr</a>&nbsp;|&nbsp;</li>
296<li>Method</li>
297</ul>
298</div>
299<a name="skip.navbar.bottom">
300<!--   -->
301</a></div>
302<!-- ======== END OF BOTTOM NAVBAR ======= -->
303<p class="legalCopy"><small>Copyright &#169; 2008&#x2013;2019 <a href="http://fasterxml.com/">FasterXML</a>. All rights reserved.</small></p>
304</body>
305</html>
306