Adding javadocs and Carbonado User Guidegh-pages

author: Jesse Morgan <morganjm@amazon.com> 2013-12-03 14:03:28 -0800
committer: Jesse Morgan <morganjm@amazon.com> 2013-12-03 14:03:28 -0800
commit: d479253768d296a40b4f699e1de9b03c7146a97a (patch)
tree: 208e70d81fc3e477a37d3f9ca6475c39bb6410d3 /apidocs/com/amazon/carbonado/layout/package-summary.html
1 files changed, 230 insertions, 0 deletions
diff --git a/apidocs/com/amazon/carbonado/layout/package-summary.html b/apidocs/com/amazon/carbonado/layout/package-summary.html
new file mode 100644
index 0000000..c5bca9a
--- /dev/null
+++ b/apidocs/com/amazon/carbonado/layout/package-summary.html
@@ -0,0 +1,230 @@
+<!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:44 PST 2013 -->
+<meta http-equiv="Content-Type" content="text/html" charset="UTF-8">
+<title>com.amazon.carbonado.layout (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="com.amazon.carbonado.layout (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 class="navBarCell1Rev">Package</li>
+<li>Class</li>
+<li><a href="package-use.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/info/package-summary.html">Prev Package</a></li>
+<li><a href="../../../../com/amazon/carbonado/lob/package-summary.html">Next Package</a></li>
+</ul>
+<ul class="navList">
+<li><a href="../../../../index.html?com/amazon/carbonado/layout/package-summary.html" target="_top">Frames</a></li>
+<li><a href="package-summary.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>
+<a name="skip-navbar_top">
+<!--   -->
+</a></div>
+<!-- ========= END OF TOP NAVBAR ========= -->
+<div class="header">
+<h1 title="Package" class="title">Package&nbsp;com.amazon.carbonado.layout</h1>
+<div class="docSummary">
+<div class="block">Support for recording the evolution of a storable's layout, used internally
+ by some repositories.</div>
+</div>
+<p>See:&nbsp;<a href="#package_description">Description</a></p>
+</div>
+<div class="contentContainer">
+<ul class="blockList">
+<li class="blockList">
+<table class="packageSummary" border="0" cellpadding="3" cellspacing="0" summary="Interface Summary table, listing interfaces, and an explanation">
+<caption><span>Interface Summary</span><span class="tabEnd">&nbsp;</span></caption>
+<tr>
+<th class="colFirst" scope="col">Interface</th>
+<th class="colLast" scope="col">Description</th>
+</tr>
+<tbody>
+<tr class="altColor">
+<td class="colFirst"><a href="../../../../com/amazon/carbonado/layout/LayoutCapability.html" title="interface in com.amazon.carbonado.layout">LayoutCapability</a></td>
+<td class="colLast">
+<div class="block">Capability to get layout information on any storable generation.</div>
+</td>
+</tr>
+<tr class="rowColor">
+<td class="colFirst"><a href="../../../../com/amazon/carbonado/layout/StoredLayout.html" title="interface in com.amazon.carbonado.layout">StoredLayout</a></td>
+<td class="colLast">
+<div class="block">Stored information regarding the layout of a Storable type, which is used
+ internally by <a href="../../../../com/amazon/carbonado/layout/Layout.html" title="class in com.amazon.carbonado.layout"><code>Layout</code></a>.</div>
+</td>
+</tr>
+<tr class="altColor">
+<td class="colFirst"><a href="../../../../com/amazon/carbonado/layout/StoredLayoutEquivalence.html" title="interface in com.amazon.carbonado.layout">StoredLayoutEquivalence</a></td>
+<td class="colLast">
+<div class="block">Maps layout generations which are equivalent.</div>
+</td>
+</tr>
+<tr class="rowColor">
+<td class="colFirst"><a href="../../../../com/amazon/carbonado/layout/StoredLayoutProperty.html" title="interface in com.amazon.carbonado.layout">StoredLayoutProperty</a></td>
+<td class="colLast">
+<div class="block">Stored property joined to a <a href="../../../../com/amazon/carbonado/layout/StoredLayout.html" title="interface in com.amazon.carbonado.layout"><code>StoredLayout</code></a>, which is used internally
+ by <a href="../../../../com/amazon/carbonado/layout/LayoutProperty.html" title="class in com.amazon.carbonado.layout"><code>LayoutProperty</code></a>.</div>
+</td>
+</tr>
+<tr class="altColor">
+<td class="colFirst"><a href="../../../../com/amazon/carbonado/layout/Unevolvable.html" title="interface in com.amazon.carbonado.layout">Unevolvable</a></td>
+<td class="colLast">
+<div class="block">Marker interface for storables that are not allowed to evolve.</div>
+</td>
+</tr>
+</tbody>
+</table>
+</li>
+<li class="blockList">
+<table class="packageSummary" border="0" cellpadding="3" cellspacing="0" summary="Class Summary table, listing classes, and an explanation">
+<caption><span>Class Summary</span><span class="tabEnd">&nbsp;</span></caption>
+<tr>
+<th class="colFirst" scope="col">Class</th>
+<th class="colLast" scope="col">Description</th>
+</tr>
+<tbody>
+<tr class="altColor">
+<td class="colFirst"><a href="../../../../com/amazon/carbonado/layout/Layout.html" title="class in com.amazon.carbonado.layout">Layout</a></td>
+<td class="colLast">
+<div class="block">Describes the layout of a specific generation of a storable.</div>
+</td>
+</tr>
+<tr class="rowColor">
+<td class="colFirst"><a href="../../../../com/amazon/carbonado/layout/LayoutFactory.html" title="class in com.amazon.carbonado.layout">LayoutFactory</a></td>
+<td class="colLast">
+<div class="block">Factory for obtaining references to storable layouts.</div>
+</td>
+</tr>
+<tr class="altColor">
+<td class="colFirst"><a href="../../../../com/amazon/carbonado/layout/LayoutOptions.html" title="class in com.amazon.carbonado.layout">LayoutOptions</a></td>
+<td class="colLast">
+<div class="block">Extra options encoded with a Storable layout.</div>
+</td>
+</tr>
+<tr class="rowColor">
+<td class="colFirst"><a href="../../../../com/amazon/carbonado/layout/LayoutProperty.html" title="class in com.amazon.carbonado.layout">LayoutProperty</a></td>
+<td class="colLast">
+<div class="block">Describes how a property is defined in a specific generation of a storable.</div>
+</td>
+</tr>
+<tr class="altColor">
+<td class="colFirst"><a href="../../../../com/amazon/carbonado/layout/LayoutSync.html" title="class in com.amazon.carbonado.layout">LayoutSync</a></td>
+<td class="colLast">
+<div class="block">Synchronizes layout metadata between two repositories.</div>
+</td>
+</tr>
+</tbody>
+</table>
+</li>
+</ul>
+<a name="package_description">
+<!--   -->
+</a>
+<h2 title="Package com.amazon.carbonado.layout Description">Package com.amazon.carbonado.layout Description</h2>
+<div class="block">Support for recording the evolution of a storable's layout, used internally
+ by some repositories. This allows storable's to evolve. Enough information
+ is recorded in the <a href="../../../../com/amazon/carbonado/layout/Layout.html" title="class in com.amazon.carbonado.layout"><code>layout</code></a> such
+ that an older generation can be reconstructed, allowing it to be decoded
+ from persistent storage.
+
+ <p>A storable generation is different than a storable <a href="../../../../com/amazon/carbonado/Version.html" title="annotation in com.amazon.carbonado"><code>version</code></a>. The version increases with each
+ update of an <i>instance</i>, whereas the generation increases when the
+ storable type definition changes. The version number is stored with each
+ instance, and the generation is stored via the classes in this package.
+
+ <p>Whenever a property is added or removed from a storable, the storable
+ layout is assigned a new generation value. If the storable layout reverts to
+ a previous generation's layout, no new generation value is created. Instead,
+ the generation value of the current storable will match the previous
+ generation.</div>
+<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../com/amazon/carbonado/layout/LayoutFactory.html" title="class in com.amazon.carbonado.layout"><code>LayoutFactory</code></a></dd></dl>
+</div>
+<!-- ======= 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 class="navBarCell1Rev">Package</li>
+<li>Class</li>
+<li><a href="package-use.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/info/package-summary.html">Prev Package</a></li>
+<li><a href="../../../../com/amazon/carbonado/lob/package-summary.html">Next Package</a></li>
+</ul>
+<ul class="navList">
+<li><a href="../../../../index.html?com/amazon/carbonado/layout/package-summary.html" target="_top">Frames</a></li>
+<li><a href="package-summary.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>
+<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>
author	Jesse Morgan <morganjm@amazon.com>	2013-12-03 14:03:28 -0800
committer	Jesse Morgan <morganjm@amazon.com>	2013-12-03 14:03:28 -0800
commit	d479253768d296a40b4f699e1de9b03c7146a97a (patch)
tree	208e70d81fc3e477a37d3f9ca6475c39bb6410d3 /apidocs/com/amazon/carbonado/layout/package-summary.html