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/DataEncoder.html | |
Adding javadocs and Carbonado User Guidegh-pages
Diffstat (limited to 'apidocs/com/amazon/carbonado/raw/DataEncoder.html')
| -rw-r--r-- | apidocs/com/amazon/carbonado/raw/DataEncoder.html | 920 |
1 files changed, 920 insertions, 0 deletions
diff --git a/apidocs/com/amazon/carbonado/raw/DataEncoder.html b/apidocs/com/amazon/carbonado/raw/DataEncoder.html new file mode 100644 index 0000000..553433e --- /dev/null +++ b/apidocs/com/amazon/carbonado/raw/DataEncoder.html @@ -0,0 +1,920 @@ +<!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>DataEncoder (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="DataEncoder (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/DataEncoder.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/DataDecoder.html" title="class in com.amazon.carbonado.raw"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../com/amazon/carbonado/raw/GenericEncodingStrategy.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/DataEncoder.html" target="_top">Frames</a></li> +<li><a href="DataEncoder.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 DataEncoder" class="title">Class DataEncoder</h2> +</div> +<div class="contentContainer"> +<ul class="inheritance"> +<li>java.lang.Object</li> +<li> +<ul class="inheritance"> +<li>com.amazon.carbonado.raw.DataEncoder</li> +</ul> +</li> +</ul> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<hr> +<br> +<pre>public class <span class="strong">DataEncoder</span> +extends java.lang.Object</pre> +<div class="block">A very low-level class that supports encoding of primitive data. For + encoding data into keys, see <a href="../../../../com/amazon/carbonado/raw/KeyEncoder.html" title="class in com.amazon.carbonado.raw"><code>KeyEncoder</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/DataDecoder.html" title="class in com.amazon.carbonado.raw"><code>DataDecoder</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/DataEncoder.html#DataEncoder()">DataEncoder</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/DataEncoder.html#calculateEncodedLength(java.math.BigDecimal)">calculateEncodedLength</a></strong>(java.math.BigDecimal value)</code> +<div class="block">Returns the amount of bytes required to encode the given 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/DataEncoder.html#calculateEncodedLength(java.math.BigInteger)">calculateEncodedLength</a></strong>(java.math.BigInteger value)</code> +<div class="block">Returns the amount of bytes required to encode the given 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/DataEncoder.html#calculateEncodedLength(byte[])">calculateEncodedLength</a></strong>(byte[] value)</code> +<div class="block">Returns the amount of bytes required to encode the given byte array.</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/DataEncoder.html#calculateEncodedLength(byte[], int, int)">calculateEncodedLength</a></strong>(byte[] value, + int valueOffset, + int valueLength)</code> +<div class="block">Returns the amount of bytes required to encode 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/DataEncoder.html#calculateEncodedStringLength(java.lang.String)">calculateEncodedStringLength</a></strong>(java.lang.String value)</code> +<div class="block">Returns the amount of bytes required to encode the given String.</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/DataEncoder.html#encode(java.math.BigDecimal, byte[], int)">encode</a></strong>(java.math.BigDecimal value, + byte[] dst, + int dstOffset)</code> +<div class="block">Encodes the given optional BigDecimal into a variable amount of + bytes.</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/DataEncoder.html#encode(java.math.BigInteger, byte[], int)">encode</a></strong>(java.math.BigInteger value, + byte[] dst, + int dstOffset)</code> +<div class="block">Encodes the given optional BigInteger into a variable amount of + bytes.</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/DataEncoder.html#encode(boolean, byte[], int)">encode</a></strong>(boolean value, + byte[] dst, + int dstOffset)</code> +<div class="block">Encodes the given boolean into exactly 1 byte.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>static void</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/raw/DataEncoder.html#encode(java.lang.Boolean, byte[], int)">encode</a></strong>(java.lang.Boolean value, + byte[] dst, + int dstOffset)</code> +<div class="block">Encodes the given Boolean object into exactly 1 byte.</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/DataEncoder.html#encode(byte[], byte[], int)">encode</a></strong>(byte[] value, + byte[] dst, + int dstOffset)</code> +<div class="block">Encodes the given optional byte array into a variable amount of + bytes.</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/DataEncoder.html#encode(byte[], int, int, byte[], int)">encode</a></strong>(byte[] value, + int valueOffset, + int valueLength, + byte[] dst, + int dstOffset)</code> +<div class="block">Encodes the given optional byte array into a variable amount of + bytes.</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/DataEncoder.html#encode(byte, byte[], int)">encode</a></strong>(byte value, + byte[] dst, + int dstOffset)</code> +<div class="block">Encodes the given signed byte into exactly 1 byte.</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/DataEncoder.html#encode(java.lang.Byte, byte[], int)">encode</a></strong>(java.lang.Byte value, + byte[] dst, + int dstOffset)</code> +<div class="block">Encodes the given signed Byte object into exactly 1 or 2 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/DataEncoder.html#encode(java.lang.Character, byte[], int)">encode</a></strong>(java.lang.Character value, + byte[] dst, + int dstOffset)</code> +<div class="block">Encodes the given Character object into exactly 1 or 3 bytes.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>static void</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/raw/DataEncoder.html#encode(char, byte[], int)">encode</a></strong>(char value, + byte[] dst, + int dstOffset)</code> +<div class="block">Encodes the given character into exactly 2 bytes.</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/DataEncoder.html#encode(double, byte[], int)">encode</a></strong>(double value, + byte[] dst, + int dstOffset)</code> +<div class="block">Encodes the given double into exactly 8 bytes.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>static void</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/raw/DataEncoder.html#encode(java.lang.Double, byte[], int)">encode</a></strong>(java.lang.Double value, + byte[] dst, + int dstOffset)</code> +<div class="block">Encodes the given Double object into exactly 8 bytes.</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/DataEncoder.html#encode(float, byte[], int)">encode</a></strong>(float value, + byte[] dst, + int dstOffset)</code> +<div class="block">Encodes the given float into exactly 4 bytes.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>static void</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/raw/DataEncoder.html#encode(java.lang.Float, byte[], int)">encode</a></strong>(java.lang.Float value, + byte[] dst, + int dstOffset)</code> +<div class="block">Encodes the given Float object into exactly 4 bytes.</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/DataEncoder.html#encode(int, byte[], int)">encode</a></strong>(int value, + byte[] dst, + int dstOffset)</code> +<div class="block">Encodes the given signed integer into exactly 4 bytes.</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/DataEncoder.html#encode(java.lang.Integer, byte[], int)">encode</a></strong>(java.lang.Integer value, + byte[] dst, + int dstOffset)</code> +<div class="block">Encodes the given signed Integer object into exactly 1 or 5 bytes.</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/DataEncoder.html#encode(long, byte[], int)">encode</a></strong>(long value, + byte[] dst, + int dstOffset)</code> +<div class="block">Encodes the given signed long into exactly 8 bytes.</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/DataEncoder.html#encode(java.lang.Long, byte[], int)">encode</a></strong>(java.lang.Long value, + byte[] dst, + int dstOffset)</code> +<div class="block">Encodes the given signed Long object into exactly 1 or 9 bytes.</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/DataEncoder.html#encode(short, byte[], int)">encode</a></strong>(short value, + byte[] dst, + int dstOffset)</code> +<div class="block">Encodes the given signed short into exactly 2 bytes.</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/DataEncoder.html#encode(java.lang.Short, byte[], int)">encode</a></strong>(java.lang.Short value, + byte[] dst, + int dstOffset)</code> +<div class="block">Encodes the given signed Short object into exactly 1 or 3 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/DataEncoder.html#encode(java.lang.String, byte[], int)">encode</a></strong>(java.lang.String value, + byte[] dst, + int dstOffset)</code> +<div class="block">Encodes the given optional String into a variable amount of bytes.</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/DataEncoder.html#encodeSingle(byte[], int, int)">encodeSingle</a></strong>(byte[] value, + int prefixPadding, + int suffixPadding)</code> +<div class="block">Encodes the given byte array for use when there is only a single + property, whose type is a byte array.</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/DataEncoder.html#encodeSingleNullable(byte[])">encodeSingleNullable</a></strong>(byte[] value)</code> +<div class="block">Encodes the given byte array for use when there is only a single + nullable property, whose type is a byte array.</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/DataEncoder.html#encodeSingleNullable(byte[], int, int)">encodeSingleNullable</a></strong>(byte[] value, + int prefixPadding, + int suffixPadding)</code> +<div class="block">Encodes the given byte array for use when there is only a single + nullable property, whose type is a byte array.</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/DataEncoder.html#writeLength(int, java.io.OutputStream)">writeLength</a></strong>(int valueLength, + java.io.OutputStream out)</code> +<div class="block">Writes a positive length value in up to five bytes.</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="DataEncoder()"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>DataEncoder</h4> +<pre>public DataEncoder()</pre> +</li> +</ul> +</li> +</ul> +<!-- ============ METHOD DETAIL ========== --> +<ul class="blockList"> +<li class="blockList"><a name="method_detail"> +<!-- --> +</a> +<h3>Method Detail</h3> +<a name="encode(int, byte[], int)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>encode</h4> +<pre>public static void encode(int value, + byte[] dst, + int dstOffset)</pre> +<div class="block">Encodes the given signed integer into exactly 4 bytes.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>value</code> - signed integer value to encode</dd><dd><code>dst</code> - destination for encoded bytes</dd><dd><code>dstOffset</code> - offset into destination array</dd></dl> +</li> +</ul> +<a name="encode(java.lang.Integer, byte[], int)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>encode</h4> +<pre>public static int encode(java.lang.Integer value, + byte[] dst, + int dstOffset)</pre> +<div class="block">Encodes the given signed Integer object into exactly 1 or 5 bytes. If + the Integer object is never expected to be null, consider encoding as an + int primitive.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>value</code> - optional signed Integer value to encode</dd><dd><code>dst</code> - destination for encoded bytes</dd><dd><code>dstOffset</code> - offset into destination array</dd> +<dt><span class="strong">Returns:</span></dt><dd>amount of bytes written</dd></dl> +</li> +</ul> +<a name="encode(long, byte[], int)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>encode</h4> +<pre>public static void encode(long value, + byte[] dst, + int dstOffset)</pre> +<div class="block">Encodes the given signed long into exactly 8 bytes.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>value</code> - signed long value to encode</dd><dd><code>dst</code> - destination for encoded bytes</dd><dd><code>dstOffset</code> - offset into destination array</dd></dl> +</li> +</ul> +<a name="encode(java.lang.Long, byte[], int)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>encode</h4> +<pre>public static int encode(java.lang.Long value, + byte[] dst, + int dstOffset)</pre> +<div class="block">Encodes the given signed Long object into exactly 1 or 9 bytes. If the + Long object is never expected to be null, consider encoding as a long + primitive.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>value</code> - optional signed Long value to encode</dd><dd><code>dst</code> - destination for encoded bytes</dd><dd><code>dstOffset</code> - offset into destination array</dd> +<dt><span class="strong">Returns:</span></dt><dd>amount of bytes written</dd></dl> +</li> +</ul> +<a name="encode(byte, byte[], int)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>encode</h4> +<pre>public static void encode(byte value, + byte[] dst, + int dstOffset)</pre> +<div class="block">Encodes the given signed byte into exactly 1 byte.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>value</code> - signed byte value to encode</dd><dd><code>dst</code> - destination for encoded bytes</dd><dd><code>dstOffset</code> - offset into destination array</dd></dl> +</li> +</ul> +<a name="encode(java.lang.Byte, byte[], int)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>encode</h4> +<pre>public static int encode(java.lang.Byte value, + byte[] dst, + int dstOffset)</pre> +<div class="block">Encodes the given signed Byte object into exactly 1 or 2 bytes. If the + Byte object is never expected to be null, consider encoding as a byte + primitive.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>value</code> - optional signed Byte value to encode</dd><dd><code>dst</code> - destination for encoded bytes</dd><dd><code>dstOffset</code> - offset into destination array</dd> +<dt><span class="strong">Returns:</span></dt><dd>amount of bytes written</dd></dl> +</li> +</ul> +<a name="encode(short, byte[], int)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>encode</h4> +<pre>public static void encode(short value, + byte[] dst, + int dstOffset)</pre> +<div class="block">Encodes the given signed short into exactly 2 bytes.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>value</code> - signed short value to encode</dd><dd><code>dst</code> - destination for encoded bytes</dd><dd><code>dstOffset</code> - offset into destination array</dd></dl> +</li> +</ul> +<a name="encode(java.lang.Short, byte[], int)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>encode</h4> +<pre>public static int encode(java.lang.Short value, + byte[] dst, + int dstOffset)</pre> +<div class="block">Encodes the given signed Short object into exactly 1 or 3 bytes. If the + Short object is never expected to be null, consider encoding as a short + primitive.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>value</code> - optional signed Short value to encode</dd><dd><code>dst</code> - destination for encoded bytes</dd><dd><code>dstOffset</code> - offset into destination array</dd> +<dt><span class="strong">Returns:</span></dt><dd>amount of bytes written</dd></dl> +</li> +</ul> +<a name="encode(char, byte[], int)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>encode</h4> +<pre>public static void encode(char value, + byte[] dst, + int dstOffset)</pre> +<div class="block">Encodes the given character into exactly 2 bytes.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>value</code> - character value to encode</dd><dd><code>dst</code> - destination for encoded bytes</dd><dd><code>dstOffset</code> - offset into destination array</dd></dl> +</li> +</ul> +<a name="encode(java.lang.Character, byte[], int)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>encode</h4> +<pre>public static int encode(java.lang.Character value, + byte[] dst, + int dstOffset)</pre> +<div class="block">Encodes the given Character object into exactly 1 or 3 bytes. If the + Character object is never expected to be null, consider encoding as a + char primitive.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>value</code> - optional Character value to encode</dd><dd><code>dst</code> - destination for encoded bytes</dd><dd><code>dstOffset</code> - offset into destination array</dd> +<dt><span class="strong">Returns:</span></dt><dd>amount of bytes written</dd></dl> +</li> +</ul> +<a name="encode(boolean, byte[], int)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>encode</h4> +<pre>public static void encode(boolean value, + byte[] dst, + int dstOffset)</pre> +<div class="block">Encodes the given boolean into exactly 1 byte.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>value</code> - boolean value to encode</dd><dd><code>dst</code> - destination for encoded bytes</dd><dd><code>dstOffset</code> - offset into destination array</dd></dl> +</li> +</ul> +<a name="encode(java.lang.Boolean, byte[], int)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>encode</h4> +<pre>public static void encode(java.lang.Boolean value, + byte[] dst, + int dstOffset)</pre> +<div class="block">Encodes the given Boolean object into exactly 1 byte.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>value</code> - optional Boolean value to encode</dd><dd><code>dst</code> - destination for encoded bytes</dd><dd><code>dstOffset</code> - offset into destination array</dd></dl> +</li> +</ul> +<a name="encode(float, byte[], int)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>encode</h4> +<pre>public static void encode(float value, + byte[] dst, + int dstOffset)</pre> +<div class="block">Encodes the given float into exactly 4 bytes.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>value</code> - float value to encode</dd><dd><code>dst</code> - destination for encoded bytes</dd><dd><code>dstOffset</code> - offset into destination array</dd></dl> +</li> +</ul> +<a name="encode(java.lang.Float, byte[], int)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>encode</h4> +<pre>public static void encode(java.lang.Float value, + byte[] dst, + int dstOffset)</pre> +<div class="block">Encodes the given Float object into exactly 4 bytes. A non-canonical NaN + value is used to represent null.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>value</code> - optional Float value to encode</dd><dd><code>dst</code> - destination for encoded bytes</dd><dd><code>dstOffset</code> - offset into destination array</dd></dl> +</li> +</ul> +<a name="encode(double, byte[], int)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>encode</h4> +<pre>public static void encode(double value, + byte[] dst, + int dstOffset)</pre> +<div class="block">Encodes the given double into exactly 8 bytes.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>value</code> - double value to encode</dd><dd><code>dst</code> - destination for encoded bytes</dd><dd><code>dstOffset</code> - offset into destination array</dd></dl> +</li> +</ul> +<a name="encode(java.lang.Double, byte[], int)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>encode</h4> +<pre>public static void encode(java.lang.Double value, + byte[] dst, + int dstOffset)</pre> +<div class="block">Encodes the given Double object into exactly 8 bytes. A non-canonical + NaN value is used to represent null.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>value</code> - optional Double value to encode</dd><dd><code>dst</code> - destination for encoded bytes</dd><dd><code>dstOffset</code> - offset into destination array</dd></dl> +</li> +</ul> +<a name="encode(java.math.BigInteger, byte[], int)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>encode</h4> +<pre>public static int encode(java.math.BigInteger value, + byte[] dst, + int dstOffset)</pre> +<div class="block">Encodes the given optional BigInteger into a variable amount of + bytes. If the BigInteger is null, exactly 1 byte is written. Otherwise, + the amount written can be determined by calling calculateEncodedLength.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>value</code> - BigInteger value to encode, may be null</dd><dd><code>dst</code> - destination for encoded bytes</dd><dd><code>dstOffset</code> - offset into destination array</dd> +<dt><span class="strong">Returns:</span></dt><dd>amount of bytes written</dd><dt><span class="strong">Since:</span></dt> + <dd>1.2</dd></dl> +</li> +</ul> +<a name="calculateEncodedLength(java.math.BigInteger)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>calculateEncodedLength</h4> +<pre>public static int calculateEncodedLength(java.math.BigInteger value)</pre> +<div class="block">Returns the amount of bytes required to encode the given BigInteger.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>value</code> - BigInteger value to encode, may be null</dd> +<dt><span class="strong">Returns:</span></dt><dd>amount of bytes needed to encode</dd><dt><span class="strong">Since:</span></dt> + <dd>1.2</dd></dl> +</li> +</ul> +<a name="encode(java.math.BigDecimal, byte[], int)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>encode</h4> +<pre>public static int encode(java.math.BigDecimal value, + byte[] dst, + int dstOffset)</pre> +<div class="block">Encodes the given optional BigDecimal into a variable amount of + bytes. If the BigDecimal is null, exactly 1 byte is written. Otherwise, + the amount written can be determined by calling calculateEncodedLength.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>value</code> - BigDecimal value to encode, may be null</dd><dd><code>dst</code> - destination for encoded bytes</dd><dd><code>dstOffset</code> - offset into destination array</dd> +<dt><span class="strong">Returns:</span></dt><dd>amount of bytes written</dd><dt><span class="strong">Since:</span></dt> + <dd>1.2</dd></dl> +</li> +</ul> +<a name="calculateEncodedLength(java.math.BigDecimal)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>calculateEncodedLength</h4> +<pre>public static int calculateEncodedLength(java.math.BigDecimal value)</pre> +<div class="block">Returns the amount of bytes required to encode the given BigDecimal.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>value</code> - BigDecimal value to encode, may be null</dd> +<dt><span class="strong">Returns:</span></dt><dd>amount of bytes needed to encode</dd><dt><span class="strong">Since:</span></dt> + <dd>1.2</dd></dl> +</li> +</ul> +<a name="encode(byte[], byte[], int)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>encode</h4> +<pre>public static int encode(byte[] value, + byte[] dst, + int dstOffset)</pre> +<div class="block">Encodes the given optional byte array into a variable amount of + bytes. If the byte array is null, exactly 1 byte is written. Otherwise, + the amount written can be determined by calling calculateEncodedLength.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>value</code> - byte array value to encode, may be null</dd><dd><code>dst</code> - destination for encoded bytes</dd><dd><code>dstOffset</code> - offset into destination array</dd> +<dt><span class="strong">Returns:</span></dt><dd>amount of bytes written</dd></dl> +</li> +</ul> +<a name="encode(byte[], int, int, byte[], int)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>encode</h4> +<pre>public static int encode(byte[] value, + int valueOffset, + int valueLength, + byte[] dst, + int dstOffset)</pre> +<div class="block">Encodes the given optional byte array into a variable amount of + bytes. If the byte array is null, exactly 1 byte is written. Otherwise, + the amount written can be determined by calling calculateEncodedLength.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>value</code> - byte array value to encode, may be null</dd><dd><code>valueOffset</code> - offset into byte array</dd><dd><code>valueLength</code> - length of data in byte array</dd><dd><code>dst</code> - destination for encoded bytes</dd><dd><code>dstOffset</code> - offset into destination array</dd> +<dt><span class="strong">Returns:</span></dt><dd>amount of bytes written</dd></dl> +</li> +</ul> +<a name="calculateEncodedLength(byte[])"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>calculateEncodedLength</h4> +<pre>public static int calculateEncodedLength(byte[] value)</pre> +<div class="block">Returns the amount of bytes required to encode the given byte array.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>value</code> - byte array value to encode, may be null</dd> +<dt><span class="strong">Returns:</span></dt><dd>amount of bytes needed to encode</dd></dl> +</li> +</ul> +<a name="calculateEncodedLength(byte[], int, int)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>calculateEncodedLength</h4> +<pre>public static int calculateEncodedLength(byte[] value, + int valueOffset, + int valueLength)</pre> +<div class="block">Returns the amount of bytes required to encode the given byte array.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>value</code> - byte array value to encode, may be null</dd><dd><code>valueOffset</code> - offset into byte array</dd><dd><code>valueLength</code> - length of data in byte array</dd> +<dt><span class="strong">Returns:</span></dt><dd>amount of bytes needed to encode</dd></dl> +</li> +</ul> +<a name="encode(java.lang.String, byte[], int)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>encode</h4> +<pre>public static int encode(java.lang.String value, + byte[] dst, + int dstOffset)</pre> +<div class="block">Encodes the given optional String into a variable amount of bytes. The + amount written can be determined by calling + calculateEncodedStringLength. + <p> + Strings are encoded in a fashion similar to UTF-8, in that ASCII + characters are written in one byte. This encoding is more efficient than + UTF-8, but it isn't compatible with UTF-8.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>value</code> - String value to encode, may be null</dd><dd><code>dst</code> - destination for encoded bytes</dd><dd><code>dstOffset</code> - offset into destination array</dd> +<dt><span class="strong">Returns:</span></dt><dd>amount of bytes written</dd></dl> +</li> +</ul> +<a name="calculateEncodedStringLength(java.lang.String)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>calculateEncodedStringLength</h4> +<pre>public static int calculateEncodedStringLength(java.lang.String value)</pre> +<div class="block">Returns the amount of bytes required to encode the given String.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>value</code> - String to encode, may be null</dd></dl> +</li> +</ul> +<a name="writeLength(int, java.io.OutputStream)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>writeLength</h4> +<pre>public static int writeLength(int valueLength, + java.io.OutputStream out) + throws java.io.IOException</pre> +<div class="block">Writes a positive length value in up to five bytes.</div> +<dl><dt><span class="strong">Returns:</span></dt><dd>number of bytes written</dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code>java.io.IOException</code></dd><dt><span class="strong">Since:</span></dt> + <dd>1.2</dd></dl> +</li> +</ul> +<a name="encodeSingle(byte[], int, int)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>encodeSingle</h4> +<pre>public static byte[] encodeSingle(byte[] value, + int prefixPadding, + int suffixPadding)</pre> +<div class="block">Encodes the given byte array for use when there is only a single + property, whose type is a byte array. The original byte array is + returned if the padding lengths are zero.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>prefixPadding</code> - amount of extra bytes to allocate at start of encoded byte array</dd><dd><code>suffixPadding</code> - amount of extra bytes to allocate at end of encoded byte array</dd></dl> +</li> +</ul> +<a name="encodeSingleNullable(byte[])"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>encodeSingleNullable</h4> +<pre>public static byte[] encodeSingleNullable(byte[] value)</pre> +<div class="block">Encodes the given byte array for use when there is only a single + nullable property, whose type is a byte array.</div> +</li> +</ul> +<a name="encodeSingleNullable(byte[], int, int)"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>encodeSingleNullable</h4> +<pre>public static byte[] encodeSingleNullable(byte[] value, + int prefixPadding, + int suffixPadding)</pre> +<div class="block">Encodes the given byte array for use when there is only a single + nullable property, whose type is a byte array.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>prefixPadding</code> - amount of extra bytes to allocate at start of encoded byte array</dd><dd><code>suffixPadding</code> - amount of extra bytes to allocate at end of encoded byte array</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/DataEncoder.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/DataDecoder.html" title="class in com.amazon.carbonado.raw"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../com/amazon/carbonado/raw/GenericEncodingStrategy.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/DataEncoder.html" target="_top">Frames</a></li> +<li><a href="DataEncoder.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> |