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/DataDecoder.html | |
Adding javadocs and Carbonado User Guidegh-pages
Diffstat (limited to 'apidocs/com/amazon/carbonado/raw/DataDecoder.html')
| -rw-r--r-- | apidocs/com/amazon/carbonado/raw/DataDecoder.html | 879 |
1 files changed, 879 insertions, 0 deletions
diff --git a/apidocs/com/amazon/carbonado/raw/DataDecoder.html b/apidocs/com/amazon/carbonado/raw/DataDecoder.html new file mode 100644 index 0000000..d9c7e29 --- /dev/null +++ b/apidocs/com/amazon/carbonado/raw/DataDecoder.html @@ -0,0 +1,879 @@ +<!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:43 PST 2013 --> +<meta http-equiv="Content-Type" content="text/html" charset="UTF-8"> +<title>DataDecoder (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="DataDecoder (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/DataDecoder.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/CustomStorableCodecFactory.html" title="class in com.amazon.carbonado.raw"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../com/amazon/carbonado/raw/DataEncoder.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/DataDecoder.html" target="_top">Frames</a></li> +<li><a href="DataDecoder.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.raw</div> +<h2 title="Class DataDecoder" class="title">Class DataDecoder</h2> +</div> +<div class="contentContainer"> +<ul class="inheritance"> +<li>java.lang.Object</li> +<li> +<ul class="inheritance"> +<li>com.amazon.carbonado.raw.DataDecoder</li> +</ul> +</li> +</ul> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<hr> +<br> +<pre>public class <span class="strong">DataDecoder</span> +extends java.lang.Object</pre> +<div class="block">A very low-level class that decodes key components encoded by methods of + <a href="../../../../com/amazon/carbonado/raw/DataEncoder.html" title="class in com.amazon.carbonado.raw"><code>DataEncoder</code></a>.</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/KeyDecoder.html" title="class in com.amazon.carbonado.raw"><code>KeyDecoder</code></a></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/raw/DataDecoder.html#DataDecoder()">DataDecoder</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>static int</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/raw/DataDecoder.html#decode(byte[], int, java.math.BigDecimal[])">decode</a></strong>(byte[] src, + int srcOffset, + java.math.BigDecimal[] valueRef)</code> +<div class="block">Decodes a BigDecimal.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>static int</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/raw/DataDecoder.html#decode(byte[], int, java.math.BigInteger[])">decode</a></strong>(byte[] src, + int srcOffset, + java.math.BigInteger[] valueRef)</code> +<div class="block">Decodes a BigInteger.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>static int</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/raw/DataDecoder.html#decode(byte[], int, byte[][])">decode</a></strong>(byte[] src, + int srcOffset, + byte[][] valueRef)</code> +<div class="block">Decodes the given byte array.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>static boolean</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/raw/DataDecoder.html#decodeBoolean(byte[], int)">decodeBoolean</a></strong>(byte[] src, + int srcOffset)</code> +<div class="block">Decodes a boolean from exactly 1 byte.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>static java.lang.Boolean</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/raw/DataDecoder.html#decodeBooleanObj(byte[], int)">decodeBooleanObj</a></strong>(byte[] src, + int srcOffset)</code> +<div class="block">Decodes a Boolean object from exactly 1 byte.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>static byte</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/raw/DataDecoder.html#decodeByte(byte[], int)">decodeByte</a></strong>(byte[] src, + int srcOffset)</code> +<div class="block">Decodes a signed byte from exactly 1 byte.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>static java.lang.Byte</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/raw/DataDecoder.html#decodeByteObj(byte[], int)">decodeByteObj</a></strong>(byte[] src, + int srcOffset)</code> +<div class="block">Decodes a signed Byte object from exactly 1 or 2 bytes.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>static char</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/raw/DataDecoder.html#decodeChar(byte[], int)">decodeChar</a></strong>(byte[] src, + int srcOffset)</code> +<div class="block">Decodes a char from exactly 2 bytes.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>static java.lang.Character</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/raw/DataDecoder.html#decodeCharacterObj(byte[], int)">decodeCharacterObj</a></strong>(byte[] src, + int srcOffset)</code> +<div class="block">Decodes a Character object from exactly 1 or 3 bytes.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>static double</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/raw/DataDecoder.html#decodeDouble(byte[], int)">decodeDouble</a></strong>(byte[] src, + int srcOffset)</code> +<div class="block">Decodes a double from exactly 8 bytes.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>protected static long</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/raw/DataDecoder.html#decodeDoubleBits(byte[], int)">decodeDoubleBits</a></strong>(byte[] src, + int srcOffset)</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>static java.lang.Double</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/raw/DataDecoder.html#decodeDoubleObj(byte[], int)">decodeDoubleObj</a></strong>(byte[] src, + int srcOffset)</code> +<div class="block">Decodes a Double object from exactly 8 bytes.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>static float</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/raw/DataDecoder.html#decodeFloat(byte[], int)">decodeFloat</a></strong>(byte[] src, + int srcOffset)</code> +<div class="block">Decodes a float from exactly 4 bytes.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>protected static int</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/raw/DataDecoder.html#decodeFloatBits(byte[], int)">decodeFloatBits</a></strong>(byte[] src, + int srcOffset)</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>static java.lang.Float</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/raw/DataDecoder.html#decodeFloatObj(byte[], int)">decodeFloatObj</a></strong>(byte[] src, + int srcOffset)</code> +<div class="block">Decodes a Float object from exactly 4 bytes.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>static int</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/raw/DataDecoder.html#decodeInt(byte[], int)">decodeInt</a></strong>(byte[] src, + int srcOffset)</code> +<div class="block">Decodes a signed integer from exactly 4 bytes.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>static java.lang.Integer</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/raw/DataDecoder.html#decodeIntegerObj(byte[], int)">decodeIntegerObj</a></strong>(byte[] src, + int srcOffset)</code> +<div class="block">Decodes a signed Integer object from exactly 1 or 5 bytes.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>static long</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/raw/DataDecoder.html#decodeLong(byte[], int)">decodeLong</a></strong>(byte[] src, + int srcOffset)</code> +<div class="block">Decodes a signed long from exactly 8 bytes.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>static java.lang.Long</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/raw/DataDecoder.html#decodeLongObj(byte[], int)">decodeLongObj</a></strong>(byte[] src, + int srcOffset)</code> +<div class="block">Decodes a signed Long object from exactly 1 or 9 bytes.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>static short</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/raw/DataDecoder.html#decodeShort(byte[], int)">decodeShort</a></strong>(byte[] src, + int srcOffset)</code> +<div class="block">Decodes a signed short from exactly 2 bytes.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>static java.lang.Short</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/raw/DataDecoder.html#decodeShortObj(byte[], int)">decodeShortObj</a></strong>(byte[] src, + int srcOffset)</code> +<div class="block">Decodes a signed Short object from exactly 1 or 3 bytes.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>static byte[]</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/raw/DataDecoder.html#decodeSingle(byte[], int, int)">decodeSingle</a></strong>(byte[] src, + int prefixPadding, + int suffixPadding)</code> +<div class="block">Decodes the given byte array which was encoded by <a href="../../../../com/amazon/carbonado/raw/DataEncoder.html#encodeSingle(byte[], int, int)"><code>DataEncoder.encodeSingle(byte[], int, int)</code></a>.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>static byte[]</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/raw/DataDecoder.html#decodeSingleNullable(byte[])">decodeSingleNullable</a></strong>(byte[] src)</code> +<div class="block">Decodes the given byte array which was encoded by <a href="../../../../com/amazon/carbonado/raw/DataEncoder.html#encodeSingleNullable(byte[])"><code>DataEncoder.encodeSingleNullable(byte[])</code></a>.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>static byte[]</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/raw/DataDecoder.html#decodeSingleNullable(byte[], int, int)">decodeSingleNullable</a></strong>(byte[] src, + int prefixPadding, + int suffixPadding)</code> +<div class="block">Decodes the given byte array which was encoded by <a href="../../../../com/amazon/carbonado/raw/DataEncoder.html#encodeSingleNullable(byte[])"><code>DataEncoder.encodeSingleNullable(byte[])</code></a>.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>static int</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/raw/DataDecoder.html#decodeString(byte[], int, java.lang.String[])">decodeString</a></strong>(byte[] src, + int srcOffset, + java.lang.String[] valueRef)</code> +<div class="block">Decodes an encoded string from the given byte array.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>static void</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/raw/DataDecoder.html#readFully(java.io.InputStream, byte[])">readFully</a></strong>(java.io.InputStream in, + byte[] b)</code> +<div class="block">Reads as many bytes from the stream as is necessary to fill the given + byte array.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>static int</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/raw/DataDecoder.html#readLength(java.io.InputStream)">readLength</a></strong>(java.io.InputStream in)</code> +<div class="block">Decodes a length value which was encoded by <a href="../../../../com/amazon/carbonado/raw/DataEncoder.html#writeLength(int, java.io.OutputStream)"><code>DataEncoder.writeLength(int, 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"> +<!-- ========= CONSTRUCTOR DETAIL ======== --> +<ul class="blockList"> +<li class="blockList"><a name="constructor_detail"> +<!-- --> +</a> +<h3>Constructor Detail</h3> +<a name="DataDecoder()"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>DataDecoder</h4> +<pre>public DataDecoder()</pre> +</li> +</ul> +</li> +</ul> +<!-- ============ METHOD DETAIL ========== --> +<ul class="blockList"> +<li class="blockList"><a name="method_detail"> +<!-- --> +</a> +<h3>Method Detail</h3> +<a name="decodeInt(byte[], int)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>decodeInt</h4> +<pre>public static int decodeInt(byte[] src, + int srcOffset) + throws <a href="../../../../com/amazon/carbonado/CorruptEncodingException.html" title="class in com.amazon.carbonado">CorruptEncodingException</a></pre> +<div class="block">Decodes a signed integer from exactly 4 bytes.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>src</code> - source of encoded bytes</dd><dd><code>srcOffset</code> - offset into source array</dd> +<dt><span class="strong">Returns:</span></dt><dd>signed integer value</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></dd></dl> +</li> +</ul> +<a name="decodeIntegerObj(byte[], int)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>decodeIntegerObj</h4> +<pre>public static java.lang.Integer decodeIntegerObj(byte[] src, + int srcOffset) + throws <a href="../../../../com/amazon/carbonado/CorruptEncodingException.html" title="class in com.amazon.carbonado">CorruptEncodingException</a></pre> +<div class="block">Decodes a signed Integer object from exactly 1 or 5 bytes. If null is + returned, then 1 byte was read.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>src</code> - source of encoded bytes</dd><dd><code>srcOffset</code> - offset into source array</dd> +<dt><span class="strong">Returns:</span></dt><dd>signed Integer object or null</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></dd></dl> +</li> +</ul> +<a name="decodeLong(byte[], int)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>decodeLong</h4> +<pre>public static long decodeLong(byte[] src, + int srcOffset) + throws <a href="../../../../com/amazon/carbonado/CorruptEncodingException.html" title="class in com.amazon.carbonado">CorruptEncodingException</a></pre> +<div class="block">Decodes a signed long from exactly 8 bytes.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>src</code> - source of encoded bytes</dd><dd><code>srcOffset</code> - offset into source array</dd> +<dt><span class="strong">Returns:</span></dt><dd>signed long value</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></dd></dl> +</li> +</ul> +<a name="decodeLongObj(byte[], int)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>decodeLongObj</h4> +<pre>public static java.lang.Long decodeLongObj(byte[] src, + int srcOffset) + throws <a href="../../../../com/amazon/carbonado/CorruptEncodingException.html" title="class in com.amazon.carbonado">CorruptEncodingException</a></pre> +<div class="block">Decodes a signed Long object from exactly 1 or 9 bytes. If null is + returned, then 1 byte was read.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>src</code> - source of encoded bytes</dd><dd><code>srcOffset</code> - offset into source array</dd> +<dt><span class="strong">Returns:</span></dt><dd>signed Long object or null</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></dd></dl> +</li> +</ul> +<a name="decodeByte(byte[], int)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>decodeByte</h4> +<pre>public static byte decodeByte(byte[] src, + int srcOffset) + throws <a href="../../../../com/amazon/carbonado/CorruptEncodingException.html" title="class in com.amazon.carbonado">CorruptEncodingException</a></pre> +<div class="block">Decodes a signed byte from exactly 1 byte.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>src</code> - source of encoded bytes</dd><dd><code>srcOffset</code> - offset into source array</dd> +<dt><span class="strong">Returns:</span></dt><dd>signed byte value</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></dd></dl> +</li> +</ul> +<a name="decodeByteObj(byte[], int)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>decodeByteObj</h4> +<pre>public static java.lang.Byte decodeByteObj(byte[] src, + int srcOffset) + throws <a href="../../../../com/amazon/carbonado/CorruptEncodingException.html" title="class in com.amazon.carbonado">CorruptEncodingException</a></pre> +<div class="block">Decodes a signed Byte object from exactly 1 or 2 bytes. If null is + returned, then 1 byte was read.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>src</code> - source of encoded bytes</dd><dd><code>srcOffset</code> - offset into source array</dd> +<dt><span class="strong">Returns:</span></dt><dd>signed Byte object or null</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></dd></dl> +</li> +</ul> +<a name="decodeShort(byte[], int)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>decodeShort</h4> +<pre>public static short decodeShort(byte[] src, + int srcOffset) + throws <a href="../../../../com/amazon/carbonado/CorruptEncodingException.html" title="class in com.amazon.carbonado">CorruptEncodingException</a></pre> +<div class="block">Decodes a signed short from exactly 2 bytes.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>src</code> - source of encoded bytes</dd><dd><code>srcOffset</code> - offset into source array</dd> +<dt><span class="strong">Returns:</span></dt><dd>signed short value</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></dd></dl> +</li> +</ul> +<a name="decodeShortObj(byte[], int)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>decodeShortObj</h4> +<pre>public static java.lang.Short decodeShortObj(byte[] src, + int srcOffset) + throws <a href="../../../../com/amazon/carbonado/CorruptEncodingException.html" title="class in com.amazon.carbonado">CorruptEncodingException</a></pre> +<div class="block">Decodes a signed Short object from exactly 1 or 3 bytes. If null is + returned, then 1 byte was read.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>src</code> - source of encoded bytes</dd><dd><code>srcOffset</code> - offset into source array</dd> +<dt><span class="strong">Returns:</span></dt><dd>signed Short object or null</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></dd></dl> +</li> +</ul> +<a name="decodeChar(byte[], int)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>decodeChar</h4> +<pre>public static char decodeChar(byte[] src, + int srcOffset) + throws <a href="../../../../com/amazon/carbonado/CorruptEncodingException.html" title="class in com.amazon.carbonado">CorruptEncodingException</a></pre> +<div class="block">Decodes a char from exactly 2 bytes.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>src</code> - source of encoded bytes</dd><dd><code>srcOffset</code> - offset into source array</dd> +<dt><span class="strong">Returns:</span></dt><dd>char value</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></dd></dl> +</li> +</ul> +<a name="decodeCharacterObj(byte[], int)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>decodeCharacterObj</h4> +<pre>public static java.lang.Character decodeCharacterObj(byte[] src, + int srcOffset) + throws <a href="../../../../com/amazon/carbonado/CorruptEncodingException.html" title="class in com.amazon.carbonado">CorruptEncodingException</a></pre> +<div class="block">Decodes a Character object from exactly 1 or 3 bytes. If null is + returned, then 1 byte was read.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>src</code> - source of encoded bytes</dd><dd><code>srcOffset</code> - offset into source array</dd> +<dt><span class="strong">Returns:</span></dt><dd>Character object or null</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></dd></dl> +</li> +</ul> +<a name="decodeBoolean(byte[], int)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>decodeBoolean</h4> +<pre>public static boolean decodeBoolean(byte[] src, + int srcOffset) + throws <a href="../../../../com/amazon/carbonado/CorruptEncodingException.html" title="class in com.amazon.carbonado">CorruptEncodingException</a></pre> +<div class="block">Decodes a boolean from exactly 1 byte.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>src</code> - source of encoded bytes</dd><dd><code>srcOffset</code> - offset into source array</dd> +<dt><span class="strong">Returns:</span></dt><dd>boolean value</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></dd></dl> +</li> +</ul> +<a name="decodeBooleanObj(byte[], int)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>decodeBooleanObj</h4> +<pre>public static java.lang.Boolean decodeBooleanObj(byte[] src, + int srcOffset) + throws <a href="../../../../com/amazon/carbonado/CorruptEncodingException.html" title="class in com.amazon.carbonado">CorruptEncodingException</a></pre> +<div class="block">Decodes a Boolean object from exactly 1 byte.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>src</code> - source of encoded bytes</dd><dd><code>srcOffset</code> - offset into source array</dd> +<dt><span class="strong">Returns:</span></dt><dd>Boolean object or null</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></dd></dl> +</li> +</ul> +<a name="decodeFloat(byte[], int)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>decodeFloat</h4> +<pre>public static float decodeFloat(byte[] src, + int srcOffset) + throws <a href="../../../../com/amazon/carbonado/CorruptEncodingException.html" title="class in com.amazon.carbonado">CorruptEncodingException</a></pre> +<div class="block">Decodes a float from exactly 4 bytes.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>src</code> - source of encoded bytes</dd><dd><code>srcOffset</code> - offset into source array</dd> +<dt><span class="strong">Returns:</span></dt><dd>float value</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></dd></dl> +</li> +</ul> +<a name="decodeFloatObj(byte[], int)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>decodeFloatObj</h4> +<pre>public static java.lang.Float decodeFloatObj(byte[] src, + int srcOffset) + throws <a href="../../../../com/amazon/carbonado/CorruptEncodingException.html" title="class in com.amazon.carbonado">CorruptEncodingException</a></pre> +<div class="block">Decodes a Float object from exactly 4 bytes.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>src</code> - source of encoded bytes</dd><dd><code>srcOffset</code> - offset into source array</dd> +<dt><span class="strong">Returns:</span></dt><dd>Float object or null</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></dd></dl> +</li> +</ul> +<a name="decodeFloatBits(byte[], int)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>decodeFloatBits</h4> +<pre>protected static int decodeFloatBits(byte[] src, + int srcOffset) + throws <a href="../../../../com/amazon/carbonado/CorruptEncodingException.html" title="class in com.amazon.carbonado">CorruptEncodingException</a></pre> +<dl><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></dd></dl> +</li> +</ul> +<a name="decodeDouble(byte[], int)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>decodeDouble</h4> +<pre>public static double decodeDouble(byte[] src, + int srcOffset) + throws <a href="../../../../com/amazon/carbonado/CorruptEncodingException.html" title="class in com.amazon.carbonado">CorruptEncodingException</a></pre> +<div class="block">Decodes a double from exactly 8 bytes.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>src</code> - source of encoded bytes</dd><dd><code>srcOffset</code> - offset into source array</dd> +<dt><span class="strong">Returns:</span></dt><dd>double value</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></dd></dl> +</li> +</ul> +<a name="decodeDoubleObj(byte[], int)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>decodeDoubleObj</h4> +<pre>public static java.lang.Double decodeDoubleObj(byte[] src, + int srcOffset) + throws <a href="../../../../com/amazon/carbonado/CorruptEncodingException.html" title="class in com.amazon.carbonado">CorruptEncodingException</a></pre> +<div class="block">Decodes a Double object from exactly 8 bytes.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>src</code> - source of encoded bytes</dd><dd><code>srcOffset</code> - offset into source array</dd> +<dt><span class="strong">Returns:</span></dt><dd>Double object or null</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></dd></dl> +</li> +</ul> +<a name="decodeDoubleBits(byte[], int)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>decodeDoubleBits</h4> +<pre>protected static long decodeDoubleBits(byte[] src, + int srcOffset) + throws <a href="../../../../com/amazon/carbonado/CorruptEncodingException.html" title="class in com.amazon.carbonado">CorruptEncodingException</a></pre> +<dl><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></dd></dl> +</li> +</ul> +<a name="decode(byte[], int, java.math.BigInteger[])"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>decode</h4> +<pre>public static int decode(byte[] src, + int srcOffset, + java.math.BigInteger[] valueRef) + throws <a href="../../../../com/amazon/carbonado/CorruptEncodingException.html" title="class in com.amazon.carbonado">CorruptEncodingException</a></pre> +<div class="block">Decodes a BigInteger.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>src</code> - source of encoded data</dd><dd><code>srcOffset</code> - offset into encoded data</dd><dd><code>valueRef</code> - decoded BigInteger is stored in element 0, which may be null</dd> +<dt><span class="strong">Returns:</span></dt><dd>amount of bytes read from source</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 source data is corrupt</dd><dt><span class="strong">Since:</span></dt> + <dd>1.2</dd></dl> +</li> +</ul> +<a name="decode(byte[], int, java.math.BigDecimal[])"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>decode</h4> +<pre>public static int decode(byte[] src, + int srcOffset, + java.math.BigDecimal[] valueRef) + throws <a href="../../../../com/amazon/carbonado/CorruptEncodingException.html" title="class in com.amazon.carbonado">CorruptEncodingException</a></pre> +<div class="block">Decodes a BigDecimal.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>src</code> - source of encoded data</dd><dd><code>srcOffset</code> - offset into encoded data</dd><dd><code>valueRef</code> - decoded BigDecimal is stored in element 0, which may be null</dd> +<dt><span class="strong">Returns:</span></dt><dd>amount of bytes read from source</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 source data is corrupt</dd><dt><span class="strong">Since:</span></dt> + <dd>1.2</dd></dl> +</li> +</ul> +<a name="decode(byte[], int, byte[][])"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>decode</h4> +<pre>public static int decode(byte[] src, + int srcOffset, + byte[][] valueRef) + throws <a href="../../../../com/amazon/carbonado/CorruptEncodingException.html" title="class in com.amazon.carbonado">CorruptEncodingException</a></pre> +<div class="block">Decodes the given byte array.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>src</code> - source of encoded data</dd><dd><code>srcOffset</code> - offset into encoded data</dd><dd><code>valueRef</code> - decoded byte array is stored in element 0, which may be null</dd> +<dt><span class="strong">Returns:</span></dt><dd>amount of bytes read from source</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 source data is corrupt</dd></dl> +</li> +</ul> +<a name="decodeString(byte[], int, java.lang.String[])"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>decodeString</h4> +<pre>public static int decodeString(byte[] src, + int srcOffset, + java.lang.String[] valueRef) + throws <a href="../../../../com/amazon/carbonado/CorruptEncodingException.html" title="class in com.amazon.carbonado">CorruptEncodingException</a></pre> +<div class="block">Decodes an encoded string from the given byte array.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>src</code> - source of encoded data</dd><dd><code>srcOffset</code> - offset into encoded data</dd><dd><code>valueRef</code> - decoded string is stored in element 0, which may be null</dd> +<dt><span class="strong">Returns:</span></dt><dd>amount of bytes read from source</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 source data is corrupt</dd></dl> +</li> +</ul> +<a name="readLength(java.io.InputStream)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>readLength</h4> +<pre>public static int readLength(java.io.InputStream in) + throws java.io.IOException, + java.io.EOFException</pre> +<div class="block">Decodes a length value which was encoded by <a href="../../../../com/amazon/carbonado/raw/DataEncoder.html#writeLength(int, java.io.OutputStream)"><code>DataEncoder.writeLength(int, java.io.OutputStream)</code></a>.</div> +<dl><dt><span class="strong">Returns:</span></dt><dd>length value</dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code>java.io.IOException</code></dd> +<dd><code>java.io.EOFException</code></dd><dt><span class="strong">Since:</span></dt> + <dd>1.2</dd></dl> +</li> +</ul> +<a name="readFully(java.io.InputStream, byte[])"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>readFully</h4> +<pre>public static void readFully(java.io.InputStream in, + byte[] b) + throws java.io.IOException, + java.io.EOFException</pre> +<div class="block">Reads as many bytes from the stream as is necessary to fill the given + byte array. An EOFException is thrown if the stream end is encountered.</div> +<dl><dt><span class="strong">Throws:</span></dt> +<dd><code>java.io.IOException</code></dd> +<dd><code>java.io.EOFException</code></dd><dt><span class="strong">Since:</span></dt> + <dd>1.2</dd></dl> +</li> +</ul> +<a name="decodeSingle(byte[], int, int)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>decodeSingle</h4> +<pre>public static byte[] decodeSingle(byte[] src, + int prefixPadding, + int suffixPadding) + throws <a href="../../../../com/amazon/carbonado/CorruptEncodingException.html" title="class in com.amazon.carbonado">CorruptEncodingException</a></pre> +<div class="block">Decodes the given byte array which was encoded by <a href="../../../../com/amazon/carbonado/raw/DataEncoder.html#encodeSingle(byte[], int, int)"><code>DataEncoder.encodeSingle(byte[], int, int)</code></a>. Always returns a new byte array instance.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>prefixPadding</code> - amount of extra bytes to skip from start of encoded byte array</dd><dd><code>suffixPadding</code> - amount of extra bytes to skip at end of encoded byte array</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></dd></dl> +</li> +</ul> +<a name="decodeSingleNullable(byte[])"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>decodeSingleNullable</h4> +<pre>public static byte[] decodeSingleNullable(byte[] src) + throws <a href="../../../../com/amazon/carbonado/CorruptEncodingException.html" title="class in com.amazon.carbonado">CorruptEncodingException</a></pre> +<div class="block">Decodes the given byte array which was encoded by <a href="../../../../com/amazon/carbonado/raw/DataEncoder.html#encodeSingleNullable(byte[])"><code>DataEncoder.encodeSingleNullable(byte[])</code></a>. Always returns a new byte array + instance.</div> +<dl><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></dd></dl> +</li> +</ul> +<a name="decodeSingleNullable(byte[], int, int)"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>decodeSingleNullable</h4> +<pre>public static byte[] decodeSingleNullable(byte[] src, + int prefixPadding, + int suffixPadding) + throws <a href="../../../../com/amazon/carbonado/CorruptEncodingException.html" title="class in com.amazon.carbonado">CorruptEncodingException</a></pre> +<div class="block">Decodes the given byte array which was encoded by <a href="../../../../com/amazon/carbonado/raw/DataEncoder.html#encodeSingleNullable(byte[])"><code>DataEncoder.encodeSingleNullable(byte[])</code></a>. Always returns a new byte array + instance.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>prefixPadding</code> - amount of extra bytes to skip from start of encoded byte array</dd><dd><code>suffixPadding</code> - amount of extra bytes to skip at end of encoded byte array</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></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/DataDecoder.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/CustomStorableCodecFactory.html" title="class in com.amazon.carbonado.raw"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../com/amazon/carbonado/raw/DataEncoder.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/DataDecoder.html" target="_top">Frames</a></li> +<li><a href="DataDecoder.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> |