summaryrefslogtreecommitdiff
path: root/apidocs/com/amazon/carbonado/layout/Layout.html
diff options
context:
space:
mode:
Diffstat (limited to 'apidocs/com/amazon/carbonado/layout/Layout.html')
-rw-r--r--apidocs/com/amazon/carbonado/layout/Layout.html580
1 files changed, 580 insertions, 0 deletions
diff --git a/apidocs/com/amazon/carbonado/layout/Layout.html b/apidocs/com/amazon/carbonado/layout/Layout.html
new file mode 100644
index 0000000..284f919
--- /dev/null
+++ b/apidocs/com/amazon/carbonado/layout/Layout.html
@@ -0,0 +1,580 @@
+<!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>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="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><a href="package-summary.html">Package</a></li>
+<li class="navBarCell1Rev">Class</li>
+<li><a href="class-use/Layout.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>Prev Class</li>
+<li><a href="../../../../com/amazon/carbonado/layout/LayoutCapability.html" title="interface in com.amazon.carbonado.layout"><span class="strong">Next Class</span></a></li>
+</ul>
+<ul class="navList">
+<li><a href="../../../../index.html?com/amazon/carbonado/layout/Layout.html" target="_top">Frames</a></li>
+<li><a href="Layout.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>Nested&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.layout</div>
+<h2 title="Class Layout" class="title">Class Layout</h2>
+</div>
+<div class="contentContainer">
+<ul class="inheritance">
+<li>java.lang.Object</li>
+<li>
+<ul class="inheritance">
+<li>com.amazon.carbonado.layout.Layout</li>
+</ul>
+</li>
+</ul>
+<div class="description">
+<ul class="blockList">
+<li class="blockList">
+<hr>
+<br>
+<pre>public class <span class="strong">Layout</span>
+extends java.lang.Object</pre>
+<div class="block">Describes the layout of a specific generation of a storable.</div>
+<dl><dt><span class="strong">Author:</span></dt>
+ <dd>Brian S O'Neill</dd>
+<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>
+</li>
+</ul>
+</div>
+<div class="summary">
+<ul class="blockList">
+<li class="blockList">
+<!-- ========== 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>boolean</code></td>
+<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/layout/Layout.html#equalLayouts(com.amazon.carbonado.layout.Layout)">equalLayouts</a></strong>(<a href="../../../../com/amazon/carbonado/layout/Layout.html" title="class in com.amazon.carbonado.layout">Layout</a>&nbsp;layout)</code>
+<div class="block">Returns true if the given layout matches this one.</div>
+</td>
+</tr>
+<tr class="rowColor">
+<td class="colFirst"><code>boolean</code></td>
+<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/layout/Layout.html#equals(java.lang.Object)">equals</a></strong>(java.lang.Object&nbsp;obj)</code>&nbsp;</td>
+</tr>
+<tr class="altColor">
+<td class="colFirst"><code>java.util.List&lt;<a href="../../../../com/amazon/carbonado/layout/LayoutProperty.html" title="class in com.amazon.carbonado.layout">LayoutProperty</a>&gt;</code></td>
+<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/layout/Layout.html#getAllProperties()">getAllProperties</a></strong>()</code>
+<div class="block">Returns all the properties of this layout, in their proper order.</div>
+</td>
+</tr>
+<tr class="rowColor">
+<td class="colFirst"><code>org.joda.time.DateTime</code></td>
+<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/layout/Layout.html#getCreationDateTime()">getCreationDateTime</a></strong>()</code>
+<div class="block">Returns the date and time for when this layout generation was created.</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/layout/Layout.html#getCreationHost()">getCreationHost</a></strong>()</code>
+<div class="block">Returns the host machine that created this generation.</div>
+</td>
+</tr>
+<tr class="rowColor">
+<td class="colFirst"><code>java.lang.String</code></td>
+<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/layout/Layout.html#getCreationUser()">getCreationUser</a></strong>()</code>
+<div class="block">Returns the user that created this layout generation.</div>
+</td>
+</tr>
+<tr class="altColor">
+<td class="colFirst"><code>java.util.List&lt;<a href="../../../../com/amazon/carbonado/layout/LayoutProperty.html" title="class in com.amazon.carbonado.layout">LayoutProperty</a>&gt;</code></td>
+<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/layout/Layout.html#getDataProperties()">getDataProperties</a></strong>()</code>
+<div class="block">Returns all the non-primary key properties of this layout, in their
+ proper order.</div>
+</td>
+</tr>
+<tr class="rowColor">
+<td class="colFirst"><code>int</code></td>
+<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/layout/Layout.html#getGeneration()">getGeneration</a></strong>()</code>
+<div class="block">Returns the generation of this layout, where zero represents the first
+ generation.</div>
+</td>
+</tr>
+<tr class="altColor">
+<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/layout/Layout.html" title="class in com.amazon.carbonado.layout">Layout</a></code></td>
+<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/layout/Layout.html#getGeneration(int)">getGeneration</a></strong>(int&nbsp;generation)</code>
+<div class="block">Returns the layout for a particular generation of this layout's type.</div>
+</td>
+</tr>
+<tr class="rowColor">
+<td class="colFirst"><code>long</code></td>
+<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/layout/Layout.html#getLayoutID()">getLayoutID</a></strong>()</code>
+<div class="block">Returns a unique identifier for this layout.</div>
+</td>
+</tr>
+<tr class="altColor">
+<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/layout/LayoutOptions.html" title="class in com.amazon.carbonado.layout">LayoutOptions</a></code></td>
+<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/layout/Layout.html#getOptions()">getOptions</a></strong>()</code>
+<div class="block">Returns additional options, or null if none.</div>
+</td>
+</tr>
+<tr class="rowColor">
+<td class="colFirst"><code>java.lang.String</code></td>
+<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/layout/Layout.html#getStorableTypeName()">getStorableTypeName</a></strong>()</code>
+<div class="block">Storable type name is a fully qualified Java class name.</div>
+</td>
+</tr>
+<tr class="altColor">
+<td class="colFirst"><code>int</code></td>
+<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/layout/Layout.html#hashCode()">hashCode</a></strong>()</code>&nbsp;</td>
+</tr>
+<tr class="rowColor">
+<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/layout/Layout.html" title="class in com.amazon.carbonado.layout">Layout</a></code></td>
+<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/layout/Layout.html#nextGeneration()">nextGeneration</a></strong>()</code>
+<div class="block">Returns the next known generation of the storable's layout, or null
+ if none.</div>
+</td>
+</tr>
+<tr class="altColor">
+<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/layout/Layout.html" title="class in com.amazon.carbonado.layout">Layout</a></code></td>
+<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/layout/Layout.html#previousGeneration()">previousGeneration</a></strong>()</code>
+<div class="block">Returns the previous known generation of the storable's layout, or null
+ if none.</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/layout/Layout.html#reconstruct()">reconstruct</a></strong>()</code>
+<div class="block">Reconstructs the storable type defined by this layout by returning an
+ auto-generated 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/layout/Layout.html#reconstruct(java.lang.ClassLoader)">reconstruct</a></strong>(java.lang.ClassLoader&nbsp;loader)</code>
+<div class="block">Reconstructs the storable type defined by this layout by returning an
+ auto-generated class.</div>
+</td>
+</tr>
+<tr class="rowColor">
+<td class="colFirst"><code>java.lang.String</code></td>
+<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/layout/Layout.html#toString()">toString</a></strong>()</code>&nbsp;</td>
+</tr>
+<tr class="altColor">
+<td class="colFirst"><code>void</code></td>
+<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/layout/Layout.html#writeTo(java.io.OutputStream)">writeTo</a></strong>(java.io.OutputStream&nbsp;out)</code>
+<div class="block">Write a layout to be read by <a href="../../../../com/amazon/carbonado/layout/LayoutFactory.html#readLayoutFrom(java.io.InputStream)"><code>LayoutFactory.readLayoutFrom(java.io.InputStream)</code></a>.</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&nbsp;java.lang.Object</h3>
+<code>clone, finalize, getClass, notify, notifyAll, wait, wait, wait</code></li>
+</ul>
+</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="getLayoutID()">
+<!-- -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>getLayoutID</h4>
+<pre>public&nbsp;long&nbsp;getLayoutID()</pre>
+<div class="block">Returns a unique identifier for this layout.</div>
+</li>
+</ul>
+<a name="getStorableTypeName()">
+<!-- -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>getStorableTypeName</h4>
+<pre>public&nbsp;java.lang.String&nbsp;getStorableTypeName()</pre>
+<div class="block">Storable type name is a fully qualified Java class name.</div>
+</li>
+</ul>
+<a name="getGeneration()">
+<!-- -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>getGeneration</h4>
+<pre>public&nbsp;int&nbsp;getGeneration()</pre>
+<div class="block">Returns the generation of this layout, where zero represents the first
+ generation.</div>
+</li>
+</ul>
+<a name="getDataProperties()">
+<!-- -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>getDataProperties</h4>
+<pre>public&nbsp;java.util.List&lt;<a href="../../../../com/amazon/carbonado/layout/LayoutProperty.html" title="class in com.amazon.carbonado.layout">LayoutProperty</a>&gt;&nbsp;getDataProperties()
+ throws <a href="../../../../com/amazon/carbonado/FetchException.html" title="class in com.amazon.carbonado">FetchException</a></pre>
+<div class="block">Returns all the non-primary key properties of this layout, in their
+ proper order.</div>
+<dl><dt><span class="strong">Throws:</span></dt>
+<dd><code><a href="../../../../com/amazon/carbonado/FetchException.html" title="class in com.amazon.carbonado">FetchException</a></code></dd></dl>
+</li>
+</ul>
+<a name="getAllProperties()">
+<!-- -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>getAllProperties</h4>
+<pre>public&nbsp;java.util.List&lt;<a href="../../../../com/amazon/carbonado/layout/LayoutProperty.html" title="class in com.amazon.carbonado.layout">LayoutProperty</a>&gt;&nbsp;getAllProperties()
+ throws <a href="../../../../com/amazon/carbonado/FetchException.html" title="class in com.amazon.carbonado">FetchException</a></pre>
+<div class="block">Returns all the properties of this layout, in their proper order.</div>
+<dl><dt><span class="strong">Throws:</span></dt>
+<dd><code><a href="../../../../com/amazon/carbonado/FetchException.html" title="class in com.amazon.carbonado">FetchException</a></code></dd></dl>
+</li>
+</ul>
+<a name="getCreationDateTime()">
+<!-- -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>getCreationDateTime</h4>
+<pre>public&nbsp;org.joda.time.DateTime&nbsp;getCreationDateTime()</pre>
+<div class="block">Returns the date and time for when this layout generation was created.</div>
+</li>
+</ul>
+<a name="getCreationUser()">
+<!-- -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>getCreationUser</h4>
+<pre>public&nbsp;java.lang.String&nbsp;getCreationUser()</pre>
+<div class="block">Returns the user that created this layout generation.</div>
+</li>
+</ul>
+<a name="getCreationHost()">
+<!-- -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>getCreationHost</h4>
+<pre>public&nbsp;java.lang.String&nbsp;getCreationHost()</pre>
+<div class="block">Returns the host machine that created this generation.</div>
+</li>
+</ul>
+<a name="getOptions()">
+<!-- -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>getOptions</h4>
+<pre>public&nbsp;<a href="../../../../com/amazon/carbonado/layout/LayoutOptions.html" title="class in com.amazon.carbonado.layout">LayoutOptions</a>&nbsp;getOptions()</pre>
+<div class="block">Returns additional options, or null if none.</div>
+<dl><dt><span class="strong">Returns:</span></dt><dd>read-only object or null</dd></dl>
+</li>
+</ul>
+<a name="getGeneration(int)">
+<!-- -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>getGeneration</h4>
+<pre>public&nbsp;<a href="../../../../com/amazon/carbonado/layout/Layout.html" title="class in com.amazon.carbonado.layout">Layout</a>&nbsp;getGeneration(int&nbsp;generation)
+ throws <a href="../../../../com/amazon/carbonado/FetchNoneException.html" title="class in com.amazon.carbonado">FetchNoneException</a>,
+ <a href="../../../../com/amazon/carbonado/FetchException.html" title="class in com.amazon.carbonado">FetchException</a></pre>
+<div class="block">Returns the layout for a particular generation of this layout's type.</div>
+<dl><dt><span class="strong">Throws:</span></dt>
+<dd><code><a href="../../../../com/amazon/carbonado/FetchNoneException.html" title="class in com.amazon.carbonado">FetchNoneException</a></code> - if generation not found</dd>
+<dd><code><a href="../../../../com/amazon/carbonado/FetchException.html" title="class in com.amazon.carbonado">FetchException</a></code></dd></dl>
+</li>
+</ul>
+<a name="previousGeneration()">
+<!-- -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>previousGeneration</h4>
+<pre>public&nbsp;<a href="../../../../com/amazon/carbonado/layout/Layout.html" title="class in com.amazon.carbonado.layout">Layout</a>&nbsp;previousGeneration()
+ throws <a href="../../../../com/amazon/carbonado/FetchException.html" title="class in com.amazon.carbonado">FetchException</a></pre>
+<div class="block">Returns the previous known generation of the storable's layout, or null
+ if none.</div>
+<dl><dt><span class="strong">Returns:</span></dt><dd>a layout with a lower generation, or null if none</dd>
+<dt><span class="strong">Throws:</span></dt>
+<dd><code><a href="../../../../com/amazon/carbonado/FetchException.html" title="class in com.amazon.carbonado">FetchException</a></code></dd></dl>
+</li>
+</ul>
+<a name="nextGeneration()">
+<!-- -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>nextGeneration</h4>
+<pre>public&nbsp;<a href="../../../../com/amazon/carbonado/layout/Layout.html" title="class in com.amazon.carbonado.layout">Layout</a>&nbsp;nextGeneration()
+ throws <a href="../../../../com/amazon/carbonado/FetchException.html" title="class in com.amazon.carbonado">FetchException</a></pre>
+<div class="block">Returns the next known generation of the storable's layout, or null
+ if none.</div>
+<dl><dt><span class="strong">Returns:</span></dt><dd>a layout with a higher generation, or null if none</dd>
+<dt><span class="strong">Throws:</span></dt>
+<dd><code><a href="../../../../com/amazon/carbonado/FetchException.html" title="class in com.amazon.carbonado">FetchException</a></code></dd></dl>
+</li>
+</ul>
+<a name="reconstruct()">
+<!-- -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>reconstruct</h4>
+<pre>public&nbsp;java.lang.Class&lt;? extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>&gt;&nbsp;reconstruct()
+ throws <a href="../../../../com/amazon/carbonado/FetchException.html" title="class in com.amazon.carbonado">FetchException</a>,
+ <a href="../../../../com/amazon/carbonado/SupportException.html" title="class in com.amazon.carbonado">SupportException</a></pre>
+<div class="block">Reconstructs the storable type defined by this layout by returning an
+ auto-generated class. The reconstructed storable type will not contain
+ everything in the original, but rather the minimum required to decode
+ persisted instances.</div>
+<dl><dt><span class="strong">Throws:</span></dt>
+<dd><code><a href="../../../../com/amazon/carbonado/FetchException.html" title="class in com.amazon.carbonado">FetchException</a></code></dd>
+<dd><code><a href="../../../../com/amazon/carbonado/SupportException.html" title="class in com.amazon.carbonado">SupportException</a></code></dd></dl>
+</li>
+</ul>
+<a name="reconstruct(java.lang.ClassLoader)">
+<!-- -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>reconstruct</h4>
+<pre>public&nbsp;java.lang.Class&lt;? extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>&gt;&nbsp;reconstruct(java.lang.ClassLoader&nbsp;loader)
+ throws <a href="../../../../com/amazon/carbonado/FetchException.html" title="class in com.amazon.carbonado">FetchException</a>,
+ <a href="../../../../com/amazon/carbonado/SupportException.html" title="class in com.amazon.carbonado">SupportException</a></pre>
+<div class="block">Reconstructs the storable type defined by this layout by returning an
+ auto-generated class. The reconstructed storable type will not contain
+ everything in the original, but rather the minimum required to decode
+ persisted instances.</div>
+<dl><dt><span class="strong">Parameters:</span></dt><dd><code>loader</code> - optional ClassLoader to load reconstruct class into, if it
+ has not been loaded yet</dd>
+<dt><span class="strong">Throws:</span></dt>
+<dd><code><a href="../../../../com/amazon/carbonado/FetchException.html" title="class in com.amazon.carbonado">FetchException</a></code></dd>
+<dd><code><a href="../../../../com/amazon/carbonado/SupportException.html" title="class in com.amazon.carbonado">SupportException</a></code></dd></dl>
+</li>
+</ul>
+<a name="hashCode()">
+<!-- -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>hashCode</h4>
+<pre>public&nbsp;int&nbsp;hashCode()</pre>
+<dl>
+<dt><strong>Overrides:</strong></dt>
+<dd><code>hashCode</code>&nbsp;in class&nbsp;<code>java.lang.Object</code></dd>
+</dl>
+</li>
+</ul>
+<a name="equals(java.lang.Object)">
+<!-- -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>equals</h4>
+<pre>public&nbsp;boolean&nbsp;equals(java.lang.Object&nbsp;obj)</pre>
+<dl>
+<dt><strong>Overrides:</strong></dt>
+<dd><code>equals</code>&nbsp;in class&nbsp;<code>java.lang.Object</code></dd>
+</dl>
+</li>
+</ul>
+<a name="toString()">
+<!-- -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>toString</h4>
+<pre>public&nbsp;java.lang.String&nbsp;toString()</pre>
+<dl>
+<dt><strong>Overrides:</strong></dt>
+<dd><code>toString</code>&nbsp;in class&nbsp;<code>java.lang.Object</code></dd>
+</dl>
+</li>
+</ul>
+<a name="equalLayouts(com.amazon.carbonado.layout.Layout)">
+<!-- -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>equalLayouts</h4>
+<pre>public&nbsp;boolean&nbsp;equalLayouts(<a href="../../../../com/amazon/carbonado/layout/Layout.html" title="class in com.amazon.carbonado.layout">Layout</a>&nbsp;layout)
+ throws <a href="../../../../com/amazon/carbonado/FetchException.html" title="class in com.amazon.carbonado">FetchException</a></pre>
+<div class="block">Returns true if the given layout matches this one. Layout ID,
+ generation, and creation info is not considered in the comparison.</div>
+<dl><dt><span class="strong">Throws:</span></dt>
+<dd><code><a href="../../../../com/amazon/carbonado/FetchException.html" title="class in com.amazon.carbonado">FetchException</a></code></dd></dl>
+</li>
+</ul>
+<a name="writeTo(java.io.OutputStream)">
+<!-- -->
+</a>
+<ul class="blockListLast">
+<li class="blockList">
+<h4>writeTo</h4>
+<pre>public&nbsp;void&nbsp;writeTo(java.io.OutputStream&nbsp;out)
+ throws java.io.IOException,
+ <a href="../../../../com/amazon/carbonado/RepositoryException.html" title="class in com.amazon.carbonado">RepositoryException</a></pre>
+<div class="block">Write a layout to be read by <a href="../../../../com/amazon/carbonado/layout/LayoutFactory.html#readLayoutFrom(java.io.InputStream)"><code>LayoutFactory.readLayoutFrom(java.io.InputStream)</code></a>.</div>
+<dl><dt><span class="strong">Throws:</span></dt>
+<dd><code>java.io.IOException</code></dd>
+<dd><code><a href="../../../../com/amazon/carbonado/RepositoryException.html" title="class in com.amazon.carbonado">RepositoryException</a></code></dd><dt><span class="strong">Since:</span></dt>
+ <dd>1.2.2</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/Layout.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>Prev Class</li>
+<li><a href="../../../../com/amazon/carbonado/layout/LayoutCapability.html" title="interface in com.amazon.carbonado.layout"><span class="strong">Next Class</span></a></li>
+</ul>
+<ul class="navList">
+<li><a href="../../../../index.html?com/amazon/carbonado/layout/Layout.html" target="_top">Frames</a></li>
+<li><a href="Layout.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>Nested&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>