1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
|
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc (version 1.7.0_25) on Tue Dec 03 13:53:42 PST 2013 -->
<meta http-equiv="Content-Type" content="text/html" charset="UTF-8">
<title>BelatedCreator (Carbonado 1.2.3 API)</title>
<meta name="date" content="2013-12-03">
<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style">
</head>
<body>
<script type="text/javascript"><!--
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="BelatedCreator (Carbonado 1.2.3 API)";
}
//-->
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="topNav"><a name="navbar_top">
<!-- -->
</a><a href="#skip-navbar_top" title="Skip navigation links"></a><a name="navbar_top_firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../overview-summary.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="class-use/BelatedCreator.html">Use</a></li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../../index-files/index-1.html">Index</a></li>
<li><a href="../../../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../../../com/amazon/carbonado/util/BelatedCreationException.html" title="class in com.amazon.carbonado.util"><span class="strong">Prev Class</span></a></li>
<li><a href="../../../../com/amazon/carbonado/util/Comparators.html" title="class in com.amazon.carbonado.util"><span class="strong">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../index.html?com/amazon/carbonado/util/BelatedCreator.html" target="_top">Frames</a></li>
<li><a href="BelatedCreator.html" target="_top">No Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_top">
<li><a href="../../../../allclasses-noframe.html">All Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_top");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
</div>
<div>
<ul class="subNavList">
<li>Summary: </li>
<li>Nested | </li>
<li>Field | </li>
<li><a href="#constructor_summary">Constr</a> | </li>
<li><a href="#method_summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail: </li>
<li>Field | </li>
<li><a href="#constructor_detail">Constr</a> | </li>
<li><a href="#method_detail">Method</a></li>
</ul>
</div>
<a name="skip-navbar_top">
<!-- -->
</a></div>
<!-- ========= END OF TOP NAVBAR ========= -->
<!-- ======== START OF CLASS DATA ======== -->
<div class="header">
<div class="subTitle">com.amazon.carbonado.util</div>
<h2 title="Class BelatedCreator" class="title">Class BelatedCreator<T,E extends java.lang.Exception></h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li>java.lang.Object</li>
<li>
<ul class="inheritance">
<li>com.amazon.carbonado.util.BelatedCreator<T,E></li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>Direct Known Subclasses:</dt>
<dd><a href="../../../../com/amazon/carbonado/spi/BelatedRepositoryCreator.html" title="class in com.amazon.carbonado.spi">BelatedRepositoryCreator</a>, <a href="../../../../com/amazon/carbonado/spi/BelatedStorageCreator.html" title="class in com.amazon.carbonado.spi">BelatedStorageCreator</a></dd>
</dl>
<hr>
<br>
<pre>public abstract class <span class="strong">BelatedCreator<T,E extends java.lang.Exception></span>
extends java.lang.Object</pre>
<div class="block">Generic one-shot factory which supports late object creation. If the object
creation results in an exception or is taking too long, the object produced
instead is a bogus one. After retrying, if the real object is created, then
the bogus object turns into a wrapper to the real object.
<p>Note: If a bogus object is created, the wrapper cannot always be a drop-in
replacement for the real object. If the wrapper is cloned, it won't have the
same behavior as cloning the real object. Also, synchronizing on the wrapper
will not synchronize the real object.</div>
<dl><dt><span class="strong">Author:</span></dt>
<dd>Brian S O'Neill</dd></dl>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor_summary">
<!-- -->
</a>
<h3>Constructor Summary</h3>
<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation">
<caption><span>Constructors</span><span class="tabEnd"> </span></caption>
<tr>
<th class="colFirst" scope="col">Modifier</th>
<th class="colLast" scope="col">Constructor and Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code>protected </code></td>
<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/util/BelatedCreator.html#BelatedCreator(java.lang.Class, int)">BelatedCreator</a></strong>(java.lang.Class<<a href="../../../../com/amazon/carbonado/util/BelatedCreator.html" title="type parameter in BelatedCreator">T</a>> type,
int minRetryDelayMillis)</code> </td>
</tr>
</table>
</li>
</ul>
<!-- ========== METHOD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="method_summary">
<!-- -->
</a>
<h3>Method Summary</h3>
<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
<caption><span>Methods</span><span class="tabEnd"> </span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Method and Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code>protected abstract <a href="../../../../com/amazon/carbonado/util/BelatedCreator.html" title="type parameter in BelatedCreator">T</a></code></td>
<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/util/BelatedCreator.html#createBogus()">createBogus</a></strong>()</code>
<div class="block">Create instance of bogus object.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>protected void</code></td>
<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/util/BelatedCreator.html#createdNotification(T)">createdNotification</a></strong>(<a href="../../../../com/amazon/carbonado/util/BelatedCreator.html" title="type parameter in BelatedCreator">T</a> object)</code>
<div class="block">Notification that createReal has produced the real object.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>protected abstract <a href="../../../../com/amazon/carbonado/util/BelatedCreator.html" title="type parameter in BelatedCreator">T</a></code></td>
<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/util/BelatedCreator.html#createReal()">createReal</a></strong>()</code>
<div class="block">Create instance of real object.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/util/BelatedCreator.html" title="type parameter in BelatedCreator">T</a></code></td>
<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/util/BelatedCreator.html#get(int)">get</a></strong>(int timeoutMillis)</code>
<div class="block">Returns real or bogus object.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>protected abstract void</code></td>
<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/util/BelatedCreator.html#timedOutNotification(long)">timedOutNotification</a></strong>(long timedOutMillis)</code>
<div class="block">Notification that createReal is taking too long.</div>
</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a name="methods_inherited_from_class_java.lang.Object">
<!-- -->
</a>
<h3>Methods inherited from class java.lang.Object</h3>
<code>clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</code></li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor_detail">
<!-- -->
</a>
<h3>Constructor Detail</h3>
<a name="BelatedCreator(java.lang.Class, int)">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>BelatedCreator</h4>
<pre>protected BelatedCreator(java.lang.Class<<a href="../../../../com/amazon/carbonado/util/BelatedCreator.html" title="type parameter in BelatedCreator">T</a>> type,
int minRetryDelayMillis)</pre>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>type</code> - type of object created</dd><dd><code>minRetryDelayMillis</code> - minimum milliseconds to wait before retrying
to create object after failure; if negative, never retry</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code>java.lang.IllegalArgumentException</code> - if type is null or is not an interface</dd></dl>
</li>
</ul>
</li>
</ul>
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method_detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="get(int)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>get</h4>
<pre>public <a href="../../../../com/amazon/carbonado/util/BelatedCreator.html" title="type parameter in BelatedCreator">T</a> get(int timeoutMillis)
throws <a href="../../../../com/amazon/carbonado/util/BelatedCreator.html" title="type parameter in BelatedCreator">E</a> extends java.lang.Exception</pre>
<div class="block">Returns real or bogus object. If real object is returned, then future
invocations of this method return the same real object instance. This
method waits for the real object to be created, if it is blocked. If
real object creation fails immediately, then this method will not wait,
returning a bogus object immediately instead.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>timeoutMillis</code> - maximum time to wait for real object before
returning bogus one; if negative, potentially wait forever</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code>E</code> - exception thrown from createReal</dd>
<dd><code><a href="../../../../com/amazon/carbonado/util/BelatedCreator.html" title="type parameter in BelatedCreator">E</a> extends java.lang.Exception</code></dd></dl>
</li>
</ul>
<a name="createReal()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>createReal</h4>
<pre>protected abstract <a href="../../../../com/amazon/carbonado/util/BelatedCreator.html" title="type parameter in BelatedCreator">T</a> createReal()
throws <a href="../../../../com/amazon/carbonado/util/BelatedCreator.html" title="type parameter in BelatedCreator">E</a> extends java.lang.Exception</pre>
<div class="block">Create instance of real object. If there is a recoverable error creating
the object, return null. Any error logging must be performed by the
implementation of this method. If null is returned, expect this method
to be called again in the future.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>real object, or null if there was a recoverable error</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code>E</code> - unrecoverable error</dd>
<dd><code><a href="../../../../com/amazon/carbonado/util/BelatedCreator.html" title="type parameter in BelatedCreator">E</a> extends java.lang.Exception</code></dd></dl>
</li>
</ul>
<a name="createBogus()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>createBogus</h4>
<pre>protected abstract <a href="../../../../com/amazon/carbonado/util/BelatedCreator.html" title="type parameter in BelatedCreator">T</a> createBogus()</pre>
<div class="block">Create instance of bogus object.</div>
</li>
</ul>
<a name="timedOutNotification(long)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>timedOutNotification</h4>
<pre>protected abstract void timedOutNotification(long timedOutMillis)</pre>
<div class="block">Notification that createReal is taking too long. This can be used to log
a message.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>timedOutMillis</code> - milliseconds waited before giving up</dd></dl>
</li>
</ul>
<a name="createdNotification(java.lang.Object)">
<!-- -->
</a><a name="createdNotification(T)">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>createdNotification</h4>
<pre>protected void createdNotification(<a href="../../../../com/amazon/carbonado/util/BelatedCreator.html" title="type parameter in BelatedCreator">T</a> object)</pre>
<div class="block">Notification that createReal has produced the real object. The default
implementation does nothing.</div>
</li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
</div>
<!-- ========= END OF CLASS DATA ========= -->
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<div class="bottomNav"><a name="navbar_bottom">
<!-- -->
</a><a href="#skip-navbar_bottom" title="Skip navigation links"></a><a name="navbar_bottom_firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../overview-summary.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="class-use/BelatedCreator.html">Use</a></li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../../index-files/index-1.html">Index</a></li>
<li><a href="../../../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../../../com/amazon/carbonado/util/BelatedCreationException.html" title="class in com.amazon.carbonado.util"><span class="strong">Prev Class</span></a></li>
<li><a href="../../../../com/amazon/carbonado/util/Comparators.html" title="class in com.amazon.carbonado.util"><span class="strong">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../index.html?com/amazon/carbonado/util/BelatedCreator.html" target="_top">Frames</a></li>
<li><a href="BelatedCreator.html" target="_top">No Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_bottom">
<li><a href="../../../../allclasses-noframe.html">All Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_bottom");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
</div>
<div>
<ul class="subNavList">
<li>Summary: </li>
<li>Nested | </li>
<li>Field | </li>
<li><a href="#constructor_summary">Constr</a> | </li>
<li><a href="#method_summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail: </li>
<li>Field | </li>
<li><a href="#constructor_detail">Constr</a> | </li>
<li><a href="#method_detail">Method</a></li>
</ul>
</div>
<a name="skip-navbar_bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
<p class="legalCopy"><small>Copyright © 2006-2013 <a href="https://github.com/Carbonado/Carbonado">Amazon Technologies, Inc.</a>. All Rights Reserved.</small></p>
</body>
</html>
|
