summaryrefslogtreecommitdiff
path: root/apidocs/com/amazon/carbonado/synthetic/SyntheticBuilder.html
diff options
context:
space:
mode:
authorJesse Morgan <morganjm@amazon.com>2013-12-03 14:03:28 -0800
committerJesse Morgan <morganjm@amazon.com>2013-12-03 14:03:28 -0800
commitd479253768d296a40b4f699e1de9b03c7146a97a (patch)
tree208e70d81fc3e477a37d3f9ca6475c39bb6410d3 /apidocs/com/amazon/carbonado/synthetic/SyntheticBuilder.html
Adding javadocs and Carbonado User Guidegh-pages
Diffstat (limited to 'apidocs/com/amazon/carbonado/synthetic/SyntheticBuilder.html')
-rw-r--r--apidocs/com/amazon/carbonado/synthetic/SyntheticBuilder.html413
1 files changed, 413 insertions, 0 deletions
diff --git a/apidocs/com/amazon/carbonado/synthetic/SyntheticBuilder.html b/apidocs/com/amazon/carbonado/synthetic/SyntheticBuilder.html
new file mode 100644
index 0000000..139651a
--- /dev/null
+++ b/apidocs/com/amazon/carbonado/synthetic/SyntheticBuilder.html
@@ -0,0 +1,413 @@
+<!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>SyntheticBuilder (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="SyntheticBuilder (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/SyntheticBuilder.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/ClassFileBuilder.html" title="class in com.amazon.carbonado.synthetic"><span class="strong">Prev Class</span></a></li>
+<li><a href="../../../../com/amazon/carbonado/synthetic/SyntheticBuilder.ClassNameProvider.html" title="interface 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/SyntheticBuilder.html" target="_top">Frames</a></li>
+<li><a href="SyntheticBuilder.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:&nbsp;</li>
+<li><a href="#nested_class_summary">Nested</a>&nbsp;|&nbsp;</li>
+<li>Field&nbsp;|&nbsp;</li>
+<li>Constr&nbsp;|&nbsp;</li>
+<li><a href="#method_summary">Method</a></li>
+</ul>
+<ul class="subNavList">
+<li>Detail:&nbsp;</li>
+<li>Field&nbsp;|&nbsp;</li>
+<li>Constr&nbsp;|&nbsp;</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="Interface SyntheticBuilder" class="title">Interface SyntheticBuilder</h2>
+</div>
+<div class="contentContainer">
+<div class="description">
+<ul class="blockList">
+<li class="blockList">
+<dl>
+<dt>All Known Implementing Classes:</dt>
+<dd><a href="../../../../com/amazon/carbonado/synthetic/SyntheticStorableBuilder.html" title="class in com.amazon.carbonado.synthetic">SyntheticStorableBuilder</a>, <a href="../../../../com/amazon/carbonado/synthetic/SyntheticStorableReferenceBuilder.html" title="class in com.amazon.carbonado.synthetic">SyntheticStorableReferenceBuilder</a></dd>
+</dl>
+<hr>
+<br>
+<pre>public interface <span class="strong">SyntheticBuilder</span></pre>
+<div class="block">A synthetic builder provides a mechanism for creating a user storable from scratch.
+ The client creates the builder, decorates with properties and indexes on those
+ properties, then builds.
+
+ If additional, ad hoc decoration is desired, the partially constructed classfile
+ can be retrieved and operated on directly via the ClassFileBuilder
+ returned by <a href="../../../../com/amazon/carbonado/synthetic/SyntheticBuilder.html#prepare()"><code>prepare()</code></a>.</div>
+<dl><dt><span class="strong">Author:</span></dt>
+ <dd>Don Schneider, 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>
+<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Nested Class Summary table, listing nested classes, and an explanation">
+<caption><span>Nested Classes</span><span class="tabEnd">&nbsp;</span></caption>
+<tr>
+<th class="colFirst" scope="col">Modifier and Type</th>
+<th class="colLast" scope="col">Interface and Description</th>
+</tr>
+<tr class="altColor">
+<td class="colFirst"><code>static interface&nbsp;</code></td>
+<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/synthetic/SyntheticBuilder.ClassNameProvider.html" title="interface in com.amazon.carbonado.synthetic">SyntheticBuilder.ClassNameProvider</a></strong></code>
+<div class="block">Interface used to get the name for the class to generate.</div>
+</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">&nbsp;</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/SyntheticBuilder.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/SyntheticBuilder.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/SyntheticBuilder.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/SyntheticBuilder.html#addProperty(java.lang.String, java.lang.Class)">addProperty</a></strong>(java.lang.String&nbsp;name,
+ java.lang.Class&nbsp;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/SyntheticBuilder.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>&nbsp;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&lt;? extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>&gt;</code></td>
+<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/synthetic/SyntheticBuilder.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>java.lang.Class&lt;? extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>&gt;</code></td>
+<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/synthetic/SyntheticBuilder.html#getStorableClass()">getStorableClass</a></strong>()</code>&nbsp;</td>
+</tr>
+<tr class="rowColor">
+<td class="colFirst"><code>boolean</code></td>
+<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/synthetic/SyntheticBuilder.html#hasProperty(java.lang.String)">hasProperty</a></strong>(java.lang.String&nbsp;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/SyntheticBuilder.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/SyntheticBuilder.html#prepare()">prepare</a></strong>()</code>&nbsp;</td>
+</tr>
+</table>
+</li>
+</ul>
+</li>
+</ul>
+</div>
+<div class="details">
+<ul class="blockList">
+<li class="blockList">
+<!-- ============ 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><a href="../../../../com/amazon/carbonado/synthetic/ClassFileBuilder.html" title="class in com.amazon.carbonado.synthetic">ClassFileBuilder</a>&nbsp;prepare()
+ throws <a href="../../../../com/amazon/carbonado/SupportException.html" title="class in com.amazon.carbonado">SupportException</a></pre>
+<dl><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>java.lang.Class&lt;? extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>&gt;&nbsp;getStorableClass()
+ throws java.lang.IllegalStateException</pre>
+<dl><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>prepare()</code></a> already have been called
+ prior to calling this method.</dd>
+<dt><span class="strong">Throws:</span></dt>
+<dd><code>java.lang.IllegalStateException</code> - if build has not yet been called.</dd></dl>
+</li>
+</ul>
+<a name="build()">
+<!-- -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>build</h4>
+<pre>java.lang.Class&lt;? extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>&gt;&nbsp;build()
+ throws <a href="../../../../com/amazon/carbonado/SupportException.html" title="class in com.amazon.carbonado">SupportException</a></pre>
+<div class="block">Convenience method to generate the class.
+ Build will always call <a href="../../../../com/amazon/carbonado/synthetic/SyntheticBuilder.html#prepare()"><code>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>getStorableClass()</code></a> instead.</div>
+<dl><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><a href="../../../../com/amazon/carbonado/synthetic/SyntheticProperty.html" title="class in com.amazon.carbonado.synthetic">SyntheticProperty</a>&nbsp;addProperty(java.lang.String&nbsp;name,
+ java.lang.Class&nbsp;type)</pre>
+<div class="block">Add a property to the set managed by this builder.</div>
+<dl><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><a href="../../../../com/amazon/carbonado/synthetic/SyntheticProperty.html" title="class in com.amazon.carbonado.synthetic">SyntheticProperty</a>&nbsp;addProperty(<a href="../../../../com/amazon/carbonado/synthetic/SyntheticProperty.html" title="class in com.amazon.carbonado.synthetic">SyntheticProperty</a>&nbsp;prop)</pre>
+<div class="block">Add an externally defined synthetic property to the list</div>
+<dl><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>boolean&nbsp;hasProperty(java.lang.String&nbsp;name)</pre>
+<div class="block">Check to see if a particular property has already been added to the list of
+ properties to generate</div>
+<dl><dt><span class="strong">Parameters:</span></dt><dd><code>name</code> - </dd></dl>
+</li>
+</ul>
+<a name="addPrimaryKey()">
+<!-- -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>addPrimaryKey</h4>
+<pre><a href="../../../../com/amazon/carbonado/synthetic/SyntheticKey.html" title="class in com.amazon.carbonado.synthetic">SyntheticKey</a>&nbsp;addPrimaryKey()</pre>
+<div class="block">Add a primary key to be built.</div>
+<dl><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><a href="../../../../com/amazon/carbonado/synthetic/SyntheticKey.html" title="class in com.amazon.carbonado.synthetic">SyntheticKey</a>&nbsp;addAlternateKey()</pre>
+<div class="block">Add an alternate key to be built.</div>
+<dl><dt><span class="strong">Returns:</span></dt><dd>key to be decorated with property values defining the alternate key</dd><dt><span class="strong">Since:</span></dt>
+ <dd>1.2</dd></dl>
+</li>
+</ul>
+<a name="addIndex()">
+<!-- -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>addIndex</h4>
+<pre><a href="../../../../com/amazon/carbonado/synthetic/SyntheticIndex.html" title="class in com.amazon.carbonado.synthetic">SyntheticIndex</a>&nbsp;addIndex()</pre>
+<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><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="blockListLast">
+<li class="blockList">
+<h4>isVersioned</h4>
+<pre>boolean&nbsp;isVersioned()</pre>
+<div class="block">Returns true if a property with the version attribute has been addded</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/SyntheticBuilder.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/ClassFileBuilder.html" title="class in com.amazon.carbonado.synthetic"><span class="strong">Prev Class</span></a></li>
+<li><a href="../../../../com/amazon/carbonado/synthetic/SyntheticBuilder.ClassNameProvider.html" title="interface 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/SyntheticBuilder.html" target="_top">Frames</a></li>
+<li><a href="SyntheticBuilder.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:&nbsp;</li>
+<li><a href="#nested_class_summary">Nested</a>&nbsp;|&nbsp;</li>
+<li>Field&nbsp;|&nbsp;</li>
+<li>Constr&nbsp;|&nbsp;</li>
+<li><a href="#method_summary">Method</a></li>
+</ul>
+<ul class="subNavList">
+<li>Detail:&nbsp;</li>
+<li>Field&nbsp;|&nbsp;</li>
+<li>Constr&nbsp;|&nbsp;</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 &#169; 2006-2013 <a href="https://github.com/Carbonado/Carbonado">Amazon Technologies, Inc.</a>. All Rights Reserved.</small></p>
+</body>
+</html>