diff options
Diffstat (limited to 'apidocs/com/amazon/carbonado/layout')
24 files changed, 6142 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: </li> +<li>Nested | </li> +<li>Field | </li> +<li>Constr | </li> +<li><a href="#method_summary">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li>Field | </li> +<li>Constr | </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"> </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> 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 obj)</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>java.util.List<<a href="../../../../com/amazon/carbonado/layout/LayoutProperty.html" title="class in com.amazon.carbonado.layout">LayoutProperty</a>></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<<a href="../../../../com/amazon/carbonado/layout/LayoutProperty.html" title="class in com.amazon.carbonado.layout">LayoutProperty</a>></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 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> </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<? 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/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<? 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/layout/Layout.html#reconstruct(java.lang.ClassLoader)">reconstruct</a></strong>(java.lang.ClassLoader 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> </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 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 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 long 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 java.lang.String 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 int 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 java.util.List<<a href="../../../../com/amazon/carbonado/layout/LayoutProperty.html" title="class in com.amazon.carbonado.layout">LayoutProperty</a>> 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 java.util.List<<a href="../../../../com/amazon/carbonado/layout/LayoutProperty.html" title="class in com.amazon.carbonado.layout">LayoutProperty</a>> 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 org.joda.time.DateTime 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 java.lang.String 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 java.lang.String 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 <a href="../../../../com/amazon/carbonado/layout/LayoutOptions.html" title="class in com.amazon.carbonado.layout">LayoutOptions</a> 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 <a href="../../../../com/amazon/carbonado/layout/Layout.html" title="class in com.amazon.carbonado.layout">Layout</a> getGeneration(int 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 <a href="../../../../com/amazon/carbonado/layout/Layout.html" title="class in com.amazon.carbonado.layout">Layout</a> 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 <a href="../../../../com/amazon/carbonado/layout/Layout.html" title="class in com.amazon.carbonado.layout">Layout</a> 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 java.lang.Class<? extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>> 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 java.lang.Class<? extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>> reconstruct(java.lang.ClassLoader 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 int hashCode()</pre> +<dl> +<dt><strong>Overrides:</strong></dt> +<dd><code>hashCode</code> in class <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 boolean equals(java.lang.Object obj)</pre> +<dl> +<dt><strong>Overrides:</strong></dt> +<dd><code>equals</code> in class <code>java.lang.Object</code></dd> +</dl> +</li> +</ul> +<a name="toString()"> +<!-- --> +</a> +<ul class="blockList"> +<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> +<a name="equalLayouts(com.amazon.carbonado.layout.Layout)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>equalLayouts</h4> +<pre>public boolean equalLayouts(<a href="../../../../com/amazon/carbonado/layout/Layout.html" title="class in com.amazon.carbonado.layout">Layout</a> 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 void writeTo(java.io.OutputStream 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: </li> +<li>Nested | </li> +<li>Field | </li> +<li>Constr | </li> +<li><a href="#method_summary">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li>Field | </li> +<li>Constr | </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> diff --git a/apidocs/com/amazon/carbonado/layout/LayoutCapability.html b/apidocs/com/amazon/carbonado/layout/LayoutCapability.html new file mode 100644 index 0000000..ba50e1f --- /dev/null +++ b/apidocs/com/amazon/carbonado/layout/LayoutCapability.html @@ -0,0 +1,253 @@ +<!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>LayoutCapability (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="LayoutCapability (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/LayoutCapability.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/layout/Layout.html" title="class in com.amazon.carbonado.layout"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../com/amazon/carbonado/layout/LayoutFactory.html" title="class 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/LayoutCapability.html" target="_top">Frames</a></li> +<li><a href="LayoutCapability.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>Constr | </li> +<li><a href="#method_summary">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li>Field | </li> +<li>Constr | </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="Interface LayoutCapability" class="title">Interface LayoutCapability</h2> +</div> +<div class="contentContainer"> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<dl> +<dt>All Superinterfaces:</dt> +<dd><a href="../../../../com/amazon/carbonado/capability/Capability.html" title="interface in com.amazon.carbonado.capability">Capability</a></dd> +</dl> +<dl> +<dt>All Known Implementing Classes:</dt> +<dd><a href="../../../../com/amazon/carbonado/layout/LayoutFactory.html" title="class in com.amazon.carbonado.layout">LayoutFactory</a></dd> +</dl> +<hr> +<br> +<pre>public interface <span class="strong">LayoutCapability</span> +extends <a href="../../../../com/amazon/carbonado/capability/Capability.html" title="interface in com.amazon.carbonado.capability">Capability</a></pre> +<div class="block">Capability to get layout information on any storable generation.</div> +<dl><dt><span class="strong">Author:</span></dt> + <dd>Brian S O'Neill</dd></dl> +</li> +</ul> +</div> +<div class="summary"> +<ul class="blockList"> +<li class="blockList"> +<!-- ========== 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/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/LayoutCapability.html#layoutFor(java.lang.Class)">layoutFor</a></strong>(java.lang.Class<? extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>> type)</code> +<div class="block">Returns the layout matching the current definition of the given type.</div> +</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/LayoutCapability.html#layoutFor(java.lang.Class, int)">layoutFor</a></strong>(java.lang.Class<? extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>> type, + int generation)</code> +<div class="block">Returns the layout for a particular generation of the given type.</div> +</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="layoutFor(java.lang.Class)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>layoutFor</h4> +<pre><a href="../../../../com/amazon/carbonado/layout/Layout.html" title="class in com.amazon.carbonado.layout">Layout</a> layoutFor(java.lang.Class<? extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>> type) + throws <a href="../../../../com/amazon/carbonado/FetchException.html" title="class in com.amazon.carbonado">FetchException</a>, + <a href="../../../../com/amazon/carbonado/PersistException.html" title="class in com.amazon.carbonado">PersistException</a></pre> +<div class="block">Returns the layout matching the current definition of the given type.</div> +<dl><dt><span class="strong">Throws:</span></dt> +<dd><code><a href="../../../../com/amazon/carbonado/PersistException.html" title="class in com.amazon.carbonado">PersistException</a></code> - if type represents a new generation, but + persisting this information failed</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="layoutFor(java.lang.Class, int)"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>layoutFor</h4> +<pre><a href="../../../../com/amazon/carbonado/layout/Layout.html" title="class in com.amazon.carbonado.layout">Layout</a> layoutFor(java.lang.Class<? extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>> type, + int generation) + throws <a href="../../../../com/amazon/carbonado/FetchException.html" title="class in com.amazon.carbonado">FetchException</a>, + <a href="../../../../com/amazon/carbonado/FetchNoneException.html" title="class in com.amazon.carbonado">FetchNoneException</a></pre> +<div class="block">Returns the layout for a particular generation of the given type.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>generation</code> - desired generation</dd> +<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> +</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/LayoutCapability.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/layout/Layout.html" title="class in com.amazon.carbonado.layout"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../com/amazon/carbonado/layout/LayoutFactory.html" title="class 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/LayoutCapability.html" target="_top">Frames</a></li> +<li><a href="LayoutCapability.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>Constr | </li> +<li><a href="#method_summary">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li>Field | </li> +<li>Constr | </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> diff --git a/apidocs/com/amazon/carbonado/layout/LayoutFactory.html b/apidocs/com/amazon/carbonado/layout/LayoutFactory.html new file mode 100644 index 0000000..ea086bc --- /dev/null +++ b/apidocs/com/amazon/carbonado/layout/LayoutFactory.html @@ -0,0 +1,421 @@ +<!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>LayoutFactory (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="LayoutFactory (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/LayoutFactory.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/layout/LayoutCapability.html" title="interface in com.amazon.carbonado.layout"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../com/amazon/carbonado/layout/LayoutOptions.html" title="class 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/LayoutFactory.html" target="_top">Frames</a></li> +<li><a href="LayoutFactory.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><a href="#field_summary">Field</a> | </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><a href="#field_detail">Field</a> | </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.layout</div> +<h2 title="Class LayoutFactory" class="title">Class LayoutFactory</h2> +</div> +<div class="contentContainer"> +<ul class="inheritance"> +<li>java.lang.Object</li> +<li> +<ul class="inheritance"> +<li>com.amazon.carbonado.layout.LayoutFactory</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/capability/Capability.html" title="interface in com.amazon.carbonado.capability">Capability</a>, <a href="../../../../com/amazon/carbonado/layout/LayoutCapability.html" title="interface in com.amazon.carbonado.layout">LayoutCapability</a></dd> +</dl> +<hr> +<br> +<pre>public class <span class="strong">LayoutFactory</span> +extends java.lang.Object +implements <a href="../../../../com/amazon/carbonado/layout/LayoutCapability.html" title="interface in com.amazon.carbonado.layout">LayoutCapability</a></pre> +<div class="block">Factory for obtaining references to storable layouts.</div> +<dl><dt><span class="strong">Author:</span></dt> + <dd>Brian S O'Neill</dd></dl> +</li> +</ul> +</div> +<div class="summary"> +<ul class="blockList"> +<li class="blockList"> +<!-- =========== FIELD SUMMARY =========== --> +<ul class="blockList"> +<li class="blockList"><a name="field_summary"> +<!-- --> +</a> +<h3>Field Summary</h3> +<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Field Summary table, listing fields, and an explanation"> +<caption><span>Fields</span><span class="tabEnd"> </span></caption> +<tr> +<th class="colFirst" scope="col">Modifier and Type</th> +<th class="colLast" scope="col">Field and Description</th> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>static int</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/layout/LayoutFactory.html#VERSION">VERSION</a></strong></code> </td> +</tr> +</table> +</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/layout/LayoutFactory.html#LayoutFactory(com.amazon.carbonado.Repository)">LayoutFactory</a></strong>(<a href="../../../../com/amazon/carbonado/Repository.html" title="interface in com.amazon.carbonado">Repository</a> repo)</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/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/LayoutFactory.html#layoutFor(boolean, java.lang.Class, com.amazon.carbonado.layout.LayoutOptions)">layoutFor</a></strong>(boolean readOnly, + java.lang.Class<? extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>> type, + <a href="../../../../com/amazon/carbonado/layout/LayoutOptions.html" title="class in com.amazon.carbonado.layout">LayoutOptions</a> options)</code> +<div class="block">Returns the layout matching the current definition of the given type.</div> +</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/LayoutFactory.html#layoutFor(java.lang.Class)">layoutFor</a></strong>(java.lang.Class<? extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>> type)</code> +<div class="block">Returns the layout matching the current definition of the given type.</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/LayoutFactory.html#layoutFor(java.lang.Class, int)">layoutFor</a></strong>(java.lang.Class<? extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>> type, + int generation)</code> +<div class="block">Returns the layout for a particular generation of the given type.</div> +</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/LayoutFactory.html#layoutFor(java.lang.Class, com.amazon.carbonado.layout.LayoutOptions)">layoutFor</a></strong>(java.lang.Class<? extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>> type, + <a href="../../../../com/amazon/carbonado/layout/LayoutOptions.html" title="class in com.amazon.carbonado.layout">LayoutOptions</a> options)</code> +<div class="block">Returns the layout matching the current definition of the given type.</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/LayoutFactory.html#readLayoutFrom(java.io.InputStream)">readLayoutFrom</a></strong>(java.io.InputStream in)</code> +<div class="block">Read a layout as written by <a href="../../../../com/amazon/carbonado/layout/Layout.html#writeTo(java.io.OutputStream)"><code>Layout.writeTo(java.io.OutputStream)</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 java.lang.Object</h3> +<code>clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</code></li> +</ul> +</li> +</ul> +</li> +</ul> +</div> +<div class="details"> +<ul class="blockList"> +<li class="blockList"> +<!-- ============ FIELD DETAIL =========== --> +<ul class="blockList"> +<li class="blockList"><a name="field_detail"> +<!-- --> +</a> +<h3>Field Detail</h3> +<a name="VERSION"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>VERSION</h4> +<pre>public static final int VERSION</pre> +<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../constant-values.html#com.amazon.carbonado.layout.LayoutFactory.VERSION">Constant Field Values</a></dd></dl> +</li> +</ul> +</li> +</ul> +<!-- ========= CONSTRUCTOR DETAIL ======== --> +<ul class="blockList"> +<li class="blockList"><a name="constructor_detail"> +<!-- --> +</a> +<h3>Constructor Detail</h3> +<a name="LayoutFactory(com.amazon.carbonado.Repository)"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>LayoutFactory</h4> +<pre>public LayoutFactory(<a href="../../../../com/amazon/carbonado/Repository.html" title="interface in com.amazon.carbonado">Repository</a> repo) + throws <a href="../../../../com/amazon/carbonado/RepositoryException.html" title="class in com.amazon.carbonado">RepositoryException</a></pre> +<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> - if underlying repository + does not support the storables for persisting storable layouts</dd> +<dd><code><a href="../../../../com/amazon/carbonado/RepositoryException.html" title="class in com.amazon.carbonado">RepositoryException</a></code></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="layoutFor(java.lang.Class)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>layoutFor</h4> +<pre>public <a href="../../../../com/amazon/carbonado/layout/Layout.html" title="class in com.amazon.carbonado.layout">Layout</a> layoutFor(java.lang.Class<? extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>> type) + throws <a href="../../../../com/amazon/carbonado/FetchException.html" title="class in com.amazon.carbonado">FetchException</a>, + <a href="../../../../com/amazon/carbonado/PersistException.html" title="class in com.amazon.carbonado">PersistException</a></pre> +<div class="block">Returns the layout matching the current definition of the given type.</div> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code><a href="../../../../com/amazon/carbonado/layout/LayoutCapability.html#layoutFor(java.lang.Class)">layoutFor</a></code> in interface <code><a href="../../../../com/amazon/carbonado/layout/LayoutCapability.html" title="interface in com.amazon.carbonado.layout">LayoutCapability</a></code></dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code><a href="../../../../com/amazon/carbonado/PersistException.html" title="class in com.amazon.carbonado">PersistException</a></code> - if type represents a new generation, but + persisting this information failed</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="layoutFor(java.lang.Class, com.amazon.carbonado.layout.LayoutOptions)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>layoutFor</h4> +<pre>public <a href="../../../../com/amazon/carbonado/layout/Layout.html" title="class in com.amazon.carbonado.layout">Layout</a> layoutFor(java.lang.Class<? extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>> type, + <a href="../../../../com/amazon/carbonado/layout/LayoutOptions.html" title="class in com.amazon.carbonado.layout">LayoutOptions</a> options) + throws <a href="../../../../com/amazon/carbonado/FetchException.html" title="class in com.amazon.carbonado">FetchException</a>, + <a href="../../../../com/amazon/carbonado/PersistException.html" title="class in com.amazon.carbonado">PersistException</a></pre> +<div class="block">Returns the layout matching the current definition of the given type.</div> +<dl><dt><span class="strong">Throws:</span></dt> +<dd><code><a href="../../../../com/amazon/carbonado/PersistException.html" title="class in com.amazon.carbonado">PersistException</a></code> - if type represents a new generation, but + persisting this information failed</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="layoutFor(boolean, java.lang.Class, com.amazon.carbonado.layout.LayoutOptions)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>layoutFor</h4> +<pre>public <a href="../../../../com/amazon/carbonado/layout/Layout.html" title="class in com.amazon.carbonado.layout">Layout</a> layoutFor(boolean readOnly, + java.lang.Class<? extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>> type, + <a href="../../../../com/amazon/carbonado/layout/LayoutOptions.html" title="class in com.amazon.carbonado.layout">LayoutOptions</a> options) + throws <a href="../../../../com/amazon/carbonado/FetchException.html" title="class in com.amazon.carbonado">FetchException</a>, + <a href="../../../../com/amazon/carbonado/PersistException.html" title="class in com.amazon.carbonado">PersistException</a></pre> +<div class="block">Returns the layout matching the current definition of the given type.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>readOnly</code> - if true, don't attempt to persist new generation because + underlying repository is read-only</dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code><a href="../../../../com/amazon/carbonado/PersistException.html" title="class in com.amazon.carbonado">PersistException</a></code> - if type represents a new generation, but + persisting this information failed</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="layoutFor(java.lang.Class, int)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>layoutFor</h4> +<pre>public <a href="../../../../com/amazon/carbonado/layout/Layout.html" title="class in com.amazon.carbonado.layout">Layout</a> layoutFor(java.lang.Class<? extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>> type, + int generation) + throws <a href="../../../../com/amazon/carbonado/FetchException.html" title="class in com.amazon.carbonado">FetchException</a>, + <a href="../../../../com/amazon/carbonado/FetchNoneException.html" title="class in com.amazon.carbonado">FetchNoneException</a></pre> +<div class="block">Returns the layout for a particular generation of the given type.</div> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code><a href="../../../../com/amazon/carbonado/layout/LayoutCapability.html#layoutFor(java.lang.Class, int)">layoutFor</a></code> in interface <code><a href="../../../../com/amazon/carbonado/layout/LayoutCapability.html" title="interface in com.amazon.carbonado.layout">LayoutCapability</a></code></dd> +<dt><span class="strong">Parameters:</span></dt><dd><code>generation</code> - desired generation</dd> +<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="readLayoutFrom(java.io.InputStream)"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>readLayoutFrom</h4> +<pre>public <a href="../../../../com/amazon/carbonado/layout/Layout.html" title="class in com.amazon.carbonado.layout">Layout</a> readLayoutFrom(java.io.InputStream in) + throws java.io.IOException, + <a href="../../../../com/amazon/carbonado/RepositoryException.html" title="class in com.amazon.carbonado">RepositoryException</a></pre> +<div class="block">Read a layout as written by <a href="../../../../com/amazon/carbonado/layout/Layout.html#writeTo(java.io.OutputStream)"><code>Layout.writeTo(java.io.OutputStream)</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/LayoutFactory.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/layout/LayoutCapability.html" title="interface in com.amazon.carbonado.layout"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../com/amazon/carbonado/layout/LayoutOptions.html" title="class 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/LayoutFactory.html" target="_top">Frames</a></li> +<li><a href="LayoutFactory.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><a href="#field_summary">Field</a> | </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><a href="#field_detail">Field</a> | </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> diff --git a/apidocs/com/amazon/carbonado/layout/LayoutOptions.html b/apidocs/com/amazon/carbonado/layout/LayoutOptions.html new file mode 100644 index 0000000..f6e36c3 --- /dev/null +++ b/apidocs/com/amazon/carbonado/layout/LayoutOptions.html @@ -0,0 +1,307 @@ +<!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>LayoutOptions (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="LayoutOptions (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/LayoutOptions.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/layout/LayoutFactory.html" title="class in com.amazon.carbonado.layout"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../com/amazon/carbonado/layout/LayoutProperty.html" title="class 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/LayoutOptions.html" target="_top">Frames</a></li> +<li><a href="LayoutOptions.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.layout</div> +<h2 title="Class LayoutOptions" class="title">Class LayoutOptions</h2> +</div> +<div class="contentContainer"> +<ul class="inheritance"> +<li>java.lang.Object</li> +<li> +<ul class="inheritance"> +<li>com.amazon.carbonado.layout.LayoutOptions</li> +</ul> +</li> +</ul> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<hr> +<br> +<pre>public class <span class="strong">LayoutOptions</span> +extends java.lang.Object</pre> +<div class="block">Extra options encoded with a Storable layout.</div> +<dl><dt><span class="strong">Author:</span></dt> + <dd>Brian S O'Neill</dd></dl> +</li> +</ul> +</div> +<div class="summary"> +<ul class="blockList"> +<li class="blockList"> +<!-- ======== CONSTRUCTOR SUMMARY ======== --> +<ul class="blockList"> +<li class="blockList"><a name="constructor_summary"> +<!-- --> +</a> +<h3>Constructor Summary</h3> +<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation"> +<caption><span>Constructors</span><span class="tabEnd"> </span></caption> +<tr> +<th class="colOne" scope="col">Constructor and Description</th> +</tr> +<tr class="altColor"> +<td class="colOne"><code><strong><a href="../../../../com/amazon/carbonado/layout/LayoutOptions.html#LayoutOptions()">LayoutOptions</a></strong>()</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>void</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/layout/LayoutOptions.html#decode(byte[])">decode</a></strong>(byte[] source)</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>byte[]</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/layout/LayoutOptions.html#encode()">encode</a></strong>()</code> </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/LayoutOptions.html#getCompressionType()">getCompressionType</a></strong>()</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/layout/LayoutOptions.html#setCompressionType(java.lang.String)">setCompressionType</a></strong>(java.lang.String type)</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, toString, wait, wait, wait</code></li> +</ul> +</li> +</ul> +</li> +</ul> +</div> +<div class="details"> +<ul class="blockList"> +<li class="blockList"> +<!-- ========= CONSTRUCTOR DETAIL ======== --> +<ul class="blockList"> +<li class="blockList"><a name="constructor_detail"> +<!-- --> +</a> +<h3>Constructor Detail</h3> +<a name="LayoutOptions()"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>LayoutOptions</h4> +<pre>public LayoutOptions()</pre> +</li> +</ul> +</li> +</ul> +<!-- ============ METHOD DETAIL ========== --> +<ul class="blockList"> +<li class="blockList"><a name="method_detail"> +<!-- --> +</a> +<h3>Method Detail</h3> +<a name="getCompressionType()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getCompressionType</h4> +<pre>public java.lang.String getCompressionType()</pre> +<dl><dt><span class="strong">Returns:</span></dt><dd>null if not compressed</dd></dl> +</li> +</ul> +<a name="setCompressionType(java.lang.String)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setCompressionType</h4> +<pre>public void setCompressionType(java.lang.String type)</pre> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>type</code> - null if not compressed</dd></dl> +</li> +</ul> +<a name="encode()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>encode</h4> +<pre>public byte[] encode()</pre> +<dl><dt><span class="strong">Returns:</span></dt><dd>null if empty</dd></dl> +</li> +</ul> +<a name="decode(byte[])"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>decode</h4> +<pre>public void decode(byte[] source) + throws java.io.IOException</pre> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>source</code> - can be null if empty</dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code>java.io.IOException</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/LayoutOptions.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/layout/LayoutFactory.html" title="class in com.amazon.carbonado.layout"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../com/amazon/carbonado/layout/LayoutProperty.html" title="class 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/LayoutOptions.html" target="_top">Frames</a></li> +<li><a href="LayoutOptions.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> diff --git a/apidocs/com/amazon/carbonado/layout/LayoutProperty.html b/apidocs/com/amazon/carbonado/layout/LayoutProperty.html new file mode 100644 index 0000000..0acb8be --- /dev/null +++ b/apidocs/com/amazon/carbonado/layout/LayoutProperty.html @@ -0,0 +1,410 @@ +<!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>LayoutProperty (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="LayoutProperty (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/LayoutProperty.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/layout/LayoutOptions.html" title="class in com.amazon.carbonado.layout"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../com/amazon/carbonado/layout/LayoutSync.html" title="class 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/LayoutProperty.html" target="_top">Frames</a></li> +<li><a href="LayoutProperty.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>Constr | </li> +<li><a href="#method_summary">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li>Field | </li> +<li>Constr | </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 LayoutProperty" class="title">Class LayoutProperty</h2> +</div> +<div class="contentContainer"> +<ul class="inheritance"> +<li>java.lang.Object</li> +<li> +<ul class="inheritance"> +<li>com.amazon.carbonado.layout.LayoutProperty</li> +</ul> +</li> +</ul> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<hr> +<br> +<pre>public class <span class="strong">LayoutProperty</span> +extends java.lang.Object</pre> +<div class="block">Describes how a property is defined in 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/Layout.html" title="class in com.amazon.carbonado.layout"><code>Layout</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"> </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/LayoutProperty.html#equals(java.lang.Object)">equals</a></strong>(java.lang.Object obj)</code> </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/LayoutProperty.html#getAdapterParams()">getAdapterParams</a></strong>()</code> +<div class="block">Parameters for adapter, or null if property has no explicit adapter.</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/LayoutProperty.html#getAdapterTypeName()">getAdapterTypeName</a></strong>()</code> +<div class="block">Adapter type name is a fully qualified Java class name.</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/LayoutProperty.html#getPropertyName()">getPropertyName</a></strong>()</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>java.lang.Class</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/layout/LayoutProperty.html#getPropertyType()">getPropertyType</a></strong>()</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>java.lang.Class</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/layout/LayoutProperty.html#getPropertyType(java.lang.ClassLoader)">getPropertyType</a></strong>(java.lang.ClassLoader loader)</code> </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/LayoutProperty.html#getPropertyTypeDescriptor()">getPropertyTypeDescriptor</a></strong>()</code> +<div class="block">Property type descriptor is a Java type descriptor.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>int</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/layout/LayoutProperty.html#hashCode()">hashCode</a></strong>()</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/layout/LayoutProperty.html#isNullable()">isNullable</a></strong>()</code> +<div class="block">Returns true of property can be set to null.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/layout/LayoutProperty.html#isPrimaryKeyMember()">isPrimaryKeyMember</a></strong>()</code> +<div class="block">Returns true if property is a member of the primary key.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/layout/LayoutProperty.html#isVersion()">isVersion</a></strong>()</code> +<div class="block">Returns true if this property is the designated version number for the + Storable.</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/LayoutProperty.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, 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="getPropertyName()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getPropertyName</h4> +<pre>public java.lang.String getPropertyName()</pre> +</li> +</ul> +<a name="getPropertyTypeDescriptor()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getPropertyTypeDescriptor</h4> +<pre>public java.lang.String getPropertyTypeDescriptor()</pre> +<div class="block">Property type descriptor is a Java type descriptor.</div> +</li> +</ul> +<a name="getPropertyType()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getPropertyType</h4> +<pre>public java.lang.Class getPropertyType() + throws <a href="../../../../com/amazon/carbonado/SupportException.html" title="class in com.amazon.carbonado">SupportException</a></pre> +<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="getPropertyType(java.lang.ClassLoader)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getPropertyType</h4> +<pre>public java.lang.Class getPropertyType(java.lang.ClassLoader loader) + throws <a href="../../../../com/amazon/carbonado/SupportException.html" title="class in com.amazon.carbonado">SupportException</a></pre> +<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="isNullable()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>isNullable</h4> +<pre>public boolean isNullable()</pre> +<div class="block">Returns true of property can be set to null.</div> +</li> +</ul> +<a name="isPrimaryKeyMember()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>isPrimaryKeyMember</h4> +<pre>public boolean isPrimaryKeyMember()</pre> +<div class="block">Returns true if property is a member of the primary key.</div> +</li> +</ul> +<a name="isVersion()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>isVersion</h4> +<pre>public boolean isVersion()</pre> +<div class="block">Returns true if this property is the designated version number for the + Storable.</div> +</li> +</ul> +<a name="getAdapterTypeName()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getAdapterTypeName</h4> +<pre>public java.lang.String getAdapterTypeName()</pre> +<div class="block">Adapter type name is a fully qualified Java class name. If property has + no adapter, then null is returned.</div> +</li> +</ul> +<a name="getAdapterParams()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getAdapterParams</h4> +<pre>public java.lang.String getAdapterParams()</pre> +<div class="block">Parameters for adapter, or null if property has no explicit adapter.</div> +</li> +</ul> +<a name="hashCode()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>hashCode</h4> +<pre>public int hashCode()</pre> +<dl> +<dt><strong>Overrides:</strong></dt> +<dd><code>hashCode</code> in class <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 boolean equals(java.lang.Object obj)</pre> +<dl> +<dt><strong>Overrides:</strong></dt> +<dd><code>equals</code> in class <code>java.lang.Object</code></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/LayoutProperty.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/layout/LayoutOptions.html" title="class in com.amazon.carbonado.layout"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../com/amazon/carbonado/layout/LayoutSync.html" title="class 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/LayoutProperty.html" target="_top">Frames</a></li> +<li><a href="LayoutProperty.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>Constr | </li> +<li><a href="#method_summary">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li>Field | </li> +<li>Constr | </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> diff --git a/apidocs/com/amazon/carbonado/layout/LayoutSync.html b/apidocs/com/amazon/carbonado/layout/LayoutSync.html new file mode 100644 index 0000000..c9b784b --- /dev/null +++ b/apidocs/com/amazon/carbonado/layout/LayoutSync.html @@ -0,0 +1,268 @@ +<!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>LayoutSync (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="LayoutSync (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/LayoutSync.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/layout/LayoutProperty.html" title="class in com.amazon.carbonado.layout"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../com/amazon/carbonado/layout/StoredLayout.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/LayoutSync.html" target="_top">Frames</a></li> +<li><a href="LayoutSync.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.layout</div> +<h2 title="Class LayoutSync" class="title">Class LayoutSync</h2> +</div> +<div class="contentContainer"> +<ul class="inheritance"> +<li>java.lang.Object</li> +<li> +<ul class="inheritance"> +<li>com.amazon.carbonado.layout.LayoutSync</li> +</ul> +</li> +</ul> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<hr> +<br> +<pre>public class <span class="strong">LayoutSync</span> +extends java.lang.Object</pre> +<div class="block">Synchronizes layout metadata between two repositories. Both source and + destination might be updated.</div> +<dl><dt><span class="strong">Author:</span></dt> + <dd>Brian S O'Neill</dd></dl> +</li> +</ul> +</div> +<div class="summary"> +<ul class="blockList"> +<li class="blockList"> +<!-- ======== CONSTRUCTOR SUMMARY ======== --> +<ul class="blockList"> +<li class="blockList"><a name="constructor_summary"> +<!-- --> +</a> +<h3>Constructor Summary</h3> +<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation"> +<caption><span>Constructors</span><span class="tabEnd"> </span></caption> +<tr> +<th class="colOne" scope="col">Constructor and Description</th> +</tr> +<tr class="altColor"> +<td class="colOne"><code><strong><a href="../../../../com/amazon/carbonado/layout/LayoutSync.html#LayoutSync(com.amazon.carbonado.Repository, com.amazon.carbonado.Repository)">LayoutSync</a></strong>(<a href="../../../../com/amazon/carbonado/Repository.html" title="interface in com.amazon.carbonado">Repository</a> source, + <a href="../../../../com/amazon/carbonado/Repository.html" title="interface in com.amazon.carbonado">Repository</a> destination)</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>boolean</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/layout/LayoutSync.html#run()">run</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, toString, wait, wait, wait</code></li> +</ul> +</li> +</ul> +</li> +</ul> +</div> +<div class="details"> +<ul class="blockList"> +<li class="blockList"> +<!-- ========= CONSTRUCTOR DETAIL ======== --> +<ul class="blockList"> +<li class="blockList"><a name="constructor_detail"> +<!-- --> +</a> +<h3>Constructor Detail</h3> +<a name="LayoutSync(com.amazon.carbonado.Repository, com.amazon.carbonado.Repository)"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>LayoutSync</h4> +<pre>public LayoutSync(<a href="../../../../com/amazon/carbonado/Repository.html" title="interface in com.amazon.carbonado">Repository</a> source, + <a href="../../../../com/amazon/carbonado/Repository.html" title="interface in com.amazon.carbonado">Repository</a> destination)</pre> +</li> +</ul> +</li> +</ul> +<!-- ============ METHOD DETAIL ========== --> +<ul class="blockList"> +<li class="blockList"><a name="method_detail"> +<!-- --> +</a> +<h3>Method Detail</h3> +<a name="run()"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>run</h4> +<pre>public boolean run() + throws <a href="../../../../com/amazon/carbonado/RepositoryException.html" title="class in com.amazon.carbonado">RepositoryException</a></pre> +<dl><dt><span class="strong">Returns:</span></dt><dd>true if any changes to source were made</dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code><a href="../../../../com/amazon/carbonado/RepositoryException.html" title="class in com.amazon.carbonado">RepositoryException</a></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/LayoutSync.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/layout/LayoutProperty.html" title="class in com.amazon.carbonado.layout"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../com/amazon/carbonado/layout/StoredLayout.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/LayoutSync.html" target="_top">Frames</a></li> +<li><a href="LayoutSync.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> diff --git a/apidocs/com/amazon/carbonado/layout/StoredLayout.html b/apidocs/com/amazon/carbonado/layout/StoredLayout.html new file mode 100644 index 0000000..6652179 --- /dev/null +++ b/apidocs/com/amazon/carbonado/layout/StoredLayout.html @@ -0,0 +1,456 @@ +<!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>StoredLayout (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="StoredLayout (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/StoredLayout.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/layout/LayoutSync.html" title="class in com.amazon.carbonado.layout"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../com/amazon/carbonado/layout/StoredLayoutEquivalence.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/StoredLayout.html" target="_top">Frames</a></li> +<li><a href="StoredLayout.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>Constr | </li> +<li><a href="#method_summary">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li>Field | </li> +<li>Constr | </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="Interface StoredLayout" class="title">Interface StoredLayout</h2> +</div> +<div class="contentContainer"> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<dl> +<dt>All Superinterfaces:</dt> +<dd><a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a><<a href="../../../../com/amazon/carbonado/layout/StoredLayout.html" title="interface in com.amazon.carbonado.layout">StoredLayout</a>>, <a href="../../../../com/amazon/carbonado/layout/Unevolvable.html" title="interface in com.amazon.carbonado.layout">Unevolvable</a></dd> +</dl> +<hr> +<br> +<pre><a href="../../../../com/amazon/carbonado/AlternateKeys.html" title="annotation in com.amazon.carbonado">@AlternateKeys</a>(<a href="../../../../com/amazon/carbonado/AlternateKeys.html#value()">value</a>=<a href="../../../../com/amazon/carbonado/Key.html" title="annotation in com.amazon.carbonado">@Key</a>(<a href="../../../../com/amazon/carbonado/Key.html#value()">value</a>={"storableTypeName","generation"})) +<a href="../../../../com/amazon/carbonado/PrimaryKey.html" title="annotation in com.amazon.carbonado">@PrimaryKey</a>(<a href="../../../../com/amazon/carbonado/PrimaryKey.html#value()">value</a>="layoutID") +<a href="../../../../com/amazon/carbonado/Independent.html" title="annotation in com.amazon.carbonado">@Independent</a> +<a href="../../../../com/amazon/carbonado/Alias.html" title="annotation in com.amazon.carbonado">@Alias</a>(<a href="../../../../com/amazon/carbonado/Alias.html#value()">value</a>="CARBONADO_LAYOUT") +public interface <span class="strong">StoredLayout</span> +extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a><<a href="../../../../com/amazon/carbonado/layout/StoredLayout.html" title="interface in com.amazon.carbonado.layout">StoredLayout</a>>, <a href="../../../../com/amazon/carbonado/layout/Unevolvable.html" title="interface in com.amazon.carbonado.layout">Unevolvable</a></pre> +<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>. This interface is public only because + Carbonado requires storable type definitions to be public.</div> +<dl><dt><span class="strong">Author:</span></dt> + <dd>Brian S O'Neill</dd></dl> +</li> +</ul> +</div> +<div class="summary"> +<ul class="blockList"> +<li class="blockList"> +<!-- ========== 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>java.lang.String</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/layout/StoredLayout.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>long</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/layout/StoredLayout.html#getCreationTimestamp()">getCreationTimestamp</a></strong>()</code> +<div class="block">Returns the milliseconds from 1970-01-01T00:00:00Z when this record 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/StoredLayout.html#getCreationUser()">getCreationUser</a></strong>()</code> +<div class="block">Returns the user that created this generation.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>byte[]</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/layout/StoredLayout.html#getExtraData()">getExtraData</a></strong>()</code> +<div class="block">Since this record cannot evolve, this property allows it to be extended + without conflicting with existing records.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>int</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/layout/StoredLayout.html#getGeneration()">getGeneration</a></strong>()</code> +<div class="block">Generation of storable, where 0 represents the first generation.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>long</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/layout/StoredLayout.html#getLayoutID()">getLayoutID</a></strong>()</code> </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/StoredLayout.html#getStorableTypeName()">getStorableTypeName</a></strong>()</code> +<div class="block">Storable type name is a fully qualified Java class name.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>int</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/layout/StoredLayout.html#getVersionNumber()">getVersionNumber</a></strong>()</code> +<div class="block">Record version number for this StoredTypeLayout instance.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/layout/StoredLayout.html#setCreationHost(java.lang.String)">setCreationHost</a></strong>(java.lang.String host)</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/layout/StoredLayout.html#setCreationTimestamp(long)">setCreationTimestamp</a></strong>(long timestamp)</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/layout/StoredLayout.html#setCreationUser(java.lang.String)">setCreationUser</a></strong>(java.lang.String user)</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/layout/StoredLayout.html#setExtraData(byte[])">setExtraData</a></strong>(byte[] data)</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/layout/StoredLayout.html#setGeneration(int)">setGeneration</a></strong>(int generation)</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/layout/StoredLayout.html#setLayoutID(long)">setLayoutID</a></strong>(long typeID)</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/layout/StoredLayout.html#setStorableTypeName(java.lang.String)">setStorableTypeName</a></strong>(java.lang.String typeName)</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/layout/StoredLayout.html#setVersionNumber(int)">setVersionNumber</a></strong>(int version)</code> </td> +</tr> +</table> +<ul class="blockList"> +<li class="blockList"><a name="methods_inherited_from_class_com.amazon.carbonado.Storable"> +<!-- --> +</a> +<h3>Methods inherited from interface com.amazon.carbonado.<a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a></h3> +<code><a href="../../../../com/amazon/carbonado/Storable.html#copy()">copy</a>, <a href="../../../../com/amazon/carbonado/Storable.html#copyAllProperties(S)">copyAllProperties</a>, <a href="../../../../com/amazon/carbonado/Storable.html#copyDirtyProperties(S)">copyDirtyProperties</a>, <a href="../../../../com/amazon/carbonado/Storable.html#copyPrimaryKeyProperties(S)">copyPrimaryKeyProperties</a>, <a href="../../../../com/amazon/carbonado/Storable.html#copyUnequalProperties(S)">copyUnequalProperties</a>, <a href="../../../../com/amazon/carbonado/Storable.html#copyVersionProperty(S)">copyVersionProperty</a>, <a href="../../../../com/amazon/carbonado/Storable.html#delete()">delete</a>, <a href="../../../../com/amazon/carbonado/Storable.html#equalPrimaryKeys(java.lang.Object)">equalPrimaryKeys</a>, <a href="../../../../com/amazon/carbonado/Storable.html#equalProperties(java.lang.Object)">equalProperties</a>, <a href="../../../../com/amazon/carbonado/Storable.html#equals(java.lang.Object)">equals</a>, <a href="../../../../com/amazon/carbonado/Storable.html#getPropertyValue(java.lang.String)">getPropertyValue</a>, <a href="../../../../com/amazon/carbonado/Storable.html#hasDirtyProperties()">hasDirtyProperties</a>, <a href="../../../../com/amazon/carbonado/Storable.html#hashCode()">hashCode</a>, <a href="../../../../com/amazon/carbonado/Storable.html#insert()">insert</a>, <a href="../../../../com/amazon/carbonado/Storable.html#isPropertyClean(java.lang.String)">isPropertyClean</a>, <a href="../../../../com/amazon/carbonado/Storable.html#isPropertyDirty(java.lang.String)">isPropertyDirty</a>, <a href="../../../../com/amazon/carbonado/Storable.html#isPropertySupported(java.lang.String)">isPropertySupported</a>, <a href="../../../../com/amazon/carbonado/Storable.html#isPropertyUninitialized(java.lang.String)">isPropertyUninitialized</a>, <a href="../../../../com/amazon/carbonado/Storable.html#load()">load</a>, <a href="../../../../com/amazon/carbonado/Storable.html#markAllPropertiesClean()">markAllPropertiesClean</a>, <a href="../../../../com/amazon/carbonado/Storable.html#markAllPropertiesDirty()">markAllPropertiesDirty</a>, <a href="../../../../com/amazon/carbonado/Storable.html#markPropertiesClean()">markPropertiesClean</a>, <a href="../../../../com/amazon/carbonado/Storable.html#markPropertiesDirty()">markPropertiesDirty</a>, <a href="../../../../com/amazon/carbonado/Storable.html#prepare()">prepare</a>, <a href="../../../../com/amazon/carbonado/Storable.html#propertyMap()">propertyMap</a>, <a href="../../../../com/amazon/carbonado/Storable.html#readFrom(java.io.InputStream)">readFrom</a>, <a href="../../../../com/amazon/carbonado/Storable.html#setPropertyValue(java.lang.String, java.lang.Object)">setPropertyValue</a>, <a href="../../../../com/amazon/carbonado/Storable.html#storableType()">storableType</a>, <a href="../../../../com/amazon/carbonado/Storable.html#toString()">toString</a>, <a href="../../../../com/amazon/carbonado/Storable.html#toStringKeyOnly()">toStringKeyOnly</a>, <a href="../../../../com/amazon/carbonado/Storable.html#tryDelete()">tryDelete</a>, <a href="../../../../com/amazon/carbonado/Storable.html#tryInsert()">tryInsert</a>, <a href="../../../../com/amazon/carbonado/Storable.html#tryLoad()">tryLoad</a>, <a href="../../../../com/amazon/carbonado/Storable.html#tryUpdate()">tryUpdate</a>, <a href="../../../../com/amazon/carbonado/Storable.html#update()">update</a>, <a href="../../../../com/amazon/carbonado/Storable.html#writeTo(java.io.OutputStream)">writeTo</a></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>long getLayoutID()</pre> +</li> +</ul> +<a name="setLayoutID(long)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setLayoutID</h4> +<pre>void setLayoutID(long typeID)</pre> +</li> +</ul> +<a name="getStorableTypeName()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getStorableTypeName</h4> +<pre>java.lang.String getStorableTypeName()</pre> +<div class="block">Storable type name is a fully qualified Java class name.</div> +</li> +</ul> +<a name="setStorableTypeName(java.lang.String)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setStorableTypeName</h4> +<pre>void setStorableTypeName(java.lang.String typeName)</pre> +</li> +</ul> +<a name="getGeneration()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getGeneration</h4> +<pre>int getGeneration()</pre> +<div class="block">Generation of storable, where 0 represents the first generation.</div> +</li> +</ul> +<a name="setGeneration(int)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setGeneration</h4> +<pre>void setGeneration(int generation)</pre> +</li> +</ul> +<a name="getCreationTimestamp()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getCreationTimestamp</h4> +<pre>long getCreationTimestamp()</pre> +<div class="block">Returns the milliseconds from 1970-01-01T00:00:00Z when this record was + created.</div> +</li> +</ul> +<a name="setCreationTimestamp(long)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setCreationTimestamp</h4> +<pre>void setCreationTimestamp(long timestamp)</pre> +</li> +</ul> +<a name="getCreationUser()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getCreationUser</h4> +<pre><a href="../../../../com/amazon/carbonado/Nullable.html" title="annotation in com.amazon.carbonado">@Nullable</a> +java.lang.String getCreationUser()</pre> +<div class="block">Returns the user that created this generation.</div> +</li> +</ul> +<a name="setCreationUser(java.lang.String)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setCreationUser</h4> +<pre>void setCreationUser(java.lang.String user)</pre> +</li> +</ul> +<a name="getCreationHost()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getCreationHost</h4> +<pre><a href="../../../../com/amazon/carbonado/Nullable.html" title="annotation in com.amazon.carbonado">@Nullable</a> +java.lang.String getCreationHost()</pre> +<div class="block">Returns the host machine that created this generation.</div> +</li> +</ul> +<a name="setCreationHost(java.lang.String)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setCreationHost</h4> +<pre>void setCreationHost(java.lang.String host)</pre> +</li> +</ul> +<a name="getVersionNumber()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getVersionNumber</h4> +<pre><a href="../../../../com/amazon/carbonado/Version.html" title="annotation in com.amazon.carbonado">@Version</a> +int getVersionNumber()</pre> +<div class="block">Record version number for this StoredTypeLayout instance. Some encoding + strategies require a version number.</div> +</li> +</ul> +<a name="setVersionNumber(int)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setVersionNumber</h4> +<pre>void setVersionNumber(int version)</pre> +</li> +</ul> +<a name="getExtraData()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getExtraData</h4> +<pre><a href="../../../../com/amazon/carbonado/Nullable.html" title="annotation in com.amazon.carbonado">@Nullable</a> +byte[] getExtraData()</pre> +<div class="block">Since this record cannot evolve, this property allows it to be extended + without conflicting with existing records. This record cannot evolve + because an evolution strategy likely depends on this interface remaining + stable, avoiding a cyclic dependency.</div> +</li> +</ul> +<a name="setExtraData(byte[])"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>setExtraData</h4> +<pre>void setExtraData(byte[] data)</pre> +</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/StoredLayout.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/layout/LayoutSync.html" title="class in com.amazon.carbonado.layout"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../com/amazon/carbonado/layout/StoredLayoutEquivalence.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/StoredLayout.html" target="_top">Frames</a></li> +<li><a href="StoredLayout.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>Constr | </li> +<li><a href="#method_summary">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li>Field | </li> +<li>Constr | </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> diff --git a/apidocs/com/amazon/carbonado/layout/StoredLayoutEquivalence.html b/apidocs/com/amazon/carbonado/layout/StoredLayoutEquivalence.html new file mode 100644 index 0000000..e95aa3d --- /dev/null +++ b/apidocs/com/amazon/carbonado/layout/StoredLayoutEquivalence.html @@ -0,0 +1,354 @@ +<!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>StoredLayoutEquivalence (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="StoredLayoutEquivalence (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/StoredLayoutEquivalence.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/layout/StoredLayout.html" title="interface in com.amazon.carbonado.layout"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../com/amazon/carbonado/layout/StoredLayoutProperty.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/StoredLayoutEquivalence.html" target="_top">Frames</a></li> +<li><a href="StoredLayoutEquivalence.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>Constr | </li> +<li><a href="#method_summary">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li>Field | </li> +<li>Constr | </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="Interface StoredLayoutEquivalence" class="title">Interface StoredLayoutEquivalence</h2> +</div> +<div class="contentContainer"> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<dl> +<dt>All Superinterfaces:</dt> +<dd><a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a><<a href="../../../../com/amazon/carbonado/layout/StoredLayoutEquivalence.html" title="interface in com.amazon.carbonado.layout">StoredLayoutEquivalence</a>>, <a href="../../../../com/amazon/carbonado/layout/Unevolvable.html" title="interface in com.amazon.carbonado.layout">Unevolvable</a></dd> +</dl> +<hr> +<br> +<pre><a href="../../../../com/amazon/carbonado/PrimaryKey.html" title="annotation in com.amazon.carbonado">@PrimaryKey</a>(<a href="../../../../com/amazon/carbonado/PrimaryKey.html#value()">value</a>={"storableTypeName","generation"}) +<a href="../../../../com/amazon/carbonado/Independent.html" title="annotation in com.amazon.carbonado">@Independent</a> +<a href="../../../../com/amazon/carbonado/Alias.html" title="annotation in com.amazon.carbonado">@Alias</a>(<a href="../../../../com/amazon/carbonado/Alias.html#value()">value</a>="CARBONADO_LAYOUT_EQUIV") +public interface <span class="strong">StoredLayoutEquivalence</span> +extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a><<a href="../../../../com/amazon/carbonado/layout/StoredLayoutEquivalence.html" title="interface in com.amazon.carbonado.layout">StoredLayoutEquivalence</a>>, <a href="../../../../com/amazon/carbonado/layout/Unevolvable.html" title="interface in com.amazon.carbonado.layout">Unevolvable</a></pre> +<div class="block">Maps layout generations which are equivalent.</div> +<dl><dt><span class="strong">Author:</span></dt> + <dd>Brian S O'Neill</dd></dl> +</li> +</ul> +</div> +<div class="summary"> +<ul class="blockList"> +<li class="blockList"> +<!-- ========== 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>byte[]</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/layout/StoredLayoutEquivalence.html#getExtraData()">getExtraData</a></strong>()</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>int</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/layout/StoredLayoutEquivalence.html#getGeneration()">getGeneration</a></strong>()</code> +<div class="block">Generation of storable, where 0 represents the first generation.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>int</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/layout/StoredLayoutEquivalence.html#getMatchedGeneration()">getMatchedGeneration</a></strong>()</code> +<div class="block">Generation of matched layout.</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/StoredLayoutEquivalence.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/StoredLayoutEquivalence.html#getVersionNumber()">getVersionNumber</a></strong>()</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/layout/StoredLayoutEquivalence.html#setExtraData(byte[])">setExtraData</a></strong>(byte[] data)</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/layout/StoredLayoutEquivalence.html#setGeneration(int)">setGeneration</a></strong>(int generation)</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/layout/StoredLayoutEquivalence.html#setMatchedGeneration(int)">setMatchedGeneration</a></strong>(int generation)</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/layout/StoredLayoutEquivalence.html#setStorableTypeName(java.lang.String)">setStorableTypeName</a></strong>(java.lang.String typeName)</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/layout/StoredLayoutEquivalence.html#setVersionNumber(int)">setVersionNumber</a></strong>(int version)</code> </td> +</tr> +</table> +<ul class="blockList"> +<li class="blockList"><a name="methods_inherited_from_class_com.amazon.carbonado.Storable"> +<!-- --> +</a> +<h3>Methods inherited from interface com.amazon.carbonado.<a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a></h3> +<code><a href="../../../../com/amazon/carbonado/Storable.html#copy()">copy</a>, <a href="../../../../com/amazon/carbonado/Storable.html#copyAllProperties(S)">copyAllProperties</a>, <a href="../../../../com/amazon/carbonado/Storable.html#copyDirtyProperties(S)">copyDirtyProperties</a>, <a href="../../../../com/amazon/carbonado/Storable.html#copyPrimaryKeyProperties(S)">copyPrimaryKeyProperties</a>, <a href="../../../../com/amazon/carbonado/Storable.html#copyUnequalProperties(S)">copyUnequalProperties</a>, <a href="../../../../com/amazon/carbonado/Storable.html#copyVersionProperty(S)">copyVersionProperty</a>, <a href="../../../../com/amazon/carbonado/Storable.html#delete()">delete</a>, <a href="../../../../com/amazon/carbonado/Storable.html#equalPrimaryKeys(java.lang.Object)">equalPrimaryKeys</a>, <a href="../../../../com/amazon/carbonado/Storable.html#equalProperties(java.lang.Object)">equalProperties</a>, <a href="../../../../com/amazon/carbonado/Storable.html#equals(java.lang.Object)">equals</a>, <a href="../../../../com/amazon/carbonado/Storable.html#getPropertyValue(java.lang.String)">getPropertyValue</a>, <a href="../../../../com/amazon/carbonado/Storable.html#hasDirtyProperties()">hasDirtyProperties</a>, <a href="../../../../com/amazon/carbonado/Storable.html#hashCode()">hashCode</a>, <a href="../../../../com/amazon/carbonado/Storable.html#insert()">insert</a>, <a href="../../../../com/amazon/carbonado/Storable.html#isPropertyClean(java.lang.String)">isPropertyClean</a>, <a href="../../../../com/amazon/carbonado/Storable.html#isPropertyDirty(java.lang.String)">isPropertyDirty</a>, <a href="../../../../com/amazon/carbonado/Storable.html#isPropertySupported(java.lang.String)">isPropertySupported</a>, <a href="../../../../com/amazon/carbonado/Storable.html#isPropertyUninitialized(java.lang.String)">isPropertyUninitialized</a>, <a href="../../../../com/amazon/carbonado/Storable.html#load()">load</a>, <a href="../../../../com/amazon/carbonado/Storable.html#markAllPropertiesClean()">markAllPropertiesClean</a>, <a href="../../../../com/amazon/carbonado/Storable.html#markAllPropertiesDirty()">markAllPropertiesDirty</a>, <a href="../../../../com/amazon/carbonado/Storable.html#markPropertiesClean()">markPropertiesClean</a>, <a href="../../../../com/amazon/carbonado/Storable.html#markPropertiesDirty()">markPropertiesDirty</a>, <a href="../../../../com/amazon/carbonado/Storable.html#prepare()">prepare</a>, <a href="../../../../com/amazon/carbonado/Storable.html#propertyMap()">propertyMap</a>, <a href="../../../../com/amazon/carbonado/Storable.html#readFrom(java.io.InputStream)">readFrom</a>, <a href="../../../../com/amazon/carbonado/Storable.html#setPropertyValue(java.lang.String, java.lang.Object)">setPropertyValue</a>, <a href="../../../../com/amazon/carbonado/Storable.html#storableType()">storableType</a>, <a href="../../../../com/amazon/carbonado/Storable.html#toString()">toString</a>, <a href="../../../../com/amazon/carbonado/Storable.html#toStringKeyOnly()">toStringKeyOnly</a>, <a href="../../../../com/amazon/carbonado/Storable.html#tryDelete()">tryDelete</a>, <a href="../../../../com/amazon/carbonado/Storable.html#tryInsert()">tryInsert</a>, <a href="../../../../com/amazon/carbonado/Storable.html#tryLoad()">tryLoad</a>, <a href="../../../../com/amazon/carbonado/Storable.html#tryUpdate()">tryUpdate</a>, <a href="../../../../com/amazon/carbonado/Storable.html#update()">update</a>, <a href="../../../../com/amazon/carbonado/Storable.html#writeTo(java.io.OutputStream)">writeTo</a></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="getStorableTypeName()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getStorableTypeName</h4> +<pre>java.lang.String getStorableTypeName()</pre> +<div class="block">Storable type name is a fully qualified Java class name.</div> +</li> +</ul> +<a name="setStorableTypeName(java.lang.String)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setStorableTypeName</h4> +<pre>void setStorableTypeName(java.lang.String typeName)</pre> +</li> +</ul> +<a name="getGeneration()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getGeneration</h4> +<pre>int getGeneration()</pre> +<div class="block">Generation of storable, where 0 represents the first generation.</div> +</li> +</ul> +<a name="setGeneration(int)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setGeneration</h4> +<pre>void setGeneration(int generation)</pre> +</li> +</ul> +<a name="getMatchedGeneration()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getMatchedGeneration</h4> +<pre>int getMatchedGeneration()</pre> +<div class="block">Generation of matched layout.</div> +</li> +</ul> +<a name="setMatchedGeneration(int)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setMatchedGeneration</h4> +<pre>void setMatchedGeneration(int generation)</pre> +</li> +</ul> +<a name="getVersionNumber()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getVersionNumber</h4> +<pre><a href="../../../../com/amazon/carbonado/Version.html" title="annotation in com.amazon.carbonado">@Version</a> +int getVersionNumber()</pre> +</li> +</ul> +<a name="setVersionNumber(int)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setVersionNumber</h4> +<pre>void setVersionNumber(int version)</pre> +</li> +</ul> +<a name="getExtraData()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getExtraData</h4> +<pre><a href="../../../../com/amazon/carbonado/Nullable.html" title="annotation in com.amazon.carbonado">@Nullable</a> +byte[] getExtraData()</pre> +</li> +</ul> +<a name="setExtraData(byte[])"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>setExtraData</h4> +<pre>void setExtraData(byte[] data)</pre> +</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/StoredLayoutEquivalence.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/layout/StoredLayout.html" title="interface in com.amazon.carbonado.layout"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../com/amazon/carbonado/layout/StoredLayoutProperty.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/StoredLayoutEquivalence.html" target="_top">Frames</a></li> +<li><a href="StoredLayoutEquivalence.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>Constr | </li> +<li><a href="#method_summary">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li>Field | </li> +<li>Constr | </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> diff --git a/apidocs/com/amazon/carbonado/layout/StoredLayoutProperty.html b/apidocs/com/amazon/carbonado/layout/StoredLayoutProperty.html new file mode 100644 index 0000000..404f05a --- /dev/null +++ b/apidocs/com/amazon/carbonado/layout/StoredLayoutProperty.html @@ -0,0 +1,543 @@ +<!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>StoredLayoutProperty (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="StoredLayoutProperty (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/StoredLayoutProperty.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/layout/StoredLayoutEquivalence.html" title="interface in com.amazon.carbonado.layout"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../com/amazon/carbonado/layout/Unevolvable.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/StoredLayoutProperty.html" target="_top">Frames</a></li> +<li><a href="StoredLayoutProperty.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>Constr | </li> +<li><a href="#method_summary">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li>Field | </li> +<li>Constr | </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="Interface StoredLayoutProperty" class="title">Interface StoredLayoutProperty</h2> +</div> +<div class="contentContainer"> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<dl> +<dt>All Superinterfaces:</dt> +<dd><a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a><<a href="../../../../com/amazon/carbonado/layout/StoredLayoutProperty.html" title="interface in com.amazon.carbonado.layout">StoredLayoutProperty</a>>, <a href="../../../../com/amazon/carbonado/layout/Unevolvable.html" title="interface in com.amazon.carbonado.layout">Unevolvable</a></dd> +</dl> +<hr> +<br> +<pre><a href="../../../../com/amazon/carbonado/AlternateKeys.html" title="annotation in com.amazon.carbonado">@AlternateKeys</a>(<a href="../../../../com/amazon/carbonado/AlternateKeys.html#value()">value</a>=<a href="../../../../com/amazon/carbonado/Key.html" title="annotation in com.amazon.carbonado">@Key</a>(<a href="../../../../com/amazon/carbonado/Key.html#value()">value</a>={"layoutID","propertyName"})) +<a href="../../../../com/amazon/carbonado/PrimaryKey.html" title="annotation in com.amazon.carbonado">@PrimaryKey</a>(<a href="../../../../com/amazon/carbonado/PrimaryKey.html#value()">value</a>={"layoutID","ordinal"}) +<a href="../../../../com/amazon/carbonado/Independent.html" title="annotation in com.amazon.carbonado">@Independent</a> +<a href="../../../../com/amazon/carbonado/Alias.html" title="annotation in com.amazon.carbonado">@Alias</a>(<a href="../../../../com/amazon/carbonado/Alias.html#value()">value</a>="CARBONADO_LAYOUT_PROPERTY") +public interface <span class="strong">StoredLayoutProperty</span> +extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a><<a href="../../../../com/amazon/carbonado/layout/StoredLayoutProperty.html" title="interface in com.amazon.carbonado.layout">StoredLayoutProperty</a>>, <a href="../../../../com/amazon/carbonado/layout/Unevolvable.html" title="interface in com.amazon.carbonado.layout">Unevolvable</a></pre> +<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>. This interface is public only because Carbonado + requires storable type definitions to be public.</div> +<dl><dt><span class="strong">Author:</span></dt> + <dd>Brian S O'Neill</dd></dl> +</li> +</ul> +</div> +<div class="summary"> +<ul class="blockList"> +<li class="blockList"> +<!-- ========== 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>java.lang.String</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/layout/StoredLayoutProperty.html#getAdapterParams()">getAdapterParams</a></strong>()</code> +<div class="block">Parameters for adapter, or null if property has no explicit adapter.</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/StoredLayoutProperty.html#getAdapterTypeName()">getAdapterTypeName</a></strong>()</code> +<div class="block">Adapter type name is a fully qualified Java class name.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>byte[]</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/layout/StoredLayoutProperty.html#getExtraData()">getExtraData</a></strong>()</code> +<div class="block">Since this record cannot evolve, this property allows it to be extended + without conflicting with existing records.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>long</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/layout/StoredLayoutProperty.html#getLayoutID()">getLayoutID</a></strong>()</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>int</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/layout/StoredLayoutProperty.html#getOrdinal()">getOrdinal</a></strong>()</code> +<div class="block">Ordinal defines the order in which this property appears in it enclosing + layout.</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/StoredLayoutProperty.html#getPropertyName()">getPropertyName</a></strong>()</code> </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/StoredLayoutProperty.html#getPropertyTypeDescriptor()">getPropertyTypeDescriptor</a></strong>()</code> +<div class="block">Property type descriptor is a Java type descriptor.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>int</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/layout/StoredLayoutProperty.html#getVersionNumber()">getVersionNumber</a></strong>()</code> +<div class="block">Record version number for this StoredPropertyLayout instance.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/layout/StoredLayoutProperty.html#isNullable()">isNullable</a></strong>()</code> +<div class="block">Returns true of property value can be set to null.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/layout/StoredLayoutProperty.html#isPrimaryKeyMember()">isPrimaryKeyMember</a></strong>()</code> +<div class="block">Returns true if property is a member of the primary key.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/layout/StoredLayoutProperty.html#isVersion()">isVersion</a></strong>()</code> +<div class="block">Returns true if this property is the designated version number for the + Storable.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/layout/StoredLayoutProperty.html#setAdapterParams(java.lang.String)">setAdapterParams</a></strong>(java.lang.String params)</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/layout/StoredLayoutProperty.html#setAdapterTypeName(java.lang.String)">setAdapterTypeName</a></strong>(java.lang.String name)</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/layout/StoredLayoutProperty.html#setExtraData(byte[])">setExtraData</a></strong>(byte[] data)</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/layout/StoredLayoutProperty.html#setLayoutID(long)">setLayoutID</a></strong>(long typeID)</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/layout/StoredLayoutProperty.html#setNullable(boolean)">setNullable</a></strong>(boolean nullable)</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/layout/StoredLayoutProperty.html#setOrdinal(int)">setOrdinal</a></strong>(int ordinal)</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/layout/StoredLayoutProperty.html#setPrimaryKeyMember(boolean)">setPrimaryKeyMember</a></strong>(boolean pk)</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/layout/StoredLayoutProperty.html#setPropertyName(java.lang.String)">setPropertyName</a></strong>(java.lang.String name)</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/layout/StoredLayoutProperty.html#setPropertyTypeDescriptor(java.lang.String)">setPropertyTypeDescriptor</a></strong>(java.lang.String type)</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/layout/StoredLayoutProperty.html#setVersion(boolean)">setVersion</a></strong>(boolean version)</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/layout/StoredLayoutProperty.html#setVersionNumber(int)">setVersionNumber</a></strong>(int version)</code> </td> +</tr> +</table> +<ul class="blockList"> +<li class="blockList"><a name="methods_inherited_from_class_com.amazon.carbonado.Storable"> +<!-- --> +</a> +<h3>Methods inherited from interface com.amazon.carbonado.<a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a></h3> +<code><a href="../../../../com/amazon/carbonado/Storable.html#copy()">copy</a>, <a href="../../../../com/amazon/carbonado/Storable.html#copyAllProperties(S)">copyAllProperties</a>, <a href="../../../../com/amazon/carbonado/Storable.html#copyDirtyProperties(S)">copyDirtyProperties</a>, <a href="../../../../com/amazon/carbonado/Storable.html#copyPrimaryKeyProperties(S)">copyPrimaryKeyProperties</a>, <a href="../../../../com/amazon/carbonado/Storable.html#copyUnequalProperties(S)">copyUnequalProperties</a>, <a href="../../../../com/amazon/carbonado/Storable.html#copyVersionProperty(S)">copyVersionProperty</a>, <a href="../../../../com/amazon/carbonado/Storable.html#delete()">delete</a>, <a href="../../../../com/amazon/carbonado/Storable.html#equalPrimaryKeys(java.lang.Object)">equalPrimaryKeys</a>, <a href="../../../../com/amazon/carbonado/Storable.html#equalProperties(java.lang.Object)">equalProperties</a>, <a href="../../../../com/amazon/carbonado/Storable.html#equals(java.lang.Object)">equals</a>, <a href="../../../../com/amazon/carbonado/Storable.html#getPropertyValue(java.lang.String)">getPropertyValue</a>, <a href="../../../../com/amazon/carbonado/Storable.html#hasDirtyProperties()">hasDirtyProperties</a>, <a href="../../../../com/amazon/carbonado/Storable.html#hashCode()">hashCode</a>, <a href="../../../../com/amazon/carbonado/Storable.html#insert()">insert</a>, <a href="../../../../com/amazon/carbonado/Storable.html#isPropertyClean(java.lang.String)">isPropertyClean</a>, <a href="../../../../com/amazon/carbonado/Storable.html#isPropertyDirty(java.lang.String)">isPropertyDirty</a>, <a href="../../../../com/amazon/carbonado/Storable.html#isPropertySupported(java.lang.String)">isPropertySupported</a>, <a href="../../../../com/amazon/carbonado/Storable.html#isPropertyUninitialized(java.lang.String)">isPropertyUninitialized</a>, <a href="../../../../com/amazon/carbonado/Storable.html#load()">load</a>, <a href="../../../../com/amazon/carbonado/Storable.html#markAllPropertiesClean()">markAllPropertiesClean</a>, <a href="../../../../com/amazon/carbonado/Storable.html#markAllPropertiesDirty()">markAllPropertiesDirty</a>, <a href="../../../../com/amazon/carbonado/Storable.html#markPropertiesClean()">markPropertiesClean</a>, <a href="../../../../com/amazon/carbonado/Storable.html#markPropertiesDirty()">markPropertiesDirty</a>, <a href="../../../../com/amazon/carbonado/Storable.html#prepare()">prepare</a>, <a href="../../../../com/amazon/carbonado/Storable.html#propertyMap()">propertyMap</a>, <a href="../../../../com/amazon/carbonado/Storable.html#readFrom(java.io.InputStream)">readFrom</a>, <a href="../../../../com/amazon/carbonado/Storable.html#setPropertyValue(java.lang.String, java.lang.Object)">setPropertyValue</a>, <a href="../../../../com/amazon/carbonado/Storable.html#storableType()">storableType</a>, <a href="../../../../com/amazon/carbonado/Storable.html#toString()">toString</a>, <a href="../../../../com/amazon/carbonado/Storable.html#toStringKeyOnly()">toStringKeyOnly</a>, <a href="../../../../com/amazon/carbonado/Storable.html#tryDelete()">tryDelete</a>, <a href="../../../../com/amazon/carbonado/Storable.html#tryInsert()">tryInsert</a>, <a href="../../../../com/amazon/carbonado/Storable.html#tryLoad()">tryLoad</a>, <a href="../../../../com/amazon/carbonado/Storable.html#tryUpdate()">tryUpdate</a>, <a href="../../../../com/amazon/carbonado/Storable.html#update()">update</a>, <a href="../../../../com/amazon/carbonado/Storable.html#writeTo(java.io.OutputStream)">writeTo</a></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>long getLayoutID()</pre> +</li> +</ul> +<a name="setLayoutID(long)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setLayoutID</h4> +<pre>void setLayoutID(long typeID)</pre> +</li> +</ul> +<a name="getOrdinal()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getOrdinal</h4> +<pre>int getOrdinal()</pre> +<div class="block">Ordinal defines the order in which this property appears in it enclosing + layout.</div> +</li> +</ul> +<a name="setOrdinal(int)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setOrdinal</h4> +<pre>void setOrdinal(int ordinal)</pre> +</li> +</ul> +<a name="getPropertyName()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getPropertyName</h4> +<pre>java.lang.String getPropertyName()</pre> +</li> +</ul> +<a name="setPropertyName(java.lang.String)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setPropertyName</h4> +<pre>void setPropertyName(java.lang.String name)</pre> +</li> +</ul> +<a name="getPropertyTypeDescriptor()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getPropertyTypeDescriptor</h4> +<pre>java.lang.String getPropertyTypeDescriptor()</pre> +<div class="block">Property type descriptor is a Java type descriptor.</div> +</li> +</ul> +<a name="setPropertyTypeDescriptor(java.lang.String)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setPropertyTypeDescriptor</h4> +<pre>void setPropertyTypeDescriptor(java.lang.String type)</pre> +</li> +</ul> +<a name="isNullable()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>isNullable</h4> +<pre>boolean isNullable()</pre> +<div class="block">Returns true of property value can be set to null.</div> +</li> +</ul> +<a name="setNullable(boolean)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setNullable</h4> +<pre>void setNullable(boolean nullable)</pre> +</li> +</ul> +<a name="isPrimaryKeyMember()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>isPrimaryKeyMember</h4> +<pre>boolean isPrimaryKeyMember()</pre> +<div class="block">Returns true if property is a member of the primary key.</div> +</li> +</ul> +<a name="setPrimaryKeyMember(boolean)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setPrimaryKeyMember</h4> +<pre>void setPrimaryKeyMember(boolean pk)</pre> +</li> +</ul> +<a name="isVersion()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>isVersion</h4> +<pre>boolean isVersion()</pre> +<div class="block">Returns true if this property is the designated version number for the + Storable.</div> +</li> +</ul> +<a name="setVersion(boolean)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setVersion</h4> +<pre>void setVersion(boolean version)</pre> +</li> +</ul> +<a name="getAdapterTypeName()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getAdapterTypeName</h4> +<pre><a href="../../../../com/amazon/carbonado/Nullable.html" title="annotation in com.amazon.carbonado">@Nullable</a> +java.lang.String getAdapterTypeName()</pre> +<div class="block">Adapter type name is a fully qualified Java class name. If property has + no adapter, then null is returned.</div> +</li> +</ul> +<a name="setAdapterTypeName(java.lang.String)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setAdapterTypeName</h4> +<pre>void setAdapterTypeName(java.lang.String name)</pre> +</li> +</ul> +<a name="getAdapterParams()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getAdapterParams</h4> +<pre><a href="../../../../com/amazon/carbonado/Nullable.html" title="annotation in com.amazon.carbonado">@Nullable</a> +java.lang.String getAdapterParams()</pre> +<div class="block">Parameters for adapter, or null if property has no explicit adapter.</div> +</li> +</ul> +<a name="setAdapterParams(java.lang.String)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setAdapterParams</h4> +<pre>void setAdapterParams(java.lang.String params)</pre> +</li> +</ul> +<a name="getVersionNumber()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getVersionNumber</h4> +<pre><a href="../../../../com/amazon/carbonado/Version.html" title="annotation in com.amazon.carbonado">@Version</a> +int getVersionNumber()</pre> +<div class="block">Record version number for this StoredPropertyLayout instance. Some + encoding strategies require a version number.</div> +</li> +</ul> +<a name="setVersionNumber(int)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setVersionNumber</h4> +<pre>void setVersionNumber(int version)</pre> +</li> +</ul> +<a name="getExtraData()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getExtraData</h4> +<pre><a href="../../../../com/amazon/carbonado/Nullable.html" title="annotation in com.amazon.carbonado">@Nullable</a> +byte[] getExtraData()</pre> +<div class="block">Since this record cannot evolve, this property allows it to be extended + without conflicting with existing records. This record cannot evolve + because an evolution strategy likely depends on this interface remaining + stable, avoiding a cyclic dependency.</div> +</li> +</ul> +<a name="setExtraData(byte[])"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>setExtraData</h4> +<pre>void setExtraData(byte[] data)</pre> +</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/StoredLayoutProperty.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/layout/StoredLayoutEquivalence.html" title="interface in com.amazon.carbonado.layout"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../com/amazon/carbonado/layout/Unevolvable.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/StoredLayoutProperty.html" target="_top">Frames</a></li> +<li><a href="StoredLayoutProperty.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>Constr | </li> +<li><a href="#method_summary">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li>Field | </li> +<li>Constr | </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> diff --git a/apidocs/com/amazon/carbonado/layout/Unevolvable.html b/apidocs/com/amazon/carbonado/layout/Unevolvable.html new file mode 100644 index 0000000..f09728d --- /dev/null +++ b/apidocs/com/amazon/carbonado/layout/Unevolvable.html @@ -0,0 +1,171 @@ +<!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>Unevolvable (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="Unevolvable (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/Unevolvable.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/layout/StoredLayoutProperty.html" title="interface in com.amazon.carbonado.layout"><span class="strong">Prev Class</span></a></li> +<li>Next Class</li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?com/amazon/carbonado/layout/Unevolvable.html" target="_top">Frames</a></li> +<li><a href="Unevolvable.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>Constr | </li> +<li>Method</li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li>Field | </li> +<li>Constr | </li> +<li>Method</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="Interface Unevolvable" class="title">Interface Unevolvable</h2> +</div> +<div class="contentContainer"> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<dl> +<dt>All Known Subinterfaces:</dt> +<dd><a href="../../../../com/amazon/carbonado/repo/indexed/StoredIndexInfo.html" title="interface in com.amazon.carbonado.repo.indexed">StoredIndexInfo</a>, <a href="../../../../com/amazon/carbonado/layout/StoredLayout.html" title="interface in com.amazon.carbonado.layout">StoredLayout</a>, <a href="../../../../com/amazon/carbonado/layout/StoredLayoutEquivalence.html" title="interface in com.amazon.carbonado.layout">StoredLayoutEquivalence</a>, <a href="../../../../com/amazon/carbonado/layout/StoredLayoutProperty.html" title="interface in com.amazon.carbonado.layout">StoredLayoutProperty</a></dd> +</dl> +<dl> +<dt>All Known Implementing Classes:</dt> +<dd><a href="../../../../com/amazon/carbonado/repo/sleepycat/StoredDatabaseInfo.html" title="class in com.amazon.carbonado.repo.sleepycat">StoredDatabaseInfo</a></dd> +</dl> +<hr> +<br> +<pre>public interface <span class="strong">Unevolvable</span></pre> +<div class="block">Marker interface for storables that are not allowed to evolve.</div> +<dl><dt><span class="strong">Author:</span></dt> + <dd>Brian S O'Neill</dd></dl> +</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/Unevolvable.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/layout/StoredLayoutProperty.html" title="interface in com.amazon.carbonado.layout"><span class="strong">Prev Class</span></a></li> +<li>Next Class</li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?com/amazon/carbonado/layout/Unevolvable.html" target="_top">Frames</a></li> +<li><a href="Unevolvable.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>Constr | </li> +<li>Method</li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li>Field | </li> +<li>Constr | </li> +<li>Method</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> diff --git a/apidocs/com/amazon/carbonado/layout/class-use/Layout.html b/apidocs/com/amazon/carbonado/layout/class-use/Layout.html new file mode 100644 index 0000000..0e91eec --- /dev/null +++ b/apidocs/com/amazon/carbonado/layout/class-use/Layout.html @@ -0,0 +1,317 @@ +<!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:45 PST 2013 --> +<meta http-equiv="Content-Type" content="text/html" charset="UTF-8"> +<title>Uses of Class com.amazon.carbonado.layout.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="Uses of Class com.amazon.carbonado.layout.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><a href="../../../../../com/amazon/carbonado/layout/Layout.html" title="class in com.amazon.carbonado.layout">Class</a></li> +<li class="navBarCell1Rev">Use</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</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?com/amazon/carbonado/layout/class-use/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> +<a name="skip-navbar_top"> +<!-- --> +</a></div> +<!-- ========= END OF TOP NAVBAR ========= --> +<div class="header"> +<h2 title="Uses of Class com.amazon.carbonado.layout.Layout" class="title">Uses of Class<br>com.amazon.carbonado.layout.Layout</h2> +</div> +<div class="classUseContainer"> +<ul class="blockList"> +<li class="blockList"> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing packages, and an explanation"> +<caption><span>Packages that use <a href="../../../../../com/amazon/carbonado/layout/Layout.html" title="class in com.amazon.carbonado.layout">Layout</a></span><span class="tabEnd"> </span></caption> +<tr> +<th class="colFirst" scope="col">Package</th> +<th class="colLast" scope="col">Description</th> +</tr> +<tbody> +<tr class="altColor"> +<td class="colFirst"><a href="#com.amazon.carbonado.layout">com.amazon.carbonado.layout</a></td> +<td class="colLast"> +<div class="block">Support for recording the evolution of a storable's layout, used internally + by some repositories.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><a href="#com.amazon.carbonado.raw">com.amazon.carbonado.raw</a></td> +<td class="colLast"> +<div class="block">Provides support for repositories that encode/decode storables in a raw + binary format.</div> +</td> +</tr> +</tbody> +</table> +</li> +<li class="blockList"> +<ul class="blockList"> +<li class="blockList"><a name="com.amazon.carbonado.layout"> +<!-- --> +</a> +<h3>Uses of <a href="../../../../../com/amazon/carbonado/layout/Layout.html" title="class in com.amazon.carbonado.layout">Layout</a> in <a href="../../../../../com/amazon/carbonado/layout/package-summary.html">com.amazon.carbonado.layout</a></h3> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing methods, and an explanation"> +<caption><span>Methods in <a href="../../../../../com/amazon/carbonado/layout/package-summary.html">com.amazon.carbonado.layout</a> that return <a href="../../../../../com/amazon/carbonado/layout/Layout.html" title="class in com.amazon.carbonado.layout">Layout</a></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> +<tbody> +<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"><span class="strong">Layout.</span><code><strong><a href="../../../../../com/amazon/carbonado/layout/Layout.html#getGeneration(int)">getGeneration</a></strong>(int 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><a href="../../../../../com/amazon/carbonado/layout/Layout.html" title="class in com.amazon.carbonado.layout">Layout</a></code></td> +<td class="colLast"><span class="strong">LayoutFactory.</span><code><strong><a href="../../../../../com/amazon/carbonado/layout/LayoutFactory.html#layoutFor(boolean, java.lang.Class, com.amazon.carbonado.layout.LayoutOptions)">layoutFor</a></strong>(boolean readOnly, + java.lang.Class<? extends <a href="../../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>> type, + <a href="../../../../../com/amazon/carbonado/layout/LayoutOptions.html" title="class in com.amazon.carbonado.layout">LayoutOptions</a> options)</code> +<div class="block">Returns the layout matching the current definition of the given type.</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"><span class="strong">LayoutCapability.</span><code><strong><a href="../../../../../com/amazon/carbonado/layout/LayoutCapability.html#layoutFor(java.lang.Class)">layoutFor</a></strong>(java.lang.Class<? extends <a href="../../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>> type)</code> +<div class="block">Returns the layout matching the current definition of the given type.</div> +</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"><span class="strong">LayoutFactory.</span><code><strong><a href="../../../../../com/amazon/carbonado/layout/LayoutFactory.html#layoutFor(java.lang.Class)">layoutFor</a></strong>(java.lang.Class<? extends <a href="../../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>> type)</code> +<div class="block">Returns the layout matching the current definition of the given type.</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"><span class="strong">LayoutCapability.</span><code><strong><a href="../../../../../com/amazon/carbonado/layout/LayoutCapability.html#layoutFor(java.lang.Class, int)">layoutFor</a></strong>(java.lang.Class<? extends <a href="../../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>> type, + int generation)</code> +<div class="block">Returns the layout for a particular generation of the given type.</div> +</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"><span class="strong">LayoutFactory.</span><code><strong><a href="../../../../../com/amazon/carbonado/layout/LayoutFactory.html#layoutFor(java.lang.Class, int)">layoutFor</a></strong>(java.lang.Class<? extends <a href="../../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>> type, + int generation)</code> +<div class="block">Returns the layout for a particular generation of the given type.</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"><span class="strong">LayoutFactory.</span><code><strong><a href="../../../../../com/amazon/carbonado/layout/LayoutFactory.html#layoutFor(java.lang.Class, com.amazon.carbonado.layout.LayoutOptions)">layoutFor</a></strong>(java.lang.Class<? extends <a href="../../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>> type, + <a href="../../../../../com/amazon/carbonado/layout/LayoutOptions.html" title="class in com.amazon.carbonado.layout">LayoutOptions</a> options)</code> +<div class="block">Returns the layout matching the current definition of the given type.</div> +</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"><span class="strong">Layout.</span><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"><span class="strong">Layout.</span><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><a href="../../../../../com/amazon/carbonado/layout/Layout.html" title="class in com.amazon.carbonado.layout">Layout</a></code></td> +<td class="colLast"><span class="strong">LayoutFactory.</span><code><strong><a href="../../../../../com/amazon/carbonado/layout/LayoutFactory.html#readLayoutFrom(java.io.InputStream)">readLayoutFrom</a></strong>(java.io.InputStream in)</code> +<div class="block">Read a layout as written by <a href="../../../../../com/amazon/carbonado/layout/Layout.html#writeTo(java.io.OutputStream)"><code>writeTo(java.io.OutputStream)</code></a>.</div> +</td> +</tr> +</tbody> +</table> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing methods, and an explanation"> +<caption><span>Methods in <a href="../../../../../com/amazon/carbonado/layout/package-summary.html">com.amazon.carbonado.layout</a> with parameters of type <a href="../../../../../com/amazon/carbonado/layout/Layout.html" title="class in com.amazon.carbonado.layout">Layout</a></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> +<tbody> +<tr class="altColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><span class="strong">Layout.</span><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> layout)</code> +<div class="block">Returns true if the given layout matches this one.</div> +</td> +</tr> +</tbody> +</table> +</li> +<li class="blockList"><a name="com.amazon.carbonado.raw"> +<!-- --> +</a> +<h3>Uses of <a href="../../../../../com/amazon/carbonado/layout/Layout.html" title="class in com.amazon.carbonado.layout">Layout</a> in <a href="../../../../../com/amazon/carbonado/raw/package-summary.html">com.amazon.carbonado.raw</a></h3> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing methods, and an explanation"> +<caption><span>Methods in <a href="../../../../../com/amazon/carbonado/raw/package-summary.html">com.amazon.carbonado.raw</a> with parameters of type <a href="../../../../../com/amazon/carbonado/layout/Layout.html" title="class in com.amazon.carbonado.layout">Layout</a></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> +<tbody> +<tr class="altColor"> +<td class="colFirst"><code>protected abstract <S extends <a href="../../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>> <br><a href="../../../../../com/amazon/carbonado/raw/CustomStorableCodec.html" title="class in com.amazon.carbonado.raw">CustomStorableCodec</a><S></code></td> +<td class="colLast"><span class="strong">CustomStorableCodecFactory.</span><code><strong><a href="../../../../../com/amazon/carbonado/raw/CustomStorableCodecFactory.html#createCodec(java.lang.Class, boolean, com.amazon.carbonado.layout.Layout)">createCodec</a></strong>(java.lang.Class<S> type, + boolean isMaster, + <a href="../../../../../com/amazon/carbonado/layout/Layout.html" title="class in com.amazon.carbonado.layout">Layout</a> layout)</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>protected <S extends <a href="../../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>> <br><a href="../../../../../com/amazon/carbonado/raw/CustomStorableCodec.html" title="class in com.amazon.carbonado.raw">CustomStorableCodec</a><S></code></td> +<td class="colLast"><span class="strong">CustomStorableCodecFactory.</span><code><strong><a href="../../../../../com/amazon/carbonado/raw/CustomStorableCodecFactory.html#createCodec(java.lang.Class, boolean, com.amazon.carbonado.layout.Layout, com.amazon.carbonado.raw.RawSupport)">createCodec</a></strong>(java.lang.Class<S> type, + boolean isMaster, + <a href="../../../../../com/amazon/carbonado/layout/Layout.html" title="class in com.amazon.carbonado.layout">Layout</a> layout, + <a href="../../../../../com/amazon/carbonado/raw/RawSupport.html" title="interface in com.amazon.carbonado.raw">RawSupport</a> support)</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><S extends <a href="../../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>> <br><a href="../../../../../com/amazon/carbonado/raw/CustomStorableCodec.html" title="class in com.amazon.carbonado.raw">CustomStorableCodec</a><S></code></td> +<td class="colLast"><span class="strong">CustomStorableCodecFactory.</span><code><strong><a href="../../../../../com/amazon/carbonado/raw/CustomStorableCodecFactory.html#createCodec(java.lang.Class, com.amazon.carbonado.info.StorableIndex, boolean, com.amazon.carbonado.layout.Layout)">createCodec</a></strong>(java.lang.Class<S> type, + <a href="../../../../../com/amazon/carbonado/info/StorableIndex.html" title="class in com.amazon.carbonado.info">StorableIndex</a> pkIndex, + boolean isMaster, + <a href="../../../../../com/amazon/carbonado/layout/Layout.html" title="class in com.amazon.carbonado.layout">Layout</a> layout)</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><S extends <a href="../../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>> <br><a href="../../../../../com/amazon/carbonado/raw/StorableCodec.html" title="interface in com.amazon.carbonado.raw">StorableCodec</a><S></code></td> +<td class="colLast"><span class="strong">StorableCodecFactory.</span><code><strong><a href="../../../../../com/amazon/carbonado/raw/StorableCodecFactory.html#createCodec(java.lang.Class, com.amazon.carbonado.info.StorableIndex, boolean, com.amazon.carbonado.layout.Layout)">createCodec</a></strong>(java.lang.Class<S> type, + <a href="../../../../../com/amazon/carbonado/info/StorableIndex.html" title="class in com.amazon.carbonado.info">StorableIndex</a> pkIndex, + boolean isMaster, + <a href="../../../../../com/amazon/carbonado/layout/Layout.html" title="class in com.amazon.carbonado.layout">Layout</a> layout)</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><S extends <a href="../../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>> <br><a href="../../../../../com/amazon/carbonado/raw/GenericStorableCodec.html" title="class in com.amazon.carbonado.raw">GenericStorableCodec</a><S></code></td> +<td class="colLast"><span class="strong">GenericStorableCodecFactory.</span><code><strong><a href="../../../../../com/amazon/carbonado/raw/GenericStorableCodecFactory.html#createCodec(java.lang.Class, com.amazon.carbonado.info.StorableIndex, boolean, com.amazon.carbonado.layout.Layout)">createCodec</a></strong>(java.lang.Class<S> type, + <a href="../../../../../com/amazon/carbonado/info/StorableIndex.html" title="class in com.amazon.carbonado.info">StorableIndex</a> pkIndex, + boolean isMaster, + <a href="../../../../../com/amazon/carbonado/layout/Layout.html" title="class in com.amazon.carbonado.layout">Layout</a> layout)</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><S extends <a href="../../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>> <br><a href="../../../../../com/amazon/carbonado/raw/CustomStorableCodec.html" title="class in com.amazon.carbonado.raw">CustomStorableCodec</a><S></code></td> +<td class="colLast"><span class="strong">CustomStorableCodecFactory.</span><code><strong><a href="../../../../../com/amazon/carbonado/raw/CustomStorableCodecFactory.html#createCodec(java.lang.Class, com.amazon.carbonado.info.StorableIndex, boolean, com.amazon.carbonado.layout.Layout, com.amazon.carbonado.raw.RawSupport)">createCodec</a></strong>(java.lang.Class<S> type, + <a href="../../../../../com/amazon/carbonado/info/StorableIndex.html" title="class in com.amazon.carbonado.info">StorableIndex</a> pkIndex, + boolean isMaster, + <a href="../../../../../com/amazon/carbonado/layout/Layout.html" title="class in com.amazon.carbonado.layout">Layout</a> layout, + <a href="../../../../../com/amazon/carbonado/raw/RawSupport.html" title="interface in com.amazon.carbonado.raw">RawSupport</a> support)</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><S extends <a href="../../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>> <br><a href="../../../../../com/amazon/carbonado/raw/StorableCodec.html" title="interface in com.amazon.carbonado.raw">StorableCodec</a><S></code></td> +<td class="colLast"><span class="strong">StorableCodecFactory.</span><code><strong><a href="../../../../../com/amazon/carbonado/raw/StorableCodecFactory.html#createCodec(java.lang.Class, com.amazon.carbonado.info.StorableIndex, boolean, com.amazon.carbonado.layout.Layout, com.amazon.carbonado.raw.RawSupport)">createCodec</a></strong>(java.lang.Class<S> type, + <a href="../../../../../com/amazon/carbonado/info/StorableIndex.html" title="class in com.amazon.carbonado.info">StorableIndex</a> pkIndex, + boolean isMaster, + <a href="../../../../../com/amazon/carbonado/layout/Layout.html" title="class in com.amazon.carbonado.layout">Layout</a> layout, + <a href="../../../../../com/amazon/carbonado/raw/RawSupport.html" title="interface in com.amazon.carbonado.raw">RawSupport</a> support)</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><S extends <a href="../../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>> <br><a href="../../../../../com/amazon/carbonado/raw/GenericStorableCodec.html" title="class in com.amazon.carbonado.raw">GenericStorableCodec</a><S></code></td> +<td class="colLast"><span class="strong">GenericStorableCodecFactory.</span><code><strong><a href="../../../../../com/amazon/carbonado/raw/GenericStorableCodecFactory.html#createCodec(java.lang.Class, com.amazon.carbonado.info.StorableIndex, boolean, com.amazon.carbonado.layout.Layout, com.amazon.carbonado.raw.RawSupport)">createCodec</a></strong>(java.lang.Class<S> type, + <a href="../../../../../com/amazon/carbonado/info/StorableIndex.html" title="class in com.amazon.carbonado.info">StorableIndex</a> pkIndex, + boolean isMaster, + <a href="../../../../../com/amazon/carbonado/layout/Layout.html" title="class in com.amazon.carbonado.layout">Layout</a> layout, + <a href="../../../../../com/amazon/carbonado/raw/RawSupport.html" title="interface in com.amazon.carbonado.raw">RawSupport</a> support)</code> </td> +</tr> +</tbody> +</table> +</li> +</ul> +</li> +</ul> +</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><a href="../package-summary.html">Package</a></li> +<li><a href="../../../../../com/amazon/carbonado/layout/Layout.html" title="class in com.amazon.carbonado.layout">Class</a></li> +<li class="navBarCell1Rev">Use</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</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?com/amazon/carbonado/layout/class-use/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> +<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> diff --git a/apidocs/com/amazon/carbonado/layout/class-use/LayoutCapability.html b/apidocs/com/amazon/carbonado/layout/class-use/LayoutCapability.html new file mode 100644 index 0000000..0ec261c --- /dev/null +++ b/apidocs/com/amazon/carbonado/layout/class-use/LayoutCapability.html @@ -0,0 +1,162 @@ +<!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:45 PST 2013 --> +<meta http-equiv="Content-Type" content="text/html" charset="UTF-8"> +<title>Uses of Interface com.amazon.carbonado.layout.LayoutCapability (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="Uses of Interface com.amazon.carbonado.layout.LayoutCapability (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><a href="../../../../../com/amazon/carbonado/layout/LayoutCapability.html" title="interface in com.amazon.carbonado.layout">Class</a></li> +<li class="navBarCell1Rev">Use</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</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?com/amazon/carbonado/layout/class-use/LayoutCapability.html" target="_top">Frames</a></li> +<li><a href="LayoutCapability.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"> +<h2 title="Uses of Interface com.amazon.carbonado.layout.LayoutCapability" class="title">Uses of Interface<br>com.amazon.carbonado.layout.LayoutCapability</h2> +</div> +<div class="classUseContainer"> +<ul class="blockList"> +<li class="blockList"> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing packages, and an explanation"> +<caption><span>Packages that use <a href="../../../../../com/amazon/carbonado/layout/LayoutCapability.html" title="interface in com.amazon.carbonado.layout">LayoutCapability</a></span><span class="tabEnd"> </span></caption> +<tr> +<th class="colFirst" scope="col">Package</th> +<th class="colLast" scope="col">Description</th> +</tr> +<tbody> +<tr class="altColor"> +<td class="colFirst"><a href="#com.amazon.carbonado.layout">com.amazon.carbonado.layout</a></td> +<td class="colLast"> +<div class="block">Support for recording the evolution of a storable's layout, used internally + by some repositories.</div> +</td> +</tr> +</tbody> +</table> +</li> +<li class="blockList"> +<ul class="blockList"> +<li class="blockList"><a name="com.amazon.carbonado.layout"> +<!-- --> +</a> +<h3>Uses of <a href="../../../../../com/amazon/carbonado/layout/LayoutCapability.html" title="interface in com.amazon.carbonado.layout">LayoutCapability</a> in <a href="../../../../../com/amazon/carbonado/layout/package-summary.html">com.amazon.carbonado.layout</a></h3> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing classes, and an explanation"> +<caption><span>Classes in <a href="../../../../../com/amazon/carbonado/layout/package-summary.html">com.amazon.carbonado.layout</a> that implement <a href="../../../../../com/amazon/carbonado/layout/LayoutCapability.html" title="interface in com.amazon.carbonado.layout">LayoutCapability</a></span><span class="tabEnd"> </span></caption> +<tr> +<th class="colFirst" scope="col">Modifier and Type</th> +<th class="colLast" scope="col">Class and Description</th> +</tr> +<tbody> +<tr class="altColor"> +<td class="colFirst"><code>class </code></td> +<td class="colLast"><code><strong><a href="../../../../../com/amazon/carbonado/layout/LayoutFactory.html" title="class in com.amazon.carbonado.layout">LayoutFactory</a></strong></code> +<div class="block">Factory for obtaining references to storable layouts.</div> +</td> +</tr> +</tbody> +</table> +</li> +</ul> +</li> +</ul> +</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><a href="../package-summary.html">Package</a></li> +<li><a href="../../../../../com/amazon/carbonado/layout/LayoutCapability.html" title="interface in com.amazon.carbonado.layout">Class</a></li> +<li class="navBarCell1Rev">Use</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</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?com/amazon/carbonado/layout/class-use/LayoutCapability.html" target="_top">Frames</a></li> +<li><a href="LayoutCapability.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 © 2006-2013 <a href="https://github.com/Carbonado/Carbonado">Amazon Technologies, Inc.</a>. All Rights Reserved.</small></p> +</body> +</html> diff --git a/apidocs/com/amazon/carbonado/layout/class-use/LayoutFactory.html b/apidocs/com/amazon/carbonado/layout/class-use/LayoutFactory.html new file mode 100644 index 0000000..ffc230f --- /dev/null +++ b/apidocs/com/amazon/carbonado/layout/class-use/LayoutFactory.html @@ -0,0 +1,117 @@ +<!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:45 PST 2013 --> +<meta http-equiv="Content-Type" content="text/html" charset="UTF-8"> +<title>Uses of Class com.amazon.carbonado.layout.LayoutFactory (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="Uses of Class com.amazon.carbonado.layout.LayoutFactory (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><a href="../../../../../com/amazon/carbonado/layout/LayoutFactory.html" title="class in com.amazon.carbonado.layout">Class</a></li> +<li class="navBarCell1Rev">Use</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</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?com/amazon/carbonado/layout/class-use/LayoutFactory.html" target="_top">Frames</a></li> +<li><a href="LayoutFactory.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"> +<h2 title="Uses of Class com.amazon.carbonado.layout.LayoutFactory" class="title">Uses of Class<br>com.amazon.carbonado.layout.LayoutFactory</h2> +</div> +<div class="classUseContainer">No usage of com.amazon.carbonado.layout.LayoutFactory</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><a href="../package-summary.html">Package</a></li> +<li><a href="../../../../../com/amazon/carbonado/layout/LayoutFactory.html" title="class in com.amazon.carbonado.layout">Class</a></li> +<li class="navBarCell1Rev">Use</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</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?com/amazon/carbonado/layout/class-use/LayoutFactory.html" target="_top">Frames</a></li> +<li><a href="LayoutFactory.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 © 2006-2013 <a href="https://github.com/Carbonado/Carbonado">Amazon Technologies, Inc.</a>. All Rights Reserved.</small></p> +</body> +</html> diff --git a/apidocs/com/amazon/carbonado/layout/class-use/LayoutOptions.html b/apidocs/com/amazon/carbonado/layout/class-use/LayoutOptions.html new file mode 100644 index 0000000..0a48447 --- /dev/null +++ b/apidocs/com/amazon/carbonado/layout/class-use/LayoutOptions.html @@ -0,0 +1,246 @@ +<!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:45 PST 2013 --> +<meta http-equiv="Content-Type" content="text/html" charset="UTF-8"> +<title>Uses of Class com.amazon.carbonado.layout.LayoutOptions (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="Uses of Class com.amazon.carbonado.layout.LayoutOptions (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><a href="../../../../../com/amazon/carbonado/layout/LayoutOptions.html" title="class in com.amazon.carbonado.layout">Class</a></li> +<li class="navBarCell1Rev">Use</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</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?com/amazon/carbonado/layout/class-use/LayoutOptions.html" target="_top">Frames</a></li> +<li><a href="LayoutOptions.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"> +<h2 title="Uses of Class com.amazon.carbonado.layout.LayoutOptions" class="title">Uses of Class<br>com.amazon.carbonado.layout.LayoutOptions</h2> +</div> +<div class="classUseContainer"> +<ul class="blockList"> +<li class="blockList"> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing packages, and an explanation"> +<caption><span>Packages that use <a href="../../../../../com/amazon/carbonado/layout/LayoutOptions.html" title="class in com.amazon.carbonado.layout">LayoutOptions</a></span><span class="tabEnd"> </span></caption> +<tr> +<th class="colFirst" scope="col">Package</th> +<th class="colLast" scope="col">Description</th> +</tr> +<tbody> +<tr class="altColor"> +<td class="colFirst"><a href="#com.amazon.carbonado.layout">com.amazon.carbonado.layout</a></td> +<td class="colLast"> +<div class="block">Support for recording the evolution of a storable's layout, used internally + by some repositories.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><a href="#com.amazon.carbonado.raw">com.amazon.carbonado.raw</a></td> +<td class="colLast"> +<div class="block">Provides support for repositories that encode/decode storables in a raw + binary format.</div> +</td> +</tr> +</tbody> +</table> +</li> +<li class="blockList"> +<ul class="blockList"> +<li class="blockList"><a name="com.amazon.carbonado.layout"> +<!-- --> +</a> +<h3>Uses of <a href="../../../../../com/amazon/carbonado/layout/LayoutOptions.html" title="class in com.amazon.carbonado.layout">LayoutOptions</a> in <a href="../../../../../com/amazon/carbonado/layout/package-summary.html">com.amazon.carbonado.layout</a></h3> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing methods, and an explanation"> +<caption><span>Methods in <a href="../../../../../com/amazon/carbonado/layout/package-summary.html">com.amazon.carbonado.layout</a> that return <a href="../../../../../com/amazon/carbonado/layout/LayoutOptions.html" title="class in com.amazon.carbonado.layout">LayoutOptions</a></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> +<tbody> +<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"><span class="strong">Layout.</span><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> +</tbody> +</table> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing methods, and an explanation"> +<caption><span>Methods in <a href="../../../../../com/amazon/carbonado/layout/package-summary.html">com.amazon.carbonado.layout</a> with parameters of type <a href="../../../../../com/amazon/carbonado/layout/LayoutOptions.html" title="class in com.amazon.carbonado.layout">LayoutOptions</a></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> +<tbody> +<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"><span class="strong">LayoutFactory.</span><code><strong><a href="../../../../../com/amazon/carbonado/layout/LayoutFactory.html#layoutFor(boolean, java.lang.Class, com.amazon.carbonado.layout.LayoutOptions)">layoutFor</a></strong>(boolean readOnly, + java.lang.Class<? extends <a href="../../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>> type, + <a href="../../../../../com/amazon/carbonado/layout/LayoutOptions.html" title="class in com.amazon.carbonado.layout">LayoutOptions</a> options)</code> +<div class="block">Returns the layout matching the current definition of the given type.</div> +</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"><span class="strong">LayoutFactory.</span><code><strong><a href="../../../../../com/amazon/carbonado/layout/LayoutFactory.html#layoutFor(java.lang.Class, com.amazon.carbonado.layout.LayoutOptions)">layoutFor</a></strong>(java.lang.Class<? extends <a href="../../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>> type, + <a href="../../../../../com/amazon/carbonado/layout/LayoutOptions.html" title="class in com.amazon.carbonado.layout">LayoutOptions</a> options)</code> +<div class="block">Returns the layout matching the current definition of the given type.</div> +</td> +</tr> +</tbody> +</table> +</li> +<li class="blockList"><a name="com.amazon.carbonado.raw"> +<!-- --> +</a> +<h3>Uses of <a href="../../../../../com/amazon/carbonado/layout/LayoutOptions.html" title="class in com.amazon.carbonado.layout">LayoutOptions</a> in <a href="../../../../../com/amazon/carbonado/raw/package-summary.html">com.amazon.carbonado.raw</a></h3> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing methods, and an explanation"> +<caption><span>Methods in <a href="../../../../../com/amazon/carbonado/raw/package-summary.html">com.amazon.carbonado.raw</a> that return <a href="../../../../../com/amazon/carbonado/layout/LayoutOptions.html" title="class in com.amazon.carbonado.layout">LayoutOptions</a></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> +<tbody> +<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"><span class="strong">StorableCodecFactory.</span><code><strong><a href="../../../../../com/amazon/carbonado/raw/StorableCodecFactory.html#getLayoutOptions(java.lang.Class)">getLayoutOptions</a></strong>(java.lang.Class<? extends <a href="../../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>> type)</code> +<div class="block">Optionally return additional information regarding storable encoding.</div> +</td> +</tr> +<tr class="rowColor"> +<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"><span class="strong">CompressedStorableCodecFactory.</span><code><strong><a href="../../../../../com/amazon/carbonado/raw/CompressedStorableCodecFactory.html#getLayoutOptions(java.lang.Class)">getLayoutOptions</a></strong>(java.lang.Class<? extends <a href="../../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>> type)</code> </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"><span class="strong">GenericStorableCodecFactory.</span><code><strong><a href="../../../../../com/amazon/carbonado/raw/GenericStorableCodecFactory.html#getLayoutOptions(java.lang.Class)">getLayoutOptions</a></strong>(java.lang.Class<? extends <a href="../../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>> type)</code> +<div class="block">Returns null.</div> +</td> +</tr> +</tbody> +</table> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing methods, and an explanation"> +<caption><span>Methods in <a href="../../../../../com/amazon/carbonado/raw/package-summary.html">com.amazon.carbonado.raw</a> with parameters of type <a href="../../../../../com/amazon/carbonado/layout/LayoutOptions.html" title="class in com.amazon.carbonado.layout">LayoutOptions</a></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> +<tbody> +<tr class="altColor"> +<td class="colFirst"><code>protected <S extends <a href="../../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>> <br><a href="../../../../../com/amazon/carbonado/raw/GenericEncodingStrategy.html" title="class in com.amazon.carbonado.raw">GenericEncodingStrategy</a><S></code></td> +<td class="colLast"><span class="strong">CompressedStorableCodecFactory.</span><code><strong><a href="../../../../../com/amazon/carbonado/raw/CompressedStorableCodecFactory.html#createStrategy(java.lang.Class, com.amazon.carbonado.info.StorableIndex, com.amazon.carbonado.layout.LayoutOptions)">createStrategy</a></strong>(java.lang.Class<S> type, + <a href="../../../../../com/amazon/carbonado/info/StorableIndex.html" title="class in com.amazon.carbonado.info">StorableIndex</a><S> pkIndex, + <a href="../../../../../com/amazon/carbonado/layout/LayoutOptions.html" title="class in com.amazon.carbonado.layout">LayoutOptions</a> options)</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>protected <S extends <a href="../../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>> <br><a href="../../../../../com/amazon/carbonado/raw/GenericEncodingStrategy.html" title="class in com.amazon.carbonado.raw">GenericEncodingStrategy</a><S></code></td> +<td class="colLast"><span class="strong">GenericStorableCodecFactory.</span><code><strong><a href="../../../../../com/amazon/carbonado/raw/GenericStorableCodecFactory.html#createStrategy(java.lang.Class, com.amazon.carbonado.info.StorableIndex, com.amazon.carbonado.layout.LayoutOptions)">createStrategy</a></strong>(java.lang.Class<S> type, + <a href="../../../../../com/amazon/carbonado/info/StorableIndex.html" title="class in com.amazon.carbonado.info">StorableIndex</a><S> pkIndex, + <a href="../../../../../com/amazon/carbonado/layout/LayoutOptions.html" title="class in com.amazon.carbonado.layout">LayoutOptions</a> options)</code> +<div class="block">Override to return a different EncodingStrategy.</div> +</td> +</tr> +</tbody> +</table> +</li> +</ul> +</li> +</ul> +</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><a href="../package-summary.html">Package</a></li> +<li><a href="../../../../../com/amazon/carbonado/layout/LayoutOptions.html" title="class in com.amazon.carbonado.layout">Class</a></li> +<li class="navBarCell1Rev">Use</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</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?com/amazon/carbonado/layout/class-use/LayoutOptions.html" target="_top">Frames</a></li> +<li><a href="LayoutOptions.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 © 2006-2013 <a href="https://github.com/Carbonado/Carbonado">Amazon Technologies, Inc.</a>. All Rights Reserved.</small></p> +</body> +</html> diff --git a/apidocs/com/amazon/carbonado/layout/class-use/LayoutProperty.html b/apidocs/com/amazon/carbonado/layout/class-use/LayoutProperty.html new file mode 100644 index 0000000..c088c4b --- /dev/null +++ b/apidocs/com/amazon/carbonado/layout/class-use/LayoutProperty.html @@ -0,0 +1,169 @@ +<!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:45 PST 2013 --> +<meta http-equiv="Content-Type" content="text/html" charset="UTF-8"> +<title>Uses of Class com.amazon.carbonado.layout.LayoutProperty (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="Uses of Class com.amazon.carbonado.layout.LayoutProperty (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><a href="../../../../../com/amazon/carbonado/layout/LayoutProperty.html" title="class in com.amazon.carbonado.layout">Class</a></li> +<li class="navBarCell1Rev">Use</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</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?com/amazon/carbonado/layout/class-use/LayoutProperty.html" target="_top">Frames</a></li> +<li><a href="LayoutProperty.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"> +<h2 title="Uses of Class com.amazon.carbonado.layout.LayoutProperty" class="title">Uses of Class<br>com.amazon.carbonado.layout.LayoutProperty</h2> +</div> +<div class="classUseContainer"> +<ul class="blockList"> +<li class="blockList"> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing packages, and an explanation"> +<caption><span>Packages that use <a href="../../../../../com/amazon/carbonado/layout/LayoutProperty.html" title="class in com.amazon.carbonado.layout">LayoutProperty</a></span><span class="tabEnd"> </span></caption> +<tr> +<th class="colFirst" scope="col">Package</th> +<th class="colLast" scope="col">Description</th> +</tr> +<tbody> +<tr class="altColor"> +<td class="colFirst"><a href="#com.amazon.carbonado.layout">com.amazon.carbonado.layout</a></td> +<td class="colLast"> +<div class="block">Support for recording the evolution of a storable's layout, used internally + by some repositories.</div> +</td> +</tr> +</tbody> +</table> +</li> +<li class="blockList"> +<ul class="blockList"> +<li class="blockList"><a name="com.amazon.carbonado.layout"> +<!-- --> +</a> +<h3>Uses of <a href="../../../../../com/amazon/carbonado/layout/LayoutProperty.html" title="class in com.amazon.carbonado.layout">LayoutProperty</a> in <a href="../../../../../com/amazon/carbonado/layout/package-summary.html">com.amazon.carbonado.layout</a></h3> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing methods, and an explanation"> +<caption><span>Methods in <a href="../../../../../com/amazon/carbonado/layout/package-summary.html">com.amazon.carbonado.layout</a> that return types with arguments of type <a href="../../../../../com/amazon/carbonado/layout/LayoutProperty.html" title="class in com.amazon.carbonado.layout">LayoutProperty</a></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> +<tbody> +<tr class="altColor"> +<td class="colFirst"><code>java.util.List<<a href="../../../../../com/amazon/carbonado/layout/LayoutProperty.html" title="class in com.amazon.carbonado.layout">LayoutProperty</a>></code></td> +<td class="colLast"><span class="strong">Layout.</span><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>java.util.List<<a href="../../../../../com/amazon/carbonado/layout/LayoutProperty.html" title="class in com.amazon.carbonado.layout">LayoutProperty</a>></code></td> +<td class="colLast"><span class="strong">Layout.</span><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> +</tbody> +</table> +</li> +</ul> +</li> +</ul> +</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><a href="../package-summary.html">Package</a></li> +<li><a href="../../../../../com/amazon/carbonado/layout/LayoutProperty.html" title="class in com.amazon.carbonado.layout">Class</a></li> +<li class="navBarCell1Rev">Use</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</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?com/amazon/carbonado/layout/class-use/LayoutProperty.html" target="_top">Frames</a></li> +<li><a href="LayoutProperty.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 © 2006-2013 <a href="https://github.com/Carbonado/Carbonado">Amazon Technologies, Inc.</a>. All Rights Reserved.</small></p> +</body> +</html> diff --git a/apidocs/com/amazon/carbonado/layout/class-use/LayoutSync.html b/apidocs/com/amazon/carbonado/layout/class-use/LayoutSync.html new file mode 100644 index 0000000..28ca812 --- /dev/null +++ b/apidocs/com/amazon/carbonado/layout/class-use/LayoutSync.html @@ -0,0 +1,117 @@ +<!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:45 PST 2013 --> +<meta http-equiv="Content-Type" content="text/html" charset="UTF-8"> +<title>Uses of Class com.amazon.carbonado.layout.LayoutSync (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="Uses of Class com.amazon.carbonado.layout.LayoutSync (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><a href="../../../../../com/amazon/carbonado/layout/LayoutSync.html" title="class in com.amazon.carbonado.layout">Class</a></li> +<li class="navBarCell1Rev">Use</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</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?com/amazon/carbonado/layout/class-use/LayoutSync.html" target="_top">Frames</a></li> +<li><a href="LayoutSync.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"> +<h2 title="Uses of Class com.amazon.carbonado.layout.LayoutSync" class="title">Uses of Class<br>com.amazon.carbonado.layout.LayoutSync</h2> +</div> +<div class="classUseContainer">No usage of com.amazon.carbonado.layout.LayoutSync</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><a href="../package-summary.html">Package</a></li> +<li><a href="../../../../../com/amazon/carbonado/layout/LayoutSync.html" title="class in com.amazon.carbonado.layout">Class</a></li> +<li class="navBarCell1Rev">Use</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</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?com/amazon/carbonado/layout/class-use/LayoutSync.html" target="_top">Frames</a></li> +<li><a href="LayoutSync.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 © 2006-2013 <a href="https://github.com/Carbonado/Carbonado">Amazon Technologies, Inc.</a>. All Rights Reserved.</small></p> +</body> +</html> diff --git a/apidocs/com/amazon/carbonado/layout/class-use/StoredLayout.html b/apidocs/com/amazon/carbonado/layout/class-use/StoredLayout.html new file mode 100644 index 0000000..15fc3f1 --- /dev/null +++ b/apidocs/com/amazon/carbonado/layout/class-use/StoredLayout.html @@ -0,0 +1,117 @@ +<!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:45 PST 2013 --> +<meta http-equiv="Content-Type" content="text/html" charset="UTF-8"> +<title>Uses of Interface com.amazon.carbonado.layout.StoredLayout (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="Uses of Interface com.amazon.carbonado.layout.StoredLayout (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><a href="../../../../../com/amazon/carbonado/layout/StoredLayout.html" title="interface in com.amazon.carbonado.layout">Class</a></li> +<li class="navBarCell1Rev">Use</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</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?com/amazon/carbonado/layout/class-use/StoredLayout.html" target="_top">Frames</a></li> +<li><a href="StoredLayout.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"> +<h2 title="Uses of Interface com.amazon.carbonado.layout.StoredLayout" class="title">Uses of Interface<br>com.amazon.carbonado.layout.StoredLayout</h2> +</div> +<div class="classUseContainer">No usage of com.amazon.carbonado.layout.StoredLayout</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><a href="../package-summary.html">Package</a></li> +<li><a href="../../../../../com/amazon/carbonado/layout/StoredLayout.html" title="interface in com.amazon.carbonado.layout">Class</a></li> +<li class="navBarCell1Rev">Use</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</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?com/amazon/carbonado/layout/class-use/StoredLayout.html" target="_top">Frames</a></li> +<li><a href="StoredLayout.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 © 2006-2013 <a href="https://github.com/Carbonado/Carbonado">Amazon Technologies, Inc.</a>. All Rights Reserved.</small></p> +</body> +</html> diff --git a/apidocs/com/amazon/carbonado/layout/class-use/StoredLayoutEquivalence.html b/apidocs/com/amazon/carbonado/layout/class-use/StoredLayoutEquivalence.html new file mode 100644 index 0000000..26c05dd --- /dev/null +++ b/apidocs/com/amazon/carbonado/layout/class-use/StoredLayoutEquivalence.html @@ -0,0 +1,117 @@ +<!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:45 PST 2013 --> +<meta http-equiv="Content-Type" content="text/html" charset="UTF-8"> +<title>Uses of Interface com.amazon.carbonado.layout.StoredLayoutEquivalence (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="Uses of Interface com.amazon.carbonado.layout.StoredLayoutEquivalence (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><a href="../../../../../com/amazon/carbonado/layout/StoredLayoutEquivalence.html" title="interface in com.amazon.carbonado.layout">Class</a></li> +<li class="navBarCell1Rev">Use</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</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?com/amazon/carbonado/layout/class-use/StoredLayoutEquivalence.html" target="_top">Frames</a></li> +<li><a href="StoredLayoutEquivalence.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"> +<h2 title="Uses of Interface com.amazon.carbonado.layout.StoredLayoutEquivalence" class="title">Uses of Interface<br>com.amazon.carbonado.layout.StoredLayoutEquivalence</h2> +</div> +<div class="classUseContainer">No usage of com.amazon.carbonado.layout.StoredLayoutEquivalence</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><a href="../package-summary.html">Package</a></li> +<li><a href="../../../../../com/amazon/carbonado/layout/StoredLayoutEquivalence.html" title="interface in com.amazon.carbonado.layout">Class</a></li> +<li class="navBarCell1Rev">Use</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</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?com/amazon/carbonado/layout/class-use/StoredLayoutEquivalence.html" target="_top">Frames</a></li> +<li><a href="StoredLayoutEquivalence.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 © 2006-2013 <a href="https://github.com/Carbonado/Carbonado">Amazon Technologies, Inc.</a>. All Rights Reserved.</small></p> +</body> +</html> diff --git a/apidocs/com/amazon/carbonado/layout/class-use/StoredLayoutProperty.html b/apidocs/com/amazon/carbonado/layout/class-use/StoredLayoutProperty.html new file mode 100644 index 0000000..a344a31 --- /dev/null +++ b/apidocs/com/amazon/carbonado/layout/class-use/StoredLayoutProperty.html @@ -0,0 +1,117 @@ +<!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:45 PST 2013 --> +<meta http-equiv="Content-Type" content="text/html" charset="UTF-8"> +<title>Uses of Interface com.amazon.carbonado.layout.StoredLayoutProperty (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="Uses of Interface com.amazon.carbonado.layout.StoredLayoutProperty (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><a href="../../../../../com/amazon/carbonado/layout/StoredLayoutProperty.html" title="interface in com.amazon.carbonado.layout">Class</a></li> +<li class="navBarCell1Rev">Use</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</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?com/amazon/carbonado/layout/class-use/StoredLayoutProperty.html" target="_top">Frames</a></li> +<li><a href="StoredLayoutProperty.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"> +<h2 title="Uses of Interface com.amazon.carbonado.layout.StoredLayoutProperty" class="title">Uses of Interface<br>com.amazon.carbonado.layout.StoredLayoutProperty</h2> +</div> +<div class="classUseContainer">No usage of com.amazon.carbonado.layout.StoredLayoutProperty</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><a href="../package-summary.html">Package</a></li> +<li><a href="../../../../../com/amazon/carbonado/layout/StoredLayoutProperty.html" title="interface in com.amazon.carbonado.layout">Class</a></li> +<li class="navBarCell1Rev">Use</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</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?com/amazon/carbonado/layout/class-use/StoredLayoutProperty.html" target="_top">Frames</a></li> +<li><a href="StoredLayoutProperty.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 © 2006-2013 <a href="https://github.com/Carbonado/Carbonado">Amazon Technologies, Inc.</a>. All Rights Reserved.</small></p> +</body> +</html> diff --git a/apidocs/com/amazon/carbonado/layout/class-use/Unevolvable.html b/apidocs/com/amazon/carbonado/layout/class-use/Unevolvable.html new file mode 100644 index 0000000..afa80a1 --- /dev/null +++ b/apidocs/com/amazon/carbonado/layout/class-use/Unevolvable.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:45 PST 2013 --> +<meta http-equiv="Content-Type" content="text/html" charset="UTF-8"> +<title>Uses of Interface com.amazon.carbonado.layout.Unevolvable (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="Uses of Interface com.amazon.carbonado.layout.Unevolvable (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><a href="../../../../../com/amazon/carbonado/layout/Unevolvable.html" title="interface in com.amazon.carbonado.layout">Class</a></li> +<li class="navBarCell1Rev">Use</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</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?com/amazon/carbonado/layout/class-use/Unevolvable.html" target="_top">Frames</a></li> +<li><a href="Unevolvable.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"> +<h2 title="Uses of Interface com.amazon.carbonado.layout.Unevolvable" class="title">Uses of Interface<br>com.amazon.carbonado.layout.Unevolvable</h2> +</div> +<div class="classUseContainer"> +<ul class="blockList"> +<li class="blockList"> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing packages, and an explanation"> +<caption><span>Packages that use <a href="../../../../../com/amazon/carbonado/layout/Unevolvable.html" title="interface in com.amazon.carbonado.layout">Unevolvable</a></span><span class="tabEnd"> </span></caption> +<tr> +<th class="colFirst" scope="col">Package</th> +<th class="colLast" scope="col">Description</th> +</tr> +<tbody> +<tr class="altColor"> +<td class="colFirst"><a href="#com.amazon.carbonado.layout">com.amazon.carbonado.layout</a></td> +<td class="colLast"> +<div class="block">Support for recording the evolution of a storable's layout, used internally + by some repositories.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><a href="#com.amazon.carbonado.repo.indexed">com.amazon.carbonado.repo.indexed</a></td> +<td class="colLast"> +<div class="block">Repository implementation that adds index support for repositories that have + little or no index support.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><a href="#com.amazon.carbonado.repo.sleepycat">com.amazon.carbonado.repo.sleepycat</a></td> +<td class="colLast"> +<div class="block">Repository implementation backed by a Sleepycat (BDB, Berkeley) + database.</div> +</td> +</tr> +</tbody> +</table> +</li> +<li class="blockList"> +<ul class="blockList"> +<li class="blockList"><a name="com.amazon.carbonado.layout"> +<!-- --> +</a> +<h3>Uses of <a href="../../../../../com/amazon/carbonado/layout/Unevolvable.html" title="interface in com.amazon.carbonado.layout">Unevolvable</a> in <a href="../../../../../com/amazon/carbonado/layout/package-summary.html">com.amazon.carbonado.layout</a></h3> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing subinterfaces, and an explanation"> +<caption><span>Subinterfaces of <a href="../../../../../com/amazon/carbonado/layout/Unevolvable.html" title="interface in com.amazon.carbonado.layout">Unevolvable</a> in <a href="../../../../../com/amazon/carbonado/layout/package-summary.html">com.amazon.carbonado.layout</a></span><span class="tabEnd"> </span></caption> +<tr> +<th class="colFirst" scope="col">Modifier and Type</th> +<th class="colLast" scope="col">Interface and Description</th> +</tr> +<tbody> +<tr class="altColor"> +<td class="colFirst"><code>interface </code></td> +<td class="colLast"><code><strong><a href="../../../../../com/amazon/carbonado/layout/StoredLayout.html" title="interface in com.amazon.carbonado.layout">StoredLayout</a></strong></code> +<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="rowColor"> +<td class="colFirst"><code>interface </code></td> +<td class="colLast"><code><strong><a href="../../../../../com/amazon/carbonado/layout/StoredLayoutEquivalence.html" title="interface in com.amazon.carbonado.layout">StoredLayoutEquivalence</a></strong></code> +<div class="block">Maps layout generations which are equivalent.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>interface </code></td> +<td class="colLast"><code><strong><a href="../../../../../com/amazon/carbonado/layout/StoredLayoutProperty.html" title="interface in com.amazon.carbonado.layout">StoredLayoutProperty</a></strong></code> +<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> +</tbody> +</table> +</li> +<li class="blockList"><a name="com.amazon.carbonado.repo.indexed"> +<!-- --> +</a> +<h3>Uses of <a href="../../../../../com/amazon/carbonado/layout/Unevolvable.html" title="interface in com.amazon.carbonado.layout">Unevolvable</a> in <a href="../../../../../com/amazon/carbonado/repo/indexed/package-summary.html">com.amazon.carbonado.repo.indexed</a></h3> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing subinterfaces, and an explanation"> +<caption><span>Subinterfaces of <a href="../../../../../com/amazon/carbonado/layout/Unevolvable.html" title="interface in com.amazon.carbonado.layout">Unevolvable</a> in <a href="../../../../../com/amazon/carbonado/repo/indexed/package-summary.html">com.amazon.carbonado.repo.indexed</a></span><span class="tabEnd"> </span></caption> +<tr> +<th class="colFirst" scope="col">Modifier and Type</th> +<th class="colLast" scope="col">Interface and Description</th> +</tr> +<tbody> +<tr class="altColor"> +<td class="colFirst"><code>interface </code></td> +<td class="colLast"><code><strong><a href="../../../../../com/amazon/carbonado/repo/indexed/StoredIndexInfo.html" title="interface in com.amazon.carbonado.repo.indexed">StoredIndexInfo</a></strong></code> +<div class="block">Stores basic information about the indexes managed by IndexedRepository.</div> +</td> +</tr> +</tbody> +</table> +</li> +<li class="blockList"><a name="com.amazon.carbonado.repo.sleepycat"> +<!-- --> +</a> +<h3>Uses of <a href="../../../../../com/amazon/carbonado/layout/Unevolvable.html" title="interface in com.amazon.carbonado.layout">Unevolvable</a> in <a href="../../../../../com/amazon/carbonado/repo/sleepycat/package-summary.html">com.amazon.carbonado.repo.sleepycat</a></h3> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing classes, and an explanation"> +<caption><span>Classes in <a href="../../../../../com/amazon/carbonado/repo/sleepycat/package-summary.html">com.amazon.carbonado.repo.sleepycat</a> that implement <a href="../../../../../com/amazon/carbonado/layout/Unevolvable.html" title="interface in com.amazon.carbonado.layout">Unevolvable</a></span><span class="tabEnd"> </span></caption> +<tr> +<th class="colFirst" scope="col">Modifier and Type</th> +<th class="colLast" scope="col">Class and Description</th> +</tr> +<tbody> +<tr class="altColor"> +<td class="colFirst"><code>class </code></td> +<td class="colLast"><code><strong><a href="../../../../../com/amazon/carbonado/repo/sleepycat/StoredDatabaseInfo.html" title="class in com.amazon.carbonado.repo.sleepycat">StoredDatabaseInfo</a></strong></code> +<div class="block">Stores basic information about the BDB databases managed by BDBRepository.</div> +</td> +</tr> +</tbody> +</table> +</li> +</ul> +</li> +</ul> +</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><a href="../package-summary.html">Package</a></li> +<li><a href="../../../../../com/amazon/carbonado/layout/Unevolvable.html" title="interface in com.amazon.carbonado.layout">Class</a></li> +<li class="navBarCell1Rev">Use</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</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?com/amazon/carbonado/layout/class-use/Unevolvable.html" target="_top">Frames</a></li> +<li><a href="Unevolvable.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 © 2006-2013 <a href="https://github.com/Carbonado/Carbonado">Amazon Technologies, Inc.</a>. All Rights Reserved.</small></p> +</body> +</html> diff --git a/apidocs/com/amazon/carbonado/layout/package-frame.html b/apidocs/com/amazon/carbonado/layout/package-frame.html new file mode 100644 index 0000000..58eea25 --- /dev/null +++ b/apidocs/com/amazon/carbonado/layout/package-frame.html @@ -0,0 +1,32 @@ +<!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> +<h1 class="bar"><a href="../../../../com/amazon/carbonado/layout/package-summary.html" target="classFrame">com.amazon.carbonado.layout</a></h1> +<div class="indexContainer"> +<h2 title="Interfaces">Interfaces</h2> +<ul title="Interfaces"> +<li><a href="LayoutCapability.html" title="interface in com.amazon.carbonado.layout" target="classFrame"><i>LayoutCapability</i></a></li> +<li><a href="StoredLayout.html" title="interface in com.amazon.carbonado.layout" target="classFrame"><i>StoredLayout</i></a></li> +<li><a href="StoredLayoutEquivalence.html" title="interface in com.amazon.carbonado.layout" target="classFrame"><i>StoredLayoutEquivalence</i></a></li> +<li><a href="StoredLayoutProperty.html" title="interface in com.amazon.carbonado.layout" target="classFrame"><i>StoredLayoutProperty</i></a></li> +<li><a href="Unevolvable.html" title="interface in com.amazon.carbonado.layout" target="classFrame"><i>Unevolvable</i></a></li> +</ul> +<h2 title="Classes">Classes</h2> +<ul title="Classes"> +<li><a href="Layout.html" title="class in com.amazon.carbonado.layout" target="classFrame">Layout</a></li> +<li><a href="LayoutFactory.html" title="class in com.amazon.carbonado.layout" target="classFrame">LayoutFactory</a></li> +<li><a href="LayoutOptions.html" title="class in com.amazon.carbonado.layout" target="classFrame">LayoutOptions</a></li> +<li><a href="LayoutProperty.html" title="class in com.amazon.carbonado.layout" target="classFrame">LayoutProperty</a></li> +<li><a href="LayoutSync.html" title="class in com.amazon.carbonado.layout" target="classFrame">LayoutSync</a></li> +</ul> +</div> +</body> +</html> 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 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: <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"> </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"> </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 © 2006-2013 <a href="https://github.com/Carbonado/Carbonado">Amazon Technologies, Inc.</a>. All Rights Reserved.</small></p> +</body> +</html> diff --git a/apidocs/com/amazon/carbonado/layout/package-tree.html b/apidocs/com/amazon/carbonado/layout/package-tree.html new file mode 100644 index 0000000..3255207 --- /dev/null +++ b/apidocs/com/amazon/carbonado/layout/package-tree.html @@ -0,0 +1,156 @@ +<!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 Class Hierarchy (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 Class Hierarchy (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</li> +<li>Use</li> +<li class="navBarCell1Rev">Tree</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-tree.html">Prev</a></li> +<li><a href="../../../../com/amazon/carbonado/lob/package-tree.html">Next</a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?com/amazon/carbonado/layout/package-tree.html" target="_top">Frames</a></li> +<li><a href="package-tree.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 class="title">Hierarchy For Package com.amazon.carbonado.layout</h1> +<span class="strong">Package Hierarchies:</span> +<ul class="horizontal"> +<li><a href="../../../../overview-tree.html">All Packages</a></li> +</ul> +</div> +<div class="contentContainer"> +<h2 title="Class Hierarchy">Class Hierarchy</h2> +<ul> +<li type="circle">java.lang.Object +<ul> +<li type="circle">com.amazon.carbonado.layout.<a href="../../../../com/amazon/carbonado/layout/Layout.html" title="class in com.amazon.carbonado.layout"><span class="strong">Layout</span></a></li> +<li type="circle">com.amazon.carbonado.layout.<a href="../../../../com/amazon/carbonado/layout/LayoutFactory.html" title="class in com.amazon.carbonado.layout"><span class="strong">LayoutFactory</span></a> (implements com.amazon.carbonado.layout.<a href="../../../../com/amazon/carbonado/layout/LayoutCapability.html" title="interface in com.amazon.carbonado.layout">LayoutCapability</a>)</li> +<li type="circle">com.amazon.carbonado.layout.<a href="../../../../com/amazon/carbonado/layout/LayoutOptions.html" title="class in com.amazon.carbonado.layout"><span class="strong">LayoutOptions</span></a></li> +<li type="circle">com.amazon.carbonado.layout.<a href="../../../../com/amazon/carbonado/layout/LayoutProperty.html" title="class in com.amazon.carbonado.layout"><span class="strong">LayoutProperty</span></a></li> +<li type="circle">com.amazon.carbonado.layout.<a href="../../../../com/amazon/carbonado/layout/LayoutSync.html" title="class in com.amazon.carbonado.layout"><span class="strong">LayoutSync</span></a></li> +</ul> +</li> +</ul> +<h2 title="Interface Hierarchy">Interface Hierarchy</h2> +<ul> +<li type="circle">com.amazon.carbonado.capability.<a href="../../../../com/amazon/carbonado/capability/Capability.html" title="interface in com.amazon.carbonado.capability"><span class="strong">Capability</span></a> +<ul> +<li type="circle">com.amazon.carbonado.layout.<a href="../../../../com/amazon/carbonado/layout/LayoutCapability.html" title="interface in com.amazon.carbonado.layout"><span class="strong">LayoutCapability</span></a></li> +</ul> +</li> +<li type="circle">com.amazon.carbonado.<a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado"><span class="strong">Storable</span></a><S> +<ul> +<li type="circle">com.amazon.carbonado.layout.<a href="../../../../com/amazon/carbonado/layout/StoredLayout.html" title="interface in com.amazon.carbonado.layout"><span class="strong">StoredLayout</span></a> (also extends com.amazon.carbonado.layout.<a href="../../../../com/amazon/carbonado/layout/Unevolvable.html" title="interface in com.amazon.carbonado.layout">Unevolvable</a>)</li> +<li type="circle">com.amazon.carbonado.layout.<a href="../../../../com/amazon/carbonado/layout/StoredLayoutEquivalence.html" title="interface in com.amazon.carbonado.layout"><span class="strong">StoredLayoutEquivalence</span></a> (also extends com.amazon.carbonado.layout.<a href="../../../../com/amazon/carbonado/layout/Unevolvable.html" title="interface in com.amazon.carbonado.layout">Unevolvable</a>)</li> +<li type="circle">com.amazon.carbonado.layout.<a href="../../../../com/amazon/carbonado/layout/StoredLayoutProperty.html" title="interface in com.amazon.carbonado.layout"><span class="strong">StoredLayoutProperty</span></a> (also extends com.amazon.carbonado.layout.<a href="../../../../com/amazon/carbonado/layout/Unevolvable.html" title="interface in com.amazon.carbonado.layout">Unevolvable</a>)</li> +</ul> +</li> +<li type="circle">com.amazon.carbonado.layout.<a href="../../../../com/amazon/carbonado/layout/Unevolvable.html" title="interface in com.amazon.carbonado.layout"><span class="strong">Unevolvable</span></a> +<ul> +<li type="circle">com.amazon.carbonado.layout.<a href="../../../../com/amazon/carbonado/layout/StoredLayout.html" title="interface in com.amazon.carbonado.layout"><span class="strong">StoredLayout</span></a> (also extends com.amazon.carbonado.<a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a><S>)</li> +<li type="circle">com.amazon.carbonado.layout.<a href="../../../../com/amazon/carbonado/layout/StoredLayoutEquivalence.html" title="interface in com.amazon.carbonado.layout"><span class="strong">StoredLayoutEquivalence</span></a> (also extends com.amazon.carbonado.<a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a><S>)</li> +<li type="circle">com.amazon.carbonado.layout.<a href="../../../../com/amazon/carbonado/layout/StoredLayoutProperty.html" title="interface in com.amazon.carbonado.layout"><span class="strong">StoredLayoutProperty</span></a> (also extends com.amazon.carbonado.<a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a><S>)</li> +</ul> +</li> +</ul> +</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><a href="package-summary.html">Package</a></li> +<li>Class</li> +<li>Use</li> +<li class="navBarCell1Rev">Tree</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-tree.html">Prev</a></li> +<li><a href="../../../../com/amazon/carbonado/lob/package-tree.html">Next</a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?com/amazon/carbonado/layout/package-tree.html" target="_top">Frames</a></li> +<li><a href="package-tree.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 © 2006-2013 <a href="https://github.com/Carbonado/Carbonado">Amazon Technologies, Inc.</a>. All Rights Reserved.</small></p> +</body> +</html> diff --git a/apidocs/com/amazon/carbonado/layout/package-use.html b/apidocs/com/amazon/carbonado/layout/package-use.html new file mode 100644 index 0000000..a42c9f0 --- /dev/null +++ b/apidocs/com/amazon/carbonado/layout/package-use.html @@ -0,0 +1,252 @@ +<!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:45 PST 2013 --> +<meta http-equiv="Content-Type" content="text/html" charset="UTF-8"> +<title>Uses of Package 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="Uses of Package 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><a href="package-summary.html">Package</a></li> +<li>Class</li> +<li class="navBarCell1Rev">Use</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</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?com/amazon/carbonado/layout/package-use.html" target="_top">Frames</a></li> +<li><a href="package-use.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="Uses of Package com.amazon.carbonado.layout" class="title">Uses of Package<br>com.amazon.carbonado.layout</h1> +</div> +<div class="contentContainer"> +<ul class="blockList"> +<li class="blockList"> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing packages, and an explanation"> +<caption><span>Packages that use <a href="../../../../com/amazon/carbonado/layout/package-summary.html">com.amazon.carbonado.layout</a></span><span class="tabEnd"> </span></caption> +<tr> +<th class="colFirst" scope="col">Package</th> +<th class="colLast" scope="col">Description</th> +</tr> +<tbody> +<tr class="altColor"> +<td class="colFirst"><a href="#com.amazon.carbonado.layout">com.amazon.carbonado.layout</a></td> +<td class="colLast"> +<div class="block">Support for recording the evolution of a storable's layout, used internally + by some repositories.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><a href="#com.amazon.carbonado.raw">com.amazon.carbonado.raw</a></td> +<td class="colLast"> +<div class="block">Provides support for repositories that encode/decode storables in a raw + binary format.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><a href="#com.amazon.carbonado.repo.indexed">com.amazon.carbonado.repo.indexed</a></td> +<td class="colLast"> +<div class="block">Repository implementation that adds index support for repositories that have + little or no index support.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><a href="#com.amazon.carbonado.repo.sleepycat">com.amazon.carbonado.repo.sleepycat</a></td> +<td class="colLast"> +<div class="block">Repository implementation backed by a Sleepycat (BDB, Berkeley) + database.</div> +</td> +</tr> +</tbody> +</table> +</li> +<li class="blockList"><a name="com.amazon.carbonado.layout"> +<!-- --> +</a> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing classes, and an explanation"> +<caption><span>Classes in <a href="../../../../com/amazon/carbonado/layout/package-summary.html">com.amazon.carbonado.layout</a> used by <a href="../../../../com/amazon/carbonado/layout/package-summary.html">com.amazon.carbonado.layout</a></span><span class="tabEnd"> </span></caption> +<tr> +<th class="colOne" scope="col">Class and Description</th> +</tr> +<tbody> +<tr class="altColor"> +<td class="colOne"><a href="../../../../com/amazon/carbonado/layout/class-use/Layout.html#com.amazon.carbonado.layout">Layout</a> +<div class="block">Describes the layout of a specific generation of a storable.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colOne"><a href="../../../../com/amazon/carbonado/layout/class-use/LayoutCapability.html#com.amazon.carbonado.layout">LayoutCapability</a> +<div class="block">Capability to get layout information on any storable generation.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colOne"><a href="../../../../com/amazon/carbonado/layout/class-use/LayoutOptions.html#com.amazon.carbonado.layout">LayoutOptions</a> +<div class="block">Extra options encoded with a Storable layout.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colOne"><a href="../../../../com/amazon/carbonado/layout/class-use/LayoutProperty.html#com.amazon.carbonado.layout">LayoutProperty</a> +<div class="block">Describes how a property is defined in a specific generation of a storable.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colOne"><a href="../../../../com/amazon/carbonado/layout/class-use/Unevolvable.html#com.amazon.carbonado.layout">Unevolvable</a> +<div class="block">Marker interface for storables that are not allowed to evolve.</div> +</td> +</tr> +</tbody> +</table> +</li> +<li class="blockList"><a name="com.amazon.carbonado.raw"> +<!-- --> +</a> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing classes, and an explanation"> +<caption><span>Classes in <a href="../../../../com/amazon/carbonado/layout/package-summary.html">com.amazon.carbonado.layout</a> used by <a href="../../../../com/amazon/carbonado/raw/package-summary.html">com.amazon.carbonado.raw</a></span><span class="tabEnd"> </span></caption> +<tr> +<th class="colOne" scope="col">Class and Description</th> +</tr> +<tbody> +<tr class="altColor"> +<td class="colOne"><a href="../../../../com/amazon/carbonado/layout/class-use/Layout.html#com.amazon.carbonado.raw">Layout</a> +<div class="block">Describes the layout of a specific generation of a storable.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colOne"><a href="../../../../com/amazon/carbonado/layout/class-use/LayoutOptions.html#com.amazon.carbonado.raw">LayoutOptions</a> +<div class="block">Extra options encoded with a Storable layout.</div> +</td> +</tr> +</tbody> +</table> +</li> +<li class="blockList"><a name="com.amazon.carbonado.repo.indexed"> +<!-- --> +</a> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing classes, and an explanation"> +<caption><span>Classes in <a href="../../../../com/amazon/carbonado/layout/package-summary.html">com.amazon.carbonado.layout</a> used by <a href="../../../../com/amazon/carbonado/repo/indexed/package-summary.html">com.amazon.carbonado.repo.indexed</a></span><span class="tabEnd"> </span></caption> +<tr> +<th class="colOne" scope="col">Class and Description</th> +</tr> +<tbody> +<tr class="altColor"> +<td class="colOne"><a href="../../../../com/amazon/carbonado/layout/class-use/Unevolvable.html#com.amazon.carbonado.repo.indexed">Unevolvable</a> +<div class="block">Marker interface for storables that are not allowed to evolve.</div> +</td> +</tr> +</tbody> +</table> +</li> +<li class="blockList"><a name="com.amazon.carbonado.repo.sleepycat"> +<!-- --> +</a> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing classes, and an explanation"> +<caption><span>Classes in <a href="../../../../com/amazon/carbonado/layout/package-summary.html">com.amazon.carbonado.layout</a> used by <a href="../../../../com/amazon/carbonado/repo/sleepycat/package-summary.html">com.amazon.carbonado.repo.sleepycat</a></span><span class="tabEnd"> </span></caption> +<tr> +<th class="colOne" scope="col">Class and Description</th> +</tr> +<tbody> +<tr class="altColor"> +<td class="colOne"><a href="../../../../com/amazon/carbonado/layout/class-use/Unevolvable.html#com.amazon.carbonado.repo.sleepycat">Unevolvable</a> +<div class="block">Marker interface for storables that are not allowed to evolve.</div> +</td> +</tr> +</tbody> +</table> +</li> +</ul> +</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><a href="package-summary.html">Package</a></li> +<li>Class</li> +<li class="navBarCell1Rev">Use</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</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?com/amazon/carbonado/layout/package-use.html" target="_top">Frames</a></li> +<li><a href="package-use.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 © 2006-2013 <a href="https://github.com/Carbonado/Carbonado">Amazon Technologies, Inc.</a>. All Rights Reserved.</small></p> +</body> +</html> |