diff options
| author | Jesse Morgan <morganjm@amazon.com> | 2013-12-03 14:03:28 -0800 |
|---|---|---|
| committer | Jesse Morgan <morganjm@amazon.com> | 2013-12-03 14:03:28 -0800 |
| commit | d479253768d296a40b4f699e1de9b03c7146a97a (patch) | |
| tree | 208e70d81fc3e477a37d3f9ca6475c39bb6410d3 /apidocs/com/amazon/carbonado/raw/StorableCodecFactory.html | |
Adding javadocs and Carbonado User Guidegh-pages
Diffstat (limited to 'apidocs/com/amazon/carbonado/raw/StorableCodecFactory.html')
| -rw-r--r-- | apidocs/com/amazon/carbonado/raw/StorableCodecFactory.html | 291 |
1 files changed, 291 insertions, 0 deletions
diff --git a/apidocs/com/amazon/carbonado/raw/StorableCodecFactory.html b/apidocs/com/amazon/carbonado/raw/StorableCodecFactory.html new file mode 100644 index 0000000..9a19a87 --- /dev/null +++ b/apidocs/com/amazon/carbonado/raw/StorableCodecFactory.html @@ -0,0 +1,291 @@ +<!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>StorableCodecFactory (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="StorableCodecFactory (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/StorableCodecFactory.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/raw/StorableCodec.html" title="interface in com.amazon.carbonado.raw"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../com/amazon/carbonado/raw/StorablePropertyInfo.html" title="class in com.amazon.carbonado.raw"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?com/amazon/carbonado/raw/StorableCodecFactory.html" target="_top">Frames</a></li> +<li><a href="StorableCodecFactory.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.raw</div> +<h2 title="Interface StorableCodecFactory" class="title">Interface StorableCodecFactory</h2> +</div> +<div class="contentContainer"> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<dl> +<dt>All Known Implementing Classes:</dt> +<dd><a href="../../../../com/amazon/carbonado/raw/CompressedStorableCodecFactory.html" title="class in com.amazon.carbonado.raw">CompressedStorableCodecFactory</a>, <a href="../../../../com/amazon/carbonado/raw/CustomStorableCodecFactory.html" title="class in com.amazon.carbonado.raw">CustomStorableCodecFactory</a>, <a href="../../../../com/amazon/carbonado/raw/GenericStorableCodecFactory.html" title="class in com.amazon.carbonado.raw">GenericStorableCodecFactory</a></dd> +</dl> +<hr> +<br> +<pre>public interface <span class="strong">StorableCodecFactory</span></pre> +<div class="block">Factory for creating instances of <a href="../../../../com/amazon/carbonado/raw/StorableCodec.html" title="interface in com.amazon.carbonado.raw"><code>StorableCodec</code></a>.</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><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"><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="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"><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="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/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>java.lang.String</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/raw/StorableCodecFactory.html#getStorageName(java.lang.Class)">getStorageName</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 preferred storage/database name for 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="getStorageName(java.lang.Class)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getStorageName</h4> +<pre>java.lang.String getStorageName(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/SupportException.html" title="class in com.amazon.carbonado">SupportException</a></pre> +<div class="block">Returns the preferred storage/database name for the given type. Return + null to let repository decide.</div> +<dl><dt><span class="strong">Throws:</span></dt> +<dd><code><a href="../../../../com/amazon/carbonado/SupportException.html" title="class in com.amazon.carbonado">SupportException</a></code> - if type is not supported</dd></dl> +</li> +</ul> +<a name="getLayoutOptions(java.lang.Class)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getLayoutOptions</h4> +<pre><a href="../../../../com/amazon/carbonado/layout/LayoutOptions.html" title="class in com.amazon.carbonado.layout">LayoutOptions</a> getLayoutOptions(java.lang.Class<? extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>> type)</pre> +<div class="block">Optionally return additional information regarding storable encoding.</div> +<dl><dt><span class="strong">Since:</span></dt> + <dd>1.2.1</dd></dl> +</li> +</ul> +<a name="createCodec(java.lang.Class, com.amazon.carbonado.info.StorableIndex, boolean, com.amazon.carbonado.layout.Layout)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>createCodec</h4> +<pre><S extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>> <a href="../../../../com/amazon/carbonado/raw/StorableCodec.html" title="interface in com.amazon.carbonado.raw">StorableCodec</a><S> createCodec(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) + throws <a href="../../../../com/amazon/carbonado/SupportException.html" title="class in com.amazon.carbonado">SupportException</a></pre> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>type</code> - type of storable to create codec for</dd><dd><code>pkIndex</code> - suggested index for primary key (optional)</dd><dd><code>isMaster</code> - when true, version properties and sequences are managed</dd><dd><code>layout</code> - when non-null, attempt to encode a storable layout + generation value in each storable</dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code><a href="../../../../com/amazon/carbonado/SupportException.html" title="class in com.amazon.carbonado">SupportException</a></code> - if type is not supported</dd></dl> +</li> +</ul> +<a name="createCodec(java.lang.Class, com.amazon.carbonado.info.StorableIndex, boolean, com.amazon.carbonado.layout.Layout, com.amazon.carbonado.raw.RawSupport)"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>createCodec</h4> +<pre><S extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>> <a href="../../../../com/amazon/carbonado/raw/StorableCodec.html" title="interface in com.amazon.carbonado.raw">StorableCodec</a><S> createCodec(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) + throws <a href="../../../../com/amazon/carbonado/SupportException.html" title="class in com.amazon.carbonado">SupportException</a></pre> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>type</code> - type of storable to create codec for</dd><dd><code>pkIndex</code> - suggested index for primary key (optional)</dd><dd><code>isMaster</code> - when true, version properties and sequences are managed</dd><dd><code>layout</code> - when non-null, attempt to encode a storable layout + generation value in each storable</dd><dd><code>support</code> - binds generated storable with a storage layer</dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code><a href="../../../../com/amazon/carbonado/SupportException.html" title="class in com.amazon.carbonado">SupportException</a></code> - if type is not supported</dd><dt><span class="strong">Since:</span></dt> + <dd>1.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/StorableCodecFactory.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/raw/StorableCodec.html" title="interface in com.amazon.carbonado.raw"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../com/amazon/carbonado/raw/StorablePropertyInfo.html" title="class in com.amazon.carbonado.raw"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?com/amazon/carbonado/raw/StorableCodecFactory.html" target="_top">Frames</a></li> +<li><a href="StorableCodecFactory.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> |