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
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
|
<!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:43 PST 2013 -->
<meta http-equiv="Content-Type" content="text/html" charset="UTF-8">
<title>SyntheticStorableBuilder (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="SyntheticStorableBuilder (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/SyntheticStorableBuilder.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/synthetic/SyntheticPropertyList.html" title="class in com.amazon.carbonado.synthetic"><span class="strong">Prev Class</span></a></li>
<li><a href="../../../../com/amazon/carbonado/synthetic/SyntheticStorableReferenceAccess.html" title="class in com.amazon.carbonado.synthetic"><span class="strong">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../index.html?com/amazon/carbonado/synthetic/SyntheticStorableBuilder.html" target="_top">Frames</a></li>
<li><a href="SyntheticStorableBuilder.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.synthetic</div>
<h2 title="Class SyntheticStorableBuilder" class="title">Class SyntheticStorableBuilder</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li>java.lang.Object</li>
<li>
<ul class="inheritance">
<li>com.amazon.carbonado.synthetic.SyntheticStorableBuilder</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>All Implemented Interfaces:</dt>
<dd><a href="../../../../com/amazon/carbonado/synthetic/SyntheticBuilder.html" title="interface in com.amazon.carbonado.synthetic">SyntheticBuilder</a></dd>
</dl>
<hr>
<br>
<pre>public class <span class="strong">SyntheticStorableBuilder</span>
extends java.lang.Object
implements <a href="../../../../com/amazon/carbonado/synthetic/SyntheticBuilder.html" title="interface in com.amazon.carbonado.synthetic">SyntheticBuilder</a></pre>
<div class="block">Allows the definition of very simple synthetic storables. Only a primary key
index can be defined; at least one property must be a primary key property. A
property can be nullable and can be specified as the version property.
This class acts both as builder factory and as builder.</div>
<dl><dt><span class="strong">Author:</span></dt>
<dd>Don Schneider, Brian S O'Neill, David Rosenstrauch</dd></dl>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- ======== NESTED CLASS SUMMARY ======== -->
<ul class="blockList">
<li class="blockList"><a name="nested_class_summary">
<!-- -->
</a>
<h3>Nested Class Summary</h3>
<ul class="blockList">
<li class="blockList"><a name="nested_classes_inherited_from_class_com.amazon.carbonado.synthetic.SyntheticBuilder">
<!-- -->
</a>
<h3>Nested classes/interfaces inherited from interface com.amazon.carbonado.synthetic.<a href="../../../../com/amazon/carbonado/synthetic/SyntheticBuilder.html" title="interface in com.amazon.carbonado.synthetic">SyntheticBuilder</a></h3>
<code><a href="../../../../com/amazon/carbonado/synthetic/SyntheticBuilder.ClassNameProvider.html" title="interface in com.amazon.carbonado.synthetic">SyntheticBuilder.ClassNameProvider</a></code></li>
</ul>
</li>
</ul>
<!-- ======== 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="colOne" scope="col">Constructor and Description</th>
</tr>
<tr class="altColor">
<td class="colOne"><code><strong><a href="../../../../com/amazon/carbonado/synthetic/SyntheticStorableBuilder.html#SyntheticStorableBuilder(java.lang.String, java.lang.ClassLoader)">SyntheticStorableBuilder</a></strong>(java.lang.String name,
java.lang.ClassLoader loader)</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><a href="../../../../com/amazon/carbonado/synthetic/SyntheticKey.html" title="class in com.amazon.carbonado.synthetic">SyntheticKey</a></code></td>
<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/synthetic/SyntheticStorableBuilder.html#addAlternateKey()">addAlternateKey</a></strong>()</code>
<div class="block">Add an alternate key to be built.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/synthetic/SyntheticIndex.html" title="class in com.amazon.carbonado.synthetic">SyntheticIndex</a></code></td>
<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/synthetic/SyntheticStorableBuilder.html#addIndex()">addIndex</a></strong>()</code>
<div class="block">Add an index to the set managed by this builder.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/synthetic/SyntheticKey.html" title="class in com.amazon.carbonado.synthetic">SyntheticKey</a></code></td>
<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/synthetic/SyntheticStorableBuilder.html#addPrimaryKey()">addPrimaryKey</a></strong>()</code>
<div class="block">Add a primary key to be built.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/synthetic/SyntheticProperty.html" title="class in com.amazon.carbonado.synthetic">SyntheticProperty</a></code></td>
<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/synthetic/SyntheticStorableBuilder.html#addProperty(java.lang.String, java.lang.Class)">addProperty</a></strong>(java.lang.String name,
java.lang.Class type)</code>
<div class="block">Add a property to the set managed by this builder.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/synthetic/SyntheticProperty.html" title="class in com.amazon.carbonado.synthetic">SyntheticProperty</a></code></td>
<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/synthetic/SyntheticStorableBuilder.html#addProperty(com.amazon.carbonado.synthetic.SyntheticProperty)">addProperty</a></strong>(<a href="../../../../com/amazon/carbonado/synthetic/SyntheticProperty.html" title="class in com.amazon.carbonado.synthetic">SyntheticProperty</a> prop)</code>
<div class="block">Add an externally defined synthetic property to the list</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>java.lang.Class<? extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>></code></td>
<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/synthetic/SyntheticStorableBuilder.html#build()">build</a></strong>()</code>
<div class="block">Convenience method to generate the class.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>protected boolean</code></td>
<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/synthetic/SyntheticStorableBuilder.html#definePropertyBeanMethods(org.cojen.classfile.ClassFile, com.amazon.carbonado.synthetic.SyntheticProperty)">definePropertyBeanMethods</a></strong>(org.cojen.classfile.ClassFile cf,
<a href="../../../../com/amazon/carbonado/synthetic/SyntheticProperty.html" title="class in com.amazon.carbonado.synthetic">SyntheticProperty</a> property)</code>
<div class="block">Add the get & set methods for this property</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/synthetic/SyntheticBuilder.ClassNameProvider.html" title="interface in com.amazon.carbonado.synthetic">SyntheticBuilder.ClassNameProvider</a></code></td>
<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/synthetic/SyntheticStorableBuilder.html#getClassNameProvider()">getClassNameProvider</a></strong>()</code> </td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>protected java.lang.String</code></td>
<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/synthetic/SyntheticStorableBuilder.html#getName()">getName</a></strong>()</code>
<div class="block">Frequently used by the <a href="../../../../com/amazon/carbonado/synthetic/SyntheticBuilder.ClassNameProvider.html" title="interface in com.amazon.carbonado.synthetic"><code>SyntheticBuilder.ClassNameProvider</code></a> as a
basis for the generated classname</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>protected java.util.List<<a href="../../../../com/amazon/carbonado/synthetic/SyntheticProperty.html" title="class in com.amazon.carbonado.synthetic">SyntheticProperty</a>></code></td>
<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/synthetic/SyntheticStorableBuilder.html#getPropertyList()">getPropertyList</a></strong>()</code>
<div class="block">Frequently used by the <a href="../../../../com/amazon/carbonado/synthetic/SyntheticBuilder.ClassNameProvider.html" title="interface in com.amazon.carbonado.synthetic"><code>SyntheticBuilder.ClassNameProvider</code></a> as a
basis for the generated classname</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>java.lang.Class<? extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>></code></td>
<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/synthetic/SyntheticStorableBuilder.html#getStorableClass()">getStorableClass</a></strong>()</code> </td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/synthetic/SyntheticStorableBuilder.html#hasProperty(java.lang.String)">hasProperty</a></strong>(java.lang.String name)</code>
<div class="block">Check to see if a particular property has already been added to the list of
properties to generate</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/synthetic/SyntheticStorableBuilder.html#isVersioned()">isVersioned</a></strong>()</code>
<div class="block">Returns true if a property with the version attribute has been addded</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/synthetic/ClassFileBuilder.html" title="class in com.amazon.carbonado.synthetic">ClassFileBuilder</a></code></td>
<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/synthetic/SyntheticStorableBuilder.html#prepare()">prepare</a></strong>()</code> </td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/synthetic/SyntheticStorableBuilder.html#setClassNameProvider(com.amazon.carbonado.synthetic.SyntheticBuilder.ClassNameProvider)">setClassNameProvider</a></strong>(<a href="../../../../com/amazon/carbonado/synthetic/SyntheticBuilder.ClassNameProvider.html" title="interface in com.amazon.carbonado.synthetic">SyntheticBuilder.ClassNameProvider</a> classNameProvider)</code> </td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/synthetic/SyntheticStorableBuilder.html#setEvolvable(boolean)">setEvolvable</a></strong>(boolean evolvable)</code>
<div class="block">By default, generated storable implements the Unevolvable marker
interface, which can affect how it is encoded.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>java.lang.String</code></td>
<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/synthetic/SyntheticStorableBuilder.html#toString()">toString</a></strong>()</code> </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, 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="SyntheticStorableBuilder(java.lang.String, java.lang.ClassLoader)">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>SyntheticStorableBuilder</h4>
<pre>public SyntheticStorableBuilder(java.lang.String name,
java.lang.ClassLoader loader)</pre>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>name</code> - base name for the generated class. This is usually a fully qualified
name, a la "com.amazon.carbonado.storables.happy.synthetic.storable"</dd><dd><code>loader</code> - <code>ClassLoader</code> to use for the generated class</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="prepare()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>prepare</h4>
<pre>public <a href="../../../../com/amazon/carbonado/synthetic/ClassFileBuilder.html" title="class in com.amazon.carbonado.synthetic">ClassFileBuilder</a> prepare()
throws <a href="../../../../com/amazon/carbonado/SupportException.html" title="class in com.amazon.carbonado">SupportException</a></pre>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code><a href="../../../../com/amazon/carbonado/synthetic/SyntheticBuilder.html#prepare()">prepare</a></code> in interface <code><a href="../../../../com/amazon/carbonado/synthetic/SyntheticBuilder.html" title="interface in com.amazon.carbonado.synthetic">SyntheticBuilder</a></code></dd>
<dt><span class="strong">Returns:</span></dt><dd><a href="../../../../com/amazon/carbonado/synthetic/ClassFileBuilder.html" title="class in com.amazon.carbonado.synthetic"><code>ClassFileBuilder</code></a> ready for further decoration or building</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code><a href="../../../../com/amazon/carbonado/SupportException.html" title="class in com.amazon.carbonado">SupportException</a></code></dd></dl>
</li>
</ul>
<a name="getStorableClass()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getStorableClass</h4>
<pre>public java.lang.Class<? extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>> getStorableClass()</pre>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code><a href="../../../../com/amazon/carbonado/synthetic/SyntheticBuilder.html#getStorableClass()">getStorableClass</a></code> in interface <code><a href="../../../../com/amazon/carbonado/synthetic/SyntheticBuilder.html" title="interface in com.amazon.carbonado.synthetic">SyntheticBuilder</a></code></dd>
<dt><span class="strong">Returns:</span></dt><dd>the generated class file for this builder. Note that
proper operation requires that <a href="../../../../com/amazon/carbonado/synthetic/SyntheticBuilder.html#prepare()"><code>SyntheticBuilder.prepare()</code></a> already have been called
prior to calling this method.</dd></dl>
</li>
</ul>
<a name="build()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>build</h4>
<pre>public java.lang.Class<? extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>> build()
throws <a href="../../../../com/amazon/carbonado/SupportException.html" title="class in com.amazon.carbonado">SupportException</a></pre>
<div class="block"><strong>Description copied from interface: <code><a href="../../../../com/amazon/carbonado/synthetic/SyntheticBuilder.html#build()">SyntheticBuilder</a></code></strong></div>
<div class="block">Convenience method to generate the class.
Build will always call <a href="../../../../com/amazon/carbonado/synthetic/SyntheticBuilder.html#prepare()"><code>SyntheticBuilder.prepare()</code></a> and return the result of
generating the class from that classfile. If the caller does not
wish to regenerate the class from scratch, use <a href="../../../../com/amazon/carbonado/synthetic/SyntheticBuilder.html#getStorableClass()"><code>SyntheticBuilder.getStorableClass()</code></a> instead.</div>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code><a href="../../../../com/amazon/carbonado/synthetic/SyntheticBuilder.html#build()">build</a></code> in interface <code><a href="../../../../com/amazon/carbonado/synthetic/SyntheticBuilder.html" title="interface in com.amazon.carbonado.synthetic">SyntheticBuilder</a></code></dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code><a href="../../../../com/amazon/carbonado/SupportException.html" title="class in com.amazon.carbonado">SupportException</a></code></dd></dl>
</li>
</ul>
<a name="addProperty(java.lang.String, java.lang.Class)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>addProperty</h4>
<pre>public <a href="../../../../com/amazon/carbonado/synthetic/SyntheticProperty.html" title="class in com.amazon.carbonado.synthetic">SyntheticProperty</a> addProperty(java.lang.String name,
java.lang.Class type)</pre>
<div class="block"><strong>Description copied from interface: <code><a href="../../../../com/amazon/carbonado/synthetic/SyntheticBuilder.html#addProperty(java.lang.String, java.lang.Class)">SyntheticBuilder</a></code></strong></div>
<div class="block">Add a property to the set managed by this builder.</div>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code><a href="../../../../com/amazon/carbonado/synthetic/SyntheticBuilder.html#addProperty(java.lang.String, java.lang.Class)">addProperty</a></code> in interface <code><a href="../../../../com/amazon/carbonado/synthetic/SyntheticBuilder.html" title="interface in com.amazon.carbonado.synthetic">SyntheticBuilder</a></code></dd>
<dt><span class="strong">Parameters:</span></dt><dd><code>name</code> - of the property</dd><dd><code>type</code> - of the property</dd>
<dt><span class="strong">Returns:</span></dt><dd>property specification which can be further refined</dd></dl>
</li>
</ul>
<a name="addProperty(com.amazon.carbonado.synthetic.SyntheticProperty)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>addProperty</h4>
<pre>public <a href="../../../../com/amazon/carbonado/synthetic/SyntheticProperty.html" title="class in com.amazon.carbonado.synthetic">SyntheticProperty</a> addProperty(<a href="../../../../com/amazon/carbonado/synthetic/SyntheticProperty.html" title="class in com.amazon.carbonado.synthetic">SyntheticProperty</a> prop)</pre>
<div class="block"><strong>Description copied from interface: <code><a href="../../../../com/amazon/carbonado/synthetic/SyntheticBuilder.html#addProperty(com.amazon.carbonado.synthetic.SyntheticProperty)">SyntheticBuilder</a></code></strong></div>
<div class="block">Add an externally defined synthetic property to the list</div>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code><a href="../../../../com/amazon/carbonado/synthetic/SyntheticBuilder.html#addProperty(com.amazon.carbonado.synthetic.SyntheticProperty)">addProperty</a></code> in interface <code><a href="../../../../com/amazon/carbonado/synthetic/SyntheticBuilder.html" title="interface in com.amazon.carbonado.synthetic">SyntheticBuilder</a></code></dd>
<dt><span class="strong">Parameters:</span></dt><dd><code>prop</code> - to add</dd>
<dt><span class="strong">Returns:</span></dt><dd>original synthetic property as a convenience</dd></dl>
</li>
</ul>
<a name="hasProperty(java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>hasProperty</h4>
<pre>public boolean hasProperty(java.lang.String name)</pre>
<div class="block"><strong>Description copied from interface: <code><a href="../../../../com/amazon/carbonado/synthetic/SyntheticBuilder.html#hasProperty(java.lang.String)">SyntheticBuilder</a></code></strong></div>
<div class="block">Check to see if a particular property has already been added to the list of
properties to generate</div>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code><a href="../../../../com/amazon/carbonado/synthetic/SyntheticBuilder.html#hasProperty(java.lang.String)">hasProperty</a></code> in interface <code><a href="../../../../com/amazon/carbonado/synthetic/SyntheticBuilder.html" title="interface in com.amazon.carbonado.synthetic">SyntheticBuilder</a></code></dd>
</dl>
</li>
</ul>
<a name="addPrimaryKey()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>addPrimaryKey</h4>
<pre>public <a href="../../../../com/amazon/carbonado/synthetic/SyntheticKey.html" title="class in com.amazon.carbonado.synthetic">SyntheticKey</a> addPrimaryKey()</pre>
<div class="block"><strong>Description copied from interface: <code><a href="../../../../com/amazon/carbonado/synthetic/SyntheticBuilder.html#addPrimaryKey()">SyntheticBuilder</a></code></strong></div>
<div class="block">Add a primary key to be built.</div>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code><a href="../../../../com/amazon/carbonado/synthetic/SyntheticBuilder.html#addPrimaryKey()">addPrimaryKey</a></code> in interface <code><a href="../../../../com/amazon/carbonado/synthetic/SyntheticBuilder.html" title="interface in com.amazon.carbonado.synthetic">SyntheticBuilder</a></code></dd>
<dt><span class="strong">Returns:</span></dt><dd>key to be decorated with property values defining the primary key</dd></dl>
</li>
</ul>
<a name="addAlternateKey()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>addAlternateKey</h4>
<pre>public <a href="../../../../com/amazon/carbonado/synthetic/SyntheticKey.html" title="class in com.amazon.carbonado.synthetic">SyntheticKey</a> addAlternateKey()</pre>
<div class="block"><strong>Description copied from interface: <code><a href="../../../../com/amazon/carbonado/synthetic/SyntheticBuilder.html#addAlternateKey()">SyntheticBuilder</a></code></strong></div>
<div class="block">Add an alternate key to be built.</div>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code><a href="../../../../com/amazon/carbonado/synthetic/SyntheticBuilder.html#addAlternateKey()">addAlternateKey</a></code> in interface <code><a href="../../../../com/amazon/carbonado/synthetic/SyntheticBuilder.html" title="interface in com.amazon.carbonado.synthetic">SyntheticBuilder</a></code></dd>
<dt><span class="strong">Returns:</span></dt><dd>key to be decorated with property values defining the alternate key</dd></dl>
</li>
</ul>
<a name="addIndex()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>addIndex</h4>
<pre>public <a href="../../../../com/amazon/carbonado/synthetic/SyntheticIndex.html" title="class in com.amazon.carbonado.synthetic">SyntheticIndex</a> addIndex()</pre>
<div class="block"><strong>Description copied from interface: <code><a href="../../../../com/amazon/carbonado/synthetic/SyntheticBuilder.html#addIndex()">SyntheticBuilder</a></code></strong></div>
<div class="block">Add an index to the set managed by this builder. All indexes added this
way will be in addition to the primary and alternate key indexes.</div>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code><a href="../../../../com/amazon/carbonado/synthetic/SyntheticBuilder.html#addIndex()">addIndex</a></code> in interface <code><a href="../../../../com/amazon/carbonado/synthetic/SyntheticBuilder.html" title="interface in com.amazon.carbonado.synthetic">SyntheticBuilder</a></code></dd>
<dt><span class="strong">Returns:</span></dt><dd>index to be decorated with property values defining the index</dd></dl>
</li>
</ul>
<a name="isVersioned()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isVersioned</h4>
<pre>public boolean isVersioned()</pre>
<div class="block"><strong>Description copied from interface: <code><a href="../../../../com/amazon/carbonado/synthetic/SyntheticBuilder.html#isVersioned()">SyntheticBuilder</a></code></strong></div>
<div class="block">Returns true if a property with the version attribute has been addded</div>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code><a href="../../../../com/amazon/carbonado/synthetic/SyntheticBuilder.html#isVersioned()">isVersioned</a></code> in interface <code><a href="../../../../com/amazon/carbonado/synthetic/SyntheticBuilder.html" title="interface in com.amazon.carbonado.synthetic">SyntheticBuilder</a></code></dd>
</dl>
</li>
</ul>
<a name="getClassNameProvider()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getClassNameProvider</h4>
<pre>public <a href="../../../../com/amazon/carbonado/synthetic/SyntheticBuilder.ClassNameProvider.html" title="interface in com.amazon.carbonado.synthetic">SyntheticBuilder.ClassNameProvider</a> getClassNameProvider()</pre>
<dl><dt><span class="strong">Returns:</span></dt><dd>Returns the classNameProvider.</dd></dl>
</li>
</ul>
<a name="setClassNameProvider(com.amazon.carbonado.synthetic.SyntheticBuilder.ClassNameProvider)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setClassNameProvider</h4>
<pre>public void setClassNameProvider(<a href="../../../../com/amazon/carbonado/synthetic/SyntheticBuilder.ClassNameProvider.html" title="interface in com.amazon.carbonado.synthetic">SyntheticBuilder.ClassNameProvider</a> classNameProvider)</pre>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>classNameProvider</code> - The classNameProvider to set.</dd></dl>
</li>
</ul>
<a name="setEvolvable(boolean)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setEvolvable</h4>
<pre>public void setEvolvable(boolean evolvable)</pre>
<div class="block">By default, generated storable implements the Unevolvable marker
interface, which can affect how it is encoded. It usually does not make
sense to support storable evolution new versions can be (and often will
be) given different names.
<p>Pass in true to change from the default behavior, and not implement
Unevolvable. When doing so, a ClassNameProvider should also be provided
to ensure consistent naming which does not include property names.</div>
</li>
</ul>
<a name="definePropertyBeanMethods(org.cojen.classfile.ClassFile, com.amazon.carbonado.synthetic.SyntheticProperty)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>definePropertyBeanMethods</h4>
<pre>protected boolean definePropertyBeanMethods(org.cojen.classfile.ClassFile cf,
<a href="../../../../com/amazon/carbonado/synthetic/SyntheticProperty.html" title="class in com.amazon.carbonado.synthetic">SyntheticProperty</a> property)</pre>
<div class="block">Add the get & set methods for this property</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>true if version property was added</dd></dl>
</li>
</ul>
<a name="getName()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getName</h4>
<pre>protected java.lang.String getName()</pre>
<div class="block">Frequently used by the <a href="../../../../com/amazon/carbonado/synthetic/SyntheticBuilder.ClassNameProvider.html" title="interface in com.amazon.carbonado.synthetic"><code>SyntheticBuilder.ClassNameProvider</code></a> as a
basis for the generated classname</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>builder name</dd></dl>
</li>
</ul>
<a name="getPropertyList()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getPropertyList</h4>
<pre>protected java.util.List<<a href="../../../../com/amazon/carbonado/synthetic/SyntheticProperty.html" title="class in com.amazon.carbonado.synthetic">SyntheticProperty</a>> getPropertyList()</pre>
<div class="block">Frequently used by the <a href="../../../../com/amazon/carbonado/synthetic/SyntheticBuilder.ClassNameProvider.html" title="interface in com.amazon.carbonado.synthetic"><code>SyntheticBuilder.ClassNameProvider</code></a> as a
basis for the generated classname</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>properties for this storable</dd></dl>
</li>
</ul>
<a name="toString()">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>toString</h4>
<pre>public java.lang.String toString()</pre>
<dl>
<dt><strong>Overrides:</strong></dt>
<dd><code>toString</code> in class <code>java.lang.Object</code></dd>
</dl>
</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/SyntheticStorableBuilder.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/synthetic/SyntheticPropertyList.html" title="class in com.amazon.carbonado.synthetic"><span class="strong">Prev Class</span></a></li>
<li><a href="../../../../com/amazon/carbonado/synthetic/SyntheticStorableReferenceAccess.html" title="class in com.amazon.carbonado.synthetic"><span class="strong">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../index.html?com/amazon/carbonado/synthetic/SyntheticStorableBuilder.html" target="_top">Frames</a></li>
<li><a href="SyntheticStorableBuilder.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>
|
