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/StorableCodec.html | |
Adding javadocs and Carbonado User Guidegh-pages
Diffstat (limited to 'apidocs/com/amazon/carbonado/raw/StorableCodec.html')
| -rw-r--r-- | apidocs/com/amazon/carbonado/raw/StorableCodec.html | 529 |
1 files changed, 529 insertions, 0 deletions
diff --git a/apidocs/com/amazon/carbonado/raw/StorableCodec.html b/apidocs/com/amazon/carbonado/raw/StorableCodec.html new file mode 100644 index 0000000..f647b5b --- /dev/null +++ b/apidocs/com/amazon/carbonado/raw/StorableCodec.html @@ -0,0 +1,529 @@ +<!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>StorableCodec (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="StorableCodec (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/StorableCodec.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/RawUtil.html" title="class in com.amazon.carbonado.raw"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../com/amazon/carbonado/raw/StorableCodecFactory.html" title="interface 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/StorableCodec.html" target="_top">Frames</a></li> +<li><a href="StorableCodec.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 StorableCodec" class="title">Interface StorableCodec<S extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>></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/CustomStorableCodec.html" title="class in com.amazon.carbonado.raw">CustomStorableCodec</a>, <a href="../../../../com/amazon/carbonado/raw/GenericStorableCodec.html" title="class in com.amazon.carbonado.raw">GenericStorableCodec</a></dd> +</dl> +<hr> +<br> +<pre>public interface <span class="strong">StorableCodec<S extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>></span></pre> +<div class="block">Supports encoding and decoding of storables.</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/raw/StorableCodecFactory.html" title="interface in com.amazon.carbonado.raw"><code>StorableCodecFactory</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>void</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/raw/StorableCodec.html#decode(S, int, byte[])">decode</a></strong>(<a href="../../../../com/amazon/carbonado/raw/StorableCodec.html" title="type parameter in StorableCodec">S</a> dest, + int generation, + byte[] data)</code> +<div class="block">Used for decoding different generations of Storable.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>byte[]</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/raw/StorableCodec.html#encodePrimaryKey(java.lang.Object[])">encodePrimaryKey</a></strong>(java.lang.Object[] values)</code> +<div class="block">Encode a key by extracting all the primary key properties from the given + storable.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>byte[]</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/raw/StorableCodec.html#encodePrimaryKey(java.lang.Object[], int, int)">encodePrimaryKey</a></strong>(java.lang.Object[] values, + int rangeStart, + int rangeEnd)</code> +<div class="block">Encode a key by extracting all the primary key properties from the given + storable.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>byte[]</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/raw/StorableCodec.html#encodePrimaryKey(S)">encodePrimaryKey</a></strong>(<a href="../../../../com/amazon/carbonado/raw/StorableCodec.html" title="type parameter in StorableCodec">S</a> storable)</code> +<div class="block">Encode a key by extracting all the primary key properties from the given + storable.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>byte[]</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/raw/StorableCodec.html#encodePrimaryKey(S, int, int)">encodePrimaryKey</a></strong>(<a href="../../../../com/amazon/carbonado/raw/StorableCodec.html" title="type parameter in StorableCodec">S</a> storable, + int rangeStart, + int rangeEnd)</code> +<div class="block">Encode a key by extracting all the primary key properties from the given + storable.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>byte[]</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/raw/StorableCodec.html#encodePrimaryKeyPrefix()">encodePrimaryKeyPrefix</a></strong>()</code> +<div class="block">Encode the primary key for when there are no values, but there may be a + prefix.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/info/StorableIndex.html" title="class in com.amazon.carbonado.info">StorableIndex</a><<a href="../../../../com/amazon/carbonado/raw/StorableCodec.html" title="type parameter in StorableCodec">S</a>></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/raw/StorableCodec.html#getPrimaryKeyIndex()">getPrimaryKeyIndex</a></strong>()</code> +<div class="block">Returns the sequence and directions of properties that make up the + primary key.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>int</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/raw/StorableCodec.html#getPrimaryKeyPrefixLength()">getPrimaryKeyPrefixLength</a></strong>()</code> +<div class="block">Returns the number of prefix bytes in the primary key, which may be + zero.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>java.lang.Class<<a href="../../../../com/amazon/carbonado/raw/StorableCodec.html" title="type parameter in StorableCodec">S</a>></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/raw/StorableCodec.html#getStorableType()">getStorableType</a></strong>()</code> +<div class="block">Returns the type of Storable produced by this codec.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/raw/RawSupport.html" title="interface in com.amazon.carbonado.raw">RawSupport</a><<a href="../../../../com/amazon/carbonado/raw/StorableCodec.html" title="type parameter in StorableCodec">S</a>></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/raw/StorableCodec.html#getSupport()">getSupport</a></strong>()</code> +<div class="block">Returns the default <a href="../../../../com/amazon/carbonado/raw/RawSupport.html" title="interface in com.amazon.carbonado.raw"><code>RawSupport</code></a> object that is supplied to + Storable instances produced by this codec.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/raw/StorableCodec.html" title="type parameter in StorableCodec">S</a></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/raw/StorableCodec.html#instantiate()">instantiate</a></strong>()</code> +<div class="block">Instantiate a Storable with no key or value defined yet.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/raw/StorableCodec.html" title="type parameter in StorableCodec">S</a></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/raw/StorableCodec.html#instantiate(byte[])">instantiate</a></strong>(byte[] key)</code> +<div class="block">Instantiate a Storable with no value defined yet.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/raw/StorableCodec.html" title="type parameter in StorableCodec">S</a></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/raw/StorableCodec.html#instantiate(byte[], byte[])">instantiate</a></strong>(byte[] key, + byte[] value)</code> +<div class="block">Instantiate a Storable with a specific key and value.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/raw/StorableCodec.html" title="type parameter in StorableCodec">S</a></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/raw/StorableCodec.html#instantiate(com.amazon.carbonado.raw.RawSupport)">instantiate</a></strong>(<a href="../../../../com/amazon/carbonado/raw/RawSupport.html" title="interface in com.amazon.carbonado.raw">RawSupport</a><<a href="../../../../com/amazon/carbonado/raw/StorableCodec.html" title="type parameter in StorableCodec">S</a>> support)</code> +<div class="block">Instantiate a Storable with no key or value defined yet.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/raw/StorableCodec.html" title="type parameter in StorableCodec">S</a></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/raw/StorableCodec.html#instantiate(com.amazon.carbonado.raw.RawSupport, byte[], byte[])">instantiate</a></strong>(<a href="../../../../com/amazon/carbonado/raw/RawSupport.html" title="interface in com.amazon.carbonado.raw">RawSupport</a><<a href="../../../../com/amazon/carbonado/raw/StorableCodec.html" title="type parameter in StorableCodec">S</a>> support, + byte[] key, + byte[] value)</code> +<div class="block">Instantiate a Storable with a specific key and value.</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="getStorableType()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getStorableType</h4> +<pre>java.lang.Class<<a href="../../../../com/amazon/carbonado/raw/StorableCodec.html" title="type parameter in StorableCodec">S</a>> getStorableType()</pre> +<div class="block">Returns the type of Storable produced by this codec.</div> +</li> +</ul> +<a name="instantiate()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>instantiate</h4> +<pre><a href="../../../../com/amazon/carbonado/raw/StorableCodec.html" title="type parameter in StorableCodec">S</a> instantiate()</pre> +<div class="block">Instantiate a Storable with no key or value defined yet. The default + <a href="../../../../com/amazon/carbonado/raw/RawSupport.html" title="interface in com.amazon.carbonado.raw"><code>RawSupport</code></a> is supplied to the instance.</div> +<dl><dt><span class="strong">Throws:</span></dt> +<dd><code>java.lang.IllegalStateException</code> - if no default support exists</dd><dt><span class="strong">Since:</span></dt> + <dd>1.2</dd></dl> +</li> +</ul> +<a name="instantiate(byte[])"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>instantiate</h4> +<pre><a href="../../../../com/amazon/carbonado/raw/StorableCodec.html" title="type parameter in StorableCodec">S</a> instantiate(byte[] key) + throws <a href="../../../../com/amazon/carbonado/FetchException.html" title="class in com.amazon.carbonado">FetchException</a></pre> +<div class="block">Instantiate a Storable with no value defined yet. The default <a href="../../../../com/amazon/carbonado/raw/RawSupport.html" title="interface in com.amazon.carbonado.raw"><code>RawSupport</code></a> is supplied to the instance.</div> +<dl><dt><span class="strong">Throws:</span></dt> +<dd><code>java.lang.IllegalStateException</code> - if no default support exists</dd> +<dd><code><a href="../../../../com/amazon/carbonado/FetchException.html" title="class in com.amazon.carbonado">FetchException</a></code></dd><dt><span class="strong">Since:</span></dt> + <dd>1.2</dd></dl> +</li> +</ul> +<a name="instantiate(byte[], byte[])"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>instantiate</h4> +<pre><a href="../../../../com/amazon/carbonado/raw/StorableCodec.html" title="type parameter in StorableCodec">S</a> instantiate(byte[] key, + byte[] value) + throws <a href="../../../../com/amazon/carbonado/FetchException.html" title="class in com.amazon.carbonado">FetchException</a></pre> +<div class="block">Instantiate a Storable with a specific key and value. The default + <a href="../../../../com/amazon/carbonado/raw/RawSupport.html" title="interface in com.amazon.carbonado.raw"><code>RawSupport</code></a> is supplied to the instance.</div> +<dl><dt><span class="strong">Throws:</span></dt> +<dd><code>java.lang.IllegalStateException</code> - if no default support exists</dd> +<dd><code><a href="../../../../com/amazon/carbonado/FetchException.html" title="class in com.amazon.carbonado">FetchException</a></code></dd><dt><span class="strong">Since:</span></dt> + <dd>1.2</dd></dl> +</li> +</ul> +<a name="instantiate(com.amazon.carbonado.raw.RawSupport)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>instantiate</h4> +<pre><a href="../../../../com/amazon/carbonado/raw/StorableCodec.html" title="type parameter in StorableCodec">S</a> instantiate(<a href="../../../../com/amazon/carbonado/raw/RawSupport.html" title="interface in com.amazon.carbonado.raw">RawSupport</a><<a href="../../../../com/amazon/carbonado/raw/StorableCodec.html" title="type parameter in StorableCodec">S</a>> support)</pre> +<div class="block">Instantiate a Storable with no key or value defined yet. Any + <a href="../../../../com/amazon/carbonado/raw/RawSupport.html" title="interface in com.amazon.carbonado.raw"><code>RawSupport</code></a> can be supplied to the instance.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>support</code> - binds generated storable with a storage layer</dd></dl> +</li> +</ul> +<a name="instantiate(com.amazon.carbonado.raw.RawSupport, byte[], byte[])"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>instantiate</h4> +<pre><a href="../../../../com/amazon/carbonado/raw/StorableCodec.html" title="type parameter in StorableCodec">S</a> instantiate(<a href="../../../../com/amazon/carbonado/raw/RawSupport.html" title="interface in com.amazon.carbonado.raw">RawSupport</a><<a href="../../../../com/amazon/carbonado/raw/StorableCodec.html" title="type parameter in StorableCodec">S</a>> support, + byte[] key, + byte[] value) + throws <a href="../../../../com/amazon/carbonado/FetchException.html" title="class in com.amazon.carbonado">FetchException</a></pre> +<div class="block">Instantiate a Storable with a specific key and value. Any + <a href="../../../../com/amazon/carbonado/raw/RawSupport.html" title="interface in com.amazon.carbonado.raw"><code>RawSupport</code></a> can be supplied to the instance.</div> +<dl><dt><span class="strong">Parameters:</span></dt><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/FetchException.html" title="class in com.amazon.carbonado">FetchException</a></code></dd></dl> +</li> +</ul> +<a name="getPrimaryKeyIndex()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getPrimaryKeyIndex</h4> +<pre><a href="../../../../com/amazon/carbonado/info/StorableIndex.html" title="class in com.amazon.carbonado.info">StorableIndex</a><<a href="../../../../com/amazon/carbonado/raw/StorableCodec.html" title="type parameter in StorableCodec">S</a>> getPrimaryKeyIndex()</pre> +<div class="block">Returns the sequence and directions of properties that make up the + primary key.</div> +</li> +</ul> +<a name="getPrimaryKeyPrefixLength()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getPrimaryKeyPrefixLength</h4> +<pre>int getPrimaryKeyPrefixLength()</pre> +<div class="block">Returns the number of prefix bytes in the primary key, which may be + zero.</div> +</li> +</ul> +<a name="encodePrimaryKey(com.amazon.carbonado.Storable)"> +<!-- --> +</a><a name="encodePrimaryKey(S)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>encodePrimaryKey</h4> +<pre>byte[] encodePrimaryKey(<a href="../../../../com/amazon/carbonado/raw/StorableCodec.html" title="type parameter in StorableCodec">S</a> storable)</pre> +<div class="block">Encode a key by extracting all the primary key properties from the given + storable.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>storable</code> - extract primary key properties from this instance</dd> +<dt><span class="strong">Returns:</span></dt><dd>raw search key</dd></dl> +</li> +</ul> +<a name="encodePrimaryKey(com.amazon.carbonado.Storable,int,int)"> +<!-- --> +</a><a name="encodePrimaryKey(S, int, int)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>encodePrimaryKey</h4> +<pre>byte[] encodePrimaryKey(<a href="../../../../com/amazon/carbonado/raw/StorableCodec.html" title="type parameter in StorableCodec">S</a> storable, + int rangeStart, + int rangeEnd)</pre> +<div class="block">Encode a key by extracting all the primary key properties from the given + storable.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>storable</code> - extract primary key properties from this instance</dd><dd><code>rangeStart</code> - index of first property to use. Its value must be less + than the count of primary key properties.</dd><dd><code>rangeEnd</code> - index of last property to use, exlusive. Its value must + be less than or equal to the count of primary key properties.</dd> +<dt><span class="strong">Returns:</span></dt><dd>raw search key</dd></dl> +</li> +</ul> +<a name="encodePrimaryKey(java.lang.Object[])"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>encodePrimaryKey</h4> +<pre>byte[] encodePrimaryKey(java.lang.Object[] values)</pre> +<div class="block">Encode a key by extracting all the primary key properties from the given + storable.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>values</code> - values to build into a key. It must be long enough to + accommodate all primary key properties.</dd> +<dt><span class="strong">Returns:</span></dt><dd>raw search key</dd></dl> +</li> +</ul> +<a name="encodePrimaryKey(java.lang.Object[], int, int)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>encodePrimaryKey</h4> +<pre>byte[] encodePrimaryKey(java.lang.Object[] values, + int rangeStart, + int rangeEnd)</pre> +<div class="block">Encode a key by extracting all the primary key properties from the given + storable.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>values</code> - values to build into a key. The length may be less than + the amount of primary key properties used by this factory. It must not + be less than the difference between rangeStart and rangeEnd.</dd><dd><code>rangeStart</code> - index of first property to use. Its value must be less + than the count of primary key properties.</dd><dd><code>rangeEnd</code> - index of last property to use, exlusive. Its value must + be less than or equal to the count of primary key properties.</dd> +<dt><span class="strong">Returns:</span></dt><dd>raw search key</dd></dl> +</li> +</ul> +<a name="encodePrimaryKeyPrefix()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>encodePrimaryKeyPrefix</h4> +<pre>byte[] encodePrimaryKeyPrefix()</pre> +<div class="block">Encode the primary key for when there are no values, but there may be a + prefix. Returned value may be null if no prefix is defined.</div> +</li> +</ul> +<a name="decode(com.amazon.carbonado.Storable,int,byte[])"> +<!-- --> +</a><a name="decode(S, int, byte[])"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>decode</h4> +<pre>void decode(<a href="../../../../com/amazon/carbonado/raw/StorableCodec.html" title="type parameter in StorableCodec">S</a> dest, + int generation, + byte[] data) + throws <a href="../../../../com/amazon/carbonado/CorruptEncodingException.html" title="class in com.amazon.carbonado">CorruptEncodingException</a></pre> +<div class="block">Used for decoding different generations of Storable. If layout + generations are not supported, simply throw a CorruptEncodingException.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>dest</code> - storable to receive decoded properties</dd><dd><code>generation</code> - storable layout generation number</dd><dd><code>data</code> - decoded into properties, some of which may be dropped if + destination storable doesn't have it</dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code><a href="../../../../com/amazon/carbonado/CorruptEncodingException.html" title="class in com.amazon.carbonado">CorruptEncodingException</a></code> - if generation is unknown or if data cannot be decoded</dd><dt><span class="strong">Since:</span></dt> + <dd>1.2.1</dd></dl> +</li> +</ul> +<a name="getSupport()"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>getSupport</h4> +<pre><a href="../../../../com/amazon/carbonado/raw/RawSupport.html" title="interface in com.amazon.carbonado.raw">RawSupport</a><<a href="../../../../com/amazon/carbonado/raw/StorableCodec.html" title="type parameter in StorableCodec">S</a>> getSupport()</pre> +<div class="block">Returns the default <a href="../../../../com/amazon/carbonado/raw/RawSupport.html" title="interface in com.amazon.carbonado.raw"><code>RawSupport</code></a> object that is supplied to + Storable instances produced by this codec.</div> +<dl><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/StorableCodec.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/RawUtil.html" title="class in com.amazon.carbonado.raw"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../com/amazon/carbonado/raw/StorableCodecFactory.html" title="interface 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/StorableCodec.html" target="_top">Frames</a></li> +<li><a href="StorableCodec.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> |