<!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_45) on Thu Jan 09 22:45:26 GMT 2014 --> <title>TupleOutput</title> <meta name="date" content="2014-01-09"> <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="TupleOutput"; } //--> </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="package-tree.html">Tree</a></li> <li><a href="../../../../deprecated-list.html">Deprecated</a></li> <li><a href="../../../../index-all.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/sleepycat/bind/tuple/TupleMarshalledBinding.html" title="class in com.sleepycat.bind.tuple"><span class="strong">Prev Class</span></a></li> <li><a href="../../../../com/sleepycat/bind/tuple/TupleTupleBinding.html" title="class in com.sleepycat.bind.tuple"><span class="strong">Next Class</span></a></li> </ul> <ul class="navList"> <li><a href="../../../../index.html?com/sleepycat/bind/tuple/TupleOutput.html" target="_top">Frames</a></li> <li><a href="TupleOutput.html" target="_top">No Frames</a></li> </ul> <ul class="navList" id="allclasses_navbar_top"> <li><a href="../../../../allclasses-noframe.html">All Classes</a></li> </ul> <div> <script type="text/javascript"><!-- allClassesLink = document.getElementById("allclasses_navbar_top"); if(window==top) { allClassesLink.style.display = "block"; } else { allClassesLink.style.display = "none"; } //--> </script> </div> <div> <ul class="subNavList"> <li>Summary: </li> <li>Nested | </li> <li><a href="#fields_inherited_from_class_com.sleepycat.util.FastOutputStream">Field</a> | </li> <li><a href="#constructor_summary">Constr</a> | </li> <li><a href="#method_summary">Method</a></li> </ul> <ul class="subNavList"> <li>Detail: </li> <li>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.sleepycat.bind.tuple</div> <h2 title="Class TupleOutput" class="title">Class TupleOutput</h2> </div> <div class="contentContainer"> <ul class="inheritance"> <li>java.lang.Object</li> <li> <ul class="inheritance"> <li>java.io.OutputStream</li> <li> <ul class="inheritance"> <li><a href="../../../../com/sleepycat/util/FastOutputStream.html" title="class in com.sleepycat.util">com.sleepycat.util.FastOutputStream</a></li> <li> <ul class="inheritance"> <li>com.sleepycat.bind.tuple.TupleOutput</li> </ul> </li> </ul> </li> </ul> </li> </ul> <div class="description"> <ul class="blockList"> <li class="blockList"> <dl> <dt>All Implemented Interfaces:</dt> <dd>java.io.Closeable, java.io.Flushable, java.lang.AutoCloseable</dd> </dl> <hr> <br> <pre>public class <span class="strong">TupleOutput</span> extends <a href="../../../../com/sleepycat/util/FastOutputStream.html" title="class in com.sleepycat.util">FastOutputStream</a></pre> <div class="block">An <code>OutputStream</code> with <code>DataOutput</code>-like methods for writing tuple fields. It is used by <code>TupleBinding</code>. <p>This class has many methods that have the same signatures as methods in the <code>DataOutput</code> interface. The reason this class does not implement <code>DataOutput</code> is because it would break the interface contract for those methods because of data format differences.</p> <p>Signed numbers are stored in the buffer in MSB (most significant byte first) order with their sign bit (high-order bit) inverted to cause negative numbers to be sorted first when comparing values as unsigned byte arrays, as done in a database. Unsigned numbers, including characters, are stored in MSB order with no change to their sign bit. BigInteger values are stored with a preceding length having the same sign as the value.</p> <p>Strings and character arrays are stored either as a fixed length array of unicode characters, where the length must be known by the application, or as a null-terminated UTF byte array.</p> <ul> <li>Null strings are UTF encoded as { 0xFF }, which is not allowed in a standard UTF encoding. This allows null strings, as distinct from empty or zero length strings, to be represented in a tuple. Using the default comparator, null strings will be ordered last.</li> <li>Zero (0x0000) character values are UTF encoded as non-zero values, and therefore embedded zeros in the string are supported. The sequence { 0xC0, 0x80 } is used to encode a zero character. This UTF encoding is the same one used by native Java UTF libraries. However, this encoding of zero does impact the lexicographical ordering, and zeros will not be sorted first (the natural order) or last. For all character values other than zero, the default UTF byte ordering is the same as the Unicode lexicographical character ordering.</li> </ul> <p>Floats and doubles are stored using two different representations: sorted representation and integer-bit (IEEE 754) representation. If you use negative floating point numbers in a key, you should use sorted representation; alternatively you may use integer-bit representation but you will need to implement and configure a custom comparator to get correct numeric ordering for negative numbers.</p> <p>To use sorted representation use this set of methods:</p> <ul> <li><a href="../../../../com/sleepycat/bind/tuple/TupleOutput.html#writeSortedFloat(float)"><code>writeSortedFloat(float)</code></a></li> <li><a href="../../../../com/sleepycat/bind/tuple/TupleInput.html#readSortedFloat()"><code>TupleInput.readSortedFloat()</code></a></li> <li><a href="../../../../com/sleepycat/bind/tuple/TupleOutput.html#writeSortedDouble(double)"><code>writeSortedDouble(double)</code></a></li> <li><a href="../../../../com/sleepycat/bind/tuple/TupleInput.html#readSortedDouble()"><code>TupleInput.readSortedDouble()</code></a></li> </ul> <p>To use integer-bit representation use this set of methods:</p> <ul> <li><a href="../../../../com/sleepycat/bind/tuple/TupleOutput.html#writeFloat(float)"><code>writeFloat(float)</code></a></li> <li><a href="../../../../com/sleepycat/bind/tuple/TupleInput.html#readFloat()"><code>TupleInput.readFloat()</code></a></li> <li><a href="../../../../com/sleepycat/bind/tuple/TupleOutput.html#writeDouble(double)"><code>writeDouble(double)</code></a></li> <li><a href="../../../../com/sleepycat/bind/tuple/TupleInput.html#readDouble()"><code>TupleInput.readDouble()</code></a></li> </ul></div> </li> </ul> </div> <div class="summary"> <ul class="blockList"> <li class="blockList"> <!-- =========== FIELD SUMMARY =========== --> <ul class="blockList"> <li class="blockList"><a name="field_summary"> <!-- --> </a> <h3>Field Summary</h3> <ul class="blockList"> <li class="blockList"><a name="fields_inherited_from_class_com.sleepycat.util.FastOutputStream"> <!-- --> </a> <h3>Fields inherited from class com.sleepycat.util.<a href="../../../../com/sleepycat/util/FastOutputStream.html" title="class in com.sleepycat.util">FastOutputStream</a></h3> <code><a href="../../../../com/sleepycat/util/FastOutputStream.html#DEFAULT_BUMP_SIZE">DEFAULT_BUMP_SIZE</a>, <a href="../../../../com/sleepycat/util/FastOutputStream.html#DEFAULT_INIT_SIZE">DEFAULT_INIT_SIZE</a></code></li> </ul> </li> </ul> <!-- ======== CONSTRUCTOR SUMMARY ======== --> <ul class="blockList"> <li class="blockList"><a name="constructor_summary"> <!-- --> </a> <h3>Constructor Summary</h3> <table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation"> <caption><span>Constructors</span><span class="tabEnd"> </span></caption> <tr> <th class="colOne" scope="col">Constructor and Description</th> </tr> <tr class="altColor"> <td class="colOne"><code><strong><a href="../../../../com/sleepycat/bind/tuple/TupleOutput.html#TupleOutput()">TupleOutput</a></strong>()</code> <div class="block">Creates a tuple output object for writing a byte array of tuple data.</div> </td> </tr> <tr class="rowColor"> <td class="colOne"><code><strong><a href="../../../../com/sleepycat/bind/tuple/TupleOutput.html#TupleOutput(byte[])">TupleOutput</a></strong>(byte[] buffer)</code> <div class="block">Creates a tuple output object for writing a byte array of tuple data, using a given buffer.</div> </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/sleepycat/bind/tuple/TupleOutput.html#getBigIntegerByteLength(java.math.BigInteger)">getBigIntegerByteLength</a></strong>(java.math.BigInteger val)</code> <div class="block">Returns the byte length of a given <code>BigInteger</code> value.</div> </td> </tr> <tr class="rowColor"> <td class="colFirst"><code><a href="../../../../com/sleepycat/bind/tuple/TupleOutput.html" title="class in com.sleepycat.bind.tuple">TupleOutput</a></code></td> <td class="colLast"><code><strong><a href="../../../../com/sleepycat/bind/tuple/TupleOutput.html#writeBigInteger(java.math.BigInteger)">writeBigInteger</a></strong>(java.math.BigInteger val)</code> <div class="block">Writes a <code>BigInteger</code>.</div> </td> </tr> <tr class="altColor"> <td class="colFirst"><code><a href="../../../../com/sleepycat/bind/tuple/TupleOutput.html" title="class in com.sleepycat.bind.tuple">TupleOutput</a></code></td> <td class="colLast"><code><strong><a href="../../../../com/sleepycat/bind/tuple/TupleOutput.html#writeBoolean(boolean)">writeBoolean</a></strong>(boolean val)</code> <div class="block">Writes a boolean (one byte) unsigned value to the buffer, writing one if the value is true and zero if it is false.</div> </td> </tr> <tr class="rowColor"> <td class="colFirst"><code><a href="../../../../com/sleepycat/bind/tuple/TupleOutput.html" title="class in com.sleepycat.bind.tuple">TupleOutput</a></code></td> <td class="colLast"><code><strong><a href="../../../../com/sleepycat/bind/tuple/TupleOutput.html#writeByte(int)">writeByte</a></strong>(int val)</code> <div class="block">Writes an signed byte (one byte) value to the buffer.</div> </td> </tr> <tr class="altColor"> <td class="colFirst"><code><a href="../../../../com/sleepycat/bind/tuple/TupleOutput.html" title="class in com.sleepycat.bind.tuple">TupleOutput</a></code></td> <td class="colLast"><code><strong><a href="../../../../com/sleepycat/bind/tuple/TupleOutput.html#writeBytes(char[])">writeBytes</a></strong>(char[] chars)</code> <div class="block">Writes the specified bytes to the buffer, converting each character to an unsigned byte value.</div> </td> </tr> <tr class="rowColor"> <td class="colFirst"><code><a href="../../../../com/sleepycat/bind/tuple/TupleOutput.html" title="class in com.sleepycat.bind.tuple">TupleOutput</a></code></td> <td class="colLast"><code><strong><a href="../../../../com/sleepycat/bind/tuple/TupleOutput.html#writeBytes(java.lang.String)">writeBytes</a></strong>(java.lang.String val)</code> <div class="block">Writes the specified bytes to the buffer, converting each character to an unsigned byte value.</div> </td> </tr> <tr class="altColor"> <td class="colFirst"><code><a href="../../../../com/sleepycat/bind/tuple/TupleOutput.html" title="class in com.sleepycat.bind.tuple">TupleOutput</a></code></td> <td class="colLast"><code><strong><a href="../../../../com/sleepycat/bind/tuple/TupleOutput.html#writeChar(int)">writeChar</a></strong>(int val)</code> <div class="block">Writes a char (two byte) unsigned value to the buffer.</div> </td> </tr> <tr class="rowColor"> <td class="colFirst"><code><a href="../../../../com/sleepycat/bind/tuple/TupleOutput.html" title="class in com.sleepycat.bind.tuple">TupleOutput</a></code></td> <td class="colLast"><code><strong><a href="../../../../com/sleepycat/bind/tuple/TupleOutput.html#writeChars(char[])">writeChars</a></strong>(char[] chars)</code> <div class="block">Writes the specified characters to the buffer, converting each character to a two byte unsigned value.</div> </td> </tr> <tr class="altColor"> <td class="colFirst"><code><a href="../../../../com/sleepycat/bind/tuple/TupleOutput.html" title="class in com.sleepycat.bind.tuple">TupleOutput</a></code></td> <td class="colLast"><code><strong><a href="../../../../com/sleepycat/bind/tuple/TupleOutput.html#writeChars(java.lang.String)">writeChars</a></strong>(java.lang.String val)</code> <div class="block">Writes the specified characters to the buffer, converting each character to a two byte unsigned value.</div> </td> </tr> <tr class="rowColor"> <td class="colFirst"><code><a href="../../../../com/sleepycat/bind/tuple/TupleOutput.html" title="class in com.sleepycat.bind.tuple">TupleOutput</a></code></td> <td class="colLast"><code><strong><a href="../../../../com/sleepycat/bind/tuple/TupleOutput.html#writeDouble(double)">writeDouble</a></strong>(double val)</code> <div class="block">Writes an signed double (eight byte) value to the buffer.</div> </td> </tr> <tr class="altColor"> <td class="colFirst"><code><a href="../../../../com/sleepycat/bind/tuple/TupleOutput.html" title="class in com.sleepycat.bind.tuple">TupleOutput</a></code></td> <td class="colLast"><code><strong><a href="../../../../com/sleepycat/bind/tuple/TupleOutput.html#writeFloat(float)">writeFloat</a></strong>(float val)</code> <div class="block">Writes an signed float (four byte) value to the buffer.</div> </td> </tr> <tr class="rowColor"> <td class="colFirst"><code><a href="../../../../com/sleepycat/bind/tuple/TupleOutput.html" title="class in com.sleepycat.bind.tuple">TupleOutput</a></code></td> <td class="colLast"><code><strong><a href="../../../../com/sleepycat/bind/tuple/TupleOutput.html#writeInt(int)">writeInt</a></strong>(int val)</code> <div class="block">Writes an signed int (four byte) value to the buffer.</div> </td> </tr> <tr class="altColor"> <td class="colFirst"><code><a href="../../../../com/sleepycat/bind/tuple/TupleOutput.html" title="class in com.sleepycat.bind.tuple">TupleOutput</a></code></td> <td class="colLast"><code><strong><a href="../../../../com/sleepycat/bind/tuple/TupleOutput.html#writeLong(long)">writeLong</a></strong>(long val)</code> <div class="block">Writes an signed long (eight byte) value to the buffer.</div> </td> </tr> <tr class="rowColor"> <td class="colFirst"><code>void</code></td> <td class="colLast"><code><strong><a href="../../../../com/sleepycat/bind/tuple/TupleOutput.html#writePackedInt(int)">writePackedInt</a></strong>(int val)</code> <div class="block">Writes a packed integer.</div> </td> </tr> <tr class="altColor"> <td class="colFirst"><code>void</code></td> <td class="colLast"><code><strong><a href="../../../../com/sleepycat/bind/tuple/TupleOutput.html#writePackedLong(long)">writePackedLong</a></strong>(long val)</code> <div class="block">Writes a packed long integer.</div> </td> </tr> <tr class="rowColor"> <td class="colFirst"><code><a href="../../../../com/sleepycat/bind/tuple/TupleOutput.html" title="class in com.sleepycat.bind.tuple">TupleOutput</a></code></td> <td class="colLast"><code><strong><a href="../../../../com/sleepycat/bind/tuple/TupleOutput.html#writeShort(int)">writeShort</a></strong>(int val)</code> <div class="block">Writes an signed short (two byte) value to the buffer.</div> </td> </tr> <tr class="altColor"> <td class="colFirst"><code><a href="../../../../com/sleepycat/bind/tuple/TupleOutput.html" title="class in com.sleepycat.bind.tuple">TupleOutput</a></code></td> <td class="colLast"><code><strong><a href="../../../../com/sleepycat/bind/tuple/TupleOutput.html#writeSortedDouble(double)">writeSortedDouble</a></strong>(double val)</code> <div class="block">Writes a signed double (eight byte) value to the buffer, with support for correct default sorting of all values.</div> </td> </tr> <tr class="rowColor"> <td class="colFirst"><code><a href="../../../../com/sleepycat/bind/tuple/TupleOutput.html" title="class in com.sleepycat.bind.tuple">TupleOutput</a></code></td> <td class="colLast"><code><strong><a href="../../../../com/sleepycat/bind/tuple/TupleOutput.html#writeSortedFloat(float)">writeSortedFloat</a></strong>(float val)</code> <div class="block">Writes a signed float (four byte) value to the buffer, with support for correct default sorting of all values.</div> </td> </tr> <tr class="altColor"> <td class="colFirst"><code><a href="../../../../com/sleepycat/bind/tuple/TupleOutput.html" title="class in com.sleepycat.bind.tuple">TupleOutput</a></code></td> <td class="colLast"><code><strong><a href="../../../../com/sleepycat/bind/tuple/TupleOutput.html#writeString(char[])">writeString</a></strong>(char[] chars)</code> <div class="block">Writes the specified characters to the buffer, converting each character to UTF format.</div> </td> </tr> <tr class="rowColor"> <td class="colFirst"><code><a href="../../../../com/sleepycat/bind/tuple/TupleOutput.html" title="class in com.sleepycat.bind.tuple">TupleOutput</a></code></td> <td class="colLast"><code><strong><a href="../../../../com/sleepycat/bind/tuple/TupleOutput.html#writeString(java.lang.String)">writeString</a></strong>(java.lang.String val)</code> <div class="block">Writes the specified characters to the buffer, converting each character to UTF format, and adding a null terminator byte.</div> </td> </tr> <tr class="altColor"> <td class="colFirst"><code><a href="../../../../com/sleepycat/bind/tuple/TupleOutput.html" title="class in com.sleepycat.bind.tuple">TupleOutput</a></code></td> <td class="colLast"><code><strong><a href="../../../../com/sleepycat/bind/tuple/TupleOutput.html#writeUnsignedByte(int)">writeUnsignedByte</a></strong>(int val)</code> <div class="block">Writes an unsigned byte (one byte) value to the buffer.</div> </td> </tr> <tr class="rowColor"> <td class="colFirst"><code><a href="../../../../com/sleepycat/bind/tuple/TupleOutput.html" title="class in com.sleepycat.bind.tuple">TupleOutput</a></code></td> <td class="colLast"><code><strong><a href="../../../../com/sleepycat/bind/tuple/TupleOutput.html#writeUnsignedInt(long)">writeUnsignedInt</a></strong>(long val)</code> <div class="block">Writes an unsigned int (four byte) value to the buffer.</div> </td> </tr> <tr class="altColor"> <td class="colFirst"><code><a href="../../../../com/sleepycat/bind/tuple/TupleOutput.html" title="class in com.sleepycat.bind.tuple">TupleOutput</a></code></td> <td class="colLast"><code><strong><a href="../../../../com/sleepycat/bind/tuple/TupleOutput.html#writeUnsignedShort(int)">writeUnsignedShort</a></strong>(int val)</code> <div class="block">Writes an unsigned short (two byte) value to the buffer.</div> </td> </tr> </table> <ul class="blockList"> <li class="blockList"><a name="methods_inherited_from_class_com.sleepycat.util.FastOutputStream"> <!-- --> </a> <h3>Methods inherited from class com.sleepycat.util.<a href="../../../../com/sleepycat/util/FastOutputStream.html" title="class in com.sleepycat.util">FastOutputStream</a></h3> <code><a href="../../../../com/sleepycat/util/FastOutputStream.html#addSize(int)">addSize</a>, <a href="../../../../com/sleepycat/util/FastOutputStream.html#getBufferBytes()">getBufferBytes</a>, <a href="../../../../com/sleepycat/util/FastOutputStream.html#getBufferLength()">getBufferLength</a>, <a href="../../../../com/sleepycat/util/FastOutputStream.html#getBufferOffset()">getBufferOffset</a>, <a href="../../../../com/sleepycat/util/FastOutputStream.html#makeSpace(int)">makeSpace</a>, <a href="../../../../com/sleepycat/util/FastOutputStream.html#reset()">reset</a>, <a href="../../../../com/sleepycat/util/FastOutputStream.html#size()">size</a>, <a href="../../../../com/sleepycat/util/FastOutputStream.html#toByteArray()">toByteArray</a>, <a href="../../../../com/sleepycat/util/FastOutputStream.html#toString()">toString</a>, <a href="../../../../com/sleepycat/util/FastOutputStream.html#toString(java.lang.String)">toString</a>, <a href="../../../../com/sleepycat/util/FastOutputStream.html#write(byte[])">write</a>, <a href="../../../../com/sleepycat/util/FastOutputStream.html#write(byte[], int, int)">write</a>, <a href="../../../../com/sleepycat/util/FastOutputStream.html#write(int)">write</a>, <a href="../../../../com/sleepycat/util/FastOutputStream.html#writeFast(byte[])">writeFast</a>, <a href="../../../../com/sleepycat/util/FastOutputStream.html#writeFast(byte[], int, int)">writeFast</a>, <a href="../../../../com/sleepycat/util/FastOutputStream.html#writeFast(int)">writeFast</a>, <a href="../../../../com/sleepycat/util/FastOutputStream.html#writeTo(java.io.OutputStream)">writeTo</a></code></li> </ul> <ul class="blockList"> <li class="blockList"><a name="methods_inherited_from_class_java.io.OutputStream"> <!-- --> </a> <h3>Methods inherited from class java.io.OutputStream</h3> <code>close, flush</code></li> </ul> <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, 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="TupleOutput()"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>TupleOutput</h4> <pre>public TupleOutput()</pre> <div class="block">Creates a tuple output object for writing a byte array of tuple data.</div> </li> </ul> <a name="TupleOutput(byte[])"> <!-- --> </a> <ul class="blockListLast"> <li class="blockList"> <h4>TupleOutput</h4> <pre>public TupleOutput(byte[] buffer)</pre> <div class="block">Creates a tuple output object for writing a byte array of tuple data, using a given buffer. A new buffer will be allocated only if the number of bytes needed is greater than the length of this buffer. A reference to the byte array will be kept by this object and therefore the byte array should not be modified while this object is in use.</div> <dl><dt><span class="strong">Parameters:</span></dt><dd><code>buffer</code> - is the byte array to use as the buffer.</dd></dl> </li> </ul> </li> </ul> <!-- ============ METHOD DETAIL ========== --> <ul class="blockList"> <li class="blockList"><a name="method_detail"> <!-- --> </a> <h3>Method Detail</h3> <a name="writeBytes(java.lang.String)"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>writeBytes</h4> <pre>public final <a href="../../../../com/sleepycat/bind/tuple/TupleOutput.html" title="class in com.sleepycat.bind.tuple">TupleOutput</a> writeBytes(java.lang.String val)</pre> <div class="block">Writes the specified bytes to the buffer, converting each character to an unsigned byte value. Writes values that can be read using <a href="../../../../com/sleepycat/bind/tuple/TupleInput.html#readBytes(int)"><code>TupleInput.readBytes(int)</code></a>. Only characters with values below 0x100 may be written using this method, since the high-order 8 bits of all characters are discarded.</div> <dl><dt><span class="strong">Parameters:</span></dt><dd><code>val</code> - is the string containing the values to be written.</dd> <dt><span class="strong">Returns:</span></dt><dd>this tuple output object.</dd> <dt><span class="strong">Throws:</span></dt> <dd><code>java.lang.NullPointerException</code> - if the val parameter is null.</dd></dl> </li> </ul> <a name="writeChars(java.lang.String)"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>writeChars</h4> <pre>public final <a href="../../../../com/sleepycat/bind/tuple/TupleOutput.html" title="class in com.sleepycat.bind.tuple">TupleOutput</a> writeChars(java.lang.String val)</pre> <div class="block">Writes the specified characters to the buffer, converting each character to a two byte unsigned value. Writes values that can be read using <a href="../../../../com/sleepycat/bind/tuple/TupleInput.html#readChars(int)"><code>TupleInput.readChars(int)</code></a>.</div> <dl><dt><span class="strong">Parameters:</span></dt><dd><code>val</code> - is the string containing the characters to be written.</dd> <dt><span class="strong">Returns:</span></dt><dd>this tuple output object.</dd> <dt><span class="strong">Throws:</span></dt> <dd><code>java.lang.NullPointerException</code> - if the val parameter is null.</dd></dl> </li> </ul> <a name="writeString(java.lang.String)"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>writeString</h4> <pre>public final <a href="../../../../com/sleepycat/bind/tuple/TupleOutput.html" title="class in com.sleepycat.bind.tuple">TupleOutput</a> writeString(java.lang.String val)</pre> <div class="block">Writes the specified characters to the buffer, converting each character to UTF format, and adding a null terminator byte. Note that zero (0x0000) character values are encoded as non-zero values and a null String parameter is encoded as 0xFF. Writes values that can be read using <a href="../../../../com/sleepycat/bind/tuple/TupleInput.html#readString()"><code>TupleInput.readString()</code></a>.</div> <dl><dt><span class="strong">Parameters:</span></dt><dd><code>val</code> - is the string containing the characters to be written.</dd> <dt><span class="strong">Returns:</span></dt><dd>this tuple output object.</dd></dl> </li> </ul> <a name="writeChar(int)"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>writeChar</h4> <pre>public final <a href="../../../../com/sleepycat/bind/tuple/TupleOutput.html" title="class in com.sleepycat.bind.tuple">TupleOutput</a> writeChar(int val)</pre> <div class="block">Writes a char (two byte) unsigned value to the buffer. Writes values that can be read using <a href="../../../../com/sleepycat/bind/tuple/TupleInput.html#readChar()"><code>TupleInput.readChar()</code></a>.</div> <dl><dt><span class="strong">Parameters:</span></dt><dd><code>val</code> - is the value to write to the buffer.</dd> <dt><span class="strong">Returns:</span></dt><dd>this tuple output object.</dd></dl> </li> </ul> <a name="writeBoolean(boolean)"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>writeBoolean</h4> <pre>public final <a href="../../../../com/sleepycat/bind/tuple/TupleOutput.html" title="class in com.sleepycat.bind.tuple">TupleOutput</a> writeBoolean(boolean val)</pre> <div class="block">Writes a boolean (one byte) unsigned value to the buffer, writing one if the value is true and zero if it is false. Writes values that can be read using <a href="../../../../com/sleepycat/bind/tuple/TupleInput.html#readBoolean()"><code>TupleInput.readBoolean()</code></a>.</div> <dl><dt><span class="strong">Parameters:</span></dt><dd><code>val</code> - is the value to write to the buffer.</dd> <dt><span class="strong">Returns:</span></dt><dd>this tuple output object.</dd></dl> </li> </ul> <a name="writeByte(int)"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>writeByte</h4> <pre>public final <a href="../../../../com/sleepycat/bind/tuple/TupleOutput.html" title="class in com.sleepycat.bind.tuple">TupleOutput</a> writeByte(int val)</pre> <div class="block">Writes an signed byte (one byte) value to the buffer. Writes values that can be read using <a href="../../../../com/sleepycat/bind/tuple/TupleInput.html#readByte()"><code>TupleInput.readByte()</code></a>.</div> <dl><dt><span class="strong">Parameters:</span></dt><dd><code>val</code> - is the value to write to the buffer.</dd> <dt><span class="strong">Returns:</span></dt><dd>this tuple output object.</dd></dl> </li> </ul> <a name="writeShort(int)"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>writeShort</h4> <pre>public final <a href="../../../../com/sleepycat/bind/tuple/TupleOutput.html" title="class in com.sleepycat.bind.tuple">TupleOutput</a> writeShort(int val)</pre> <div class="block">Writes an signed short (two byte) value to the buffer. Writes values that can be read using <a href="../../../../com/sleepycat/bind/tuple/TupleInput.html#readShort()"><code>TupleInput.readShort()</code></a>.</div> <dl><dt><span class="strong">Parameters:</span></dt><dd><code>val</code> - is the value to write to the buffer.</dd> <dt><span class="strong">Returns:</span></dt><dd>this tuple output object.</dd></dl> </li> </ul> <a name="writeInt(int)"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>writeInt</h4> <pre>public final <a href="../../../../com/sleepycat/bind/tuple/TupleOutput.html" title="class in com.sleepycat.bind.tuple">TupleOutput</a> writeInt(int val)</pre> <div class="block">Writes an signed int (four byte) value to the buffer. Writes values that can be read using <a href="../../../../com/sleepycat/bind/tuple/TupleInput.html#readInt()"><code>TupleInput.readInt()</code></a>.</div> <dl><dt><span class="strong">Parameters:</span></dt><dd><code>val</code> - is the value to write to the buffer.</dd> <dt><span class="strong">Returns:</span></dt><dd>this tuple output object.</dd></dl> </li> </ul> <a name="writeLong(long)"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>writeLong</h4> <pre>public final <a href="../../../../com/sleepycat/bind/tuple/TupleOutput.html" title="class in com.sleepycat.bind.tuple">TupleOutput</a> writeLong(long val)</pre> <div class="block">Writes an signed long (eight byte) value to the buffer. Writes values that can be read using <a href="../../../../com/sleepycat/bind/tuple/TupleInput.html#readLong()"><code>TupleInput.readLong()</code></a>.</div> <dl><dt><span class="strong">Parameters:</span></dt><dd><code>val</code> - is the value to write to the buffer.</dd> <dt><span class="strong">Returns:</span></dt><dd>this tuple output object.</dd></dl> </li> </ul> <a name="writeFloat(float)"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>writeFloat</h4> <pre>public final <a href="../../../../com/sleepycat/bind/tuple/TupleOutput.html" title="class in com.sleepycat.bind.tuple">TupleOutput</a> writeFloat(float val)</pre> <div class="block">Writes an signed float (four byte) value to the buffer. Writes values that can be read using <a href="../../../../com/sleepycat/bind/tuple/TupleInput.html#readFloat()"><code>TupleInput.readFloat()</code></a>. <code>Float.floatToIntBits</code> is used to convert the signed float value. <p><em>Note:</em> This method produces byte array values that by default (without a custom comparator) do <em>not</em> sort correctly for negative values. Only non-negative values are sorted correctly by default. To sort all values correctly by default, use <a href="../../../../com/sleepycat/bind/tuple/TupleOutput.html#writeSortedFloat(float)"><code>writeSortedFloat(float)</code></a>.</p></div> <dl><dt><span class="strong">Parameters:</span></dt><dd><code>val</code> - is the value to write to the buffer.</dd> <dt><span class="strong">Returns:</span></dt><dd>this tuple output object.</dd></dl> </li> </ul> <a name="writeDouble(double)"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>writeDouble</h4> <pre>public final <a href="../../../../com/sleepycat/bind/tuple/TupleOutput.html" title="class in com.sleepycat.bind.tuple">TupleOutput</a> writeDouble(double val)</pre> <div class="block">Writes an signed double (eight byte) value to the buffer. Writes values that can be read using <a href="../../../../com/sleepycat/bind/tuple/TupleInput.html#readDouble()"><code>TupleInput.readDouble()</code></a>. <code>Double.doubleToLongBits</code> is used to convert the signed double value. <p><em>Note:</em> This method produces byte array values that by default (without a custom comparator) do <em>not</em> sort correctly for negative values. Only non-negative values are sorted correctly by default. To sort all values correctly by default, use <a href="../../../../com/sleepycat/bind/tuple/TupleOutput.html#writeSortedDouble(double)"><code>writeSortedDouble(double)</code></a>.</p></div> <dl><dt><span class="strong">Parameters:</span></dt><dd><code>val</code> - is the value to write to the buffer.</dd> <dt><span class="strong">Returns:</span></dt><dd>this tuple output object.</dd></dl> </li> </ul> <a name="writeSortedFloat(float)"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>writeSortedFloat</h4> <pre>public final <a href="../../../../com/sleepycat/bind/tuple/TupleOutput.html" title="class in com.sleepycat.bind.tuple">TupleOutput</a> writeSortedFloat(float val)</pre> <div class="block">Writes a signed float (four byte) value to the buffer, with support for correct default sorting of all values. Writes values that can be read using <a href="../../../../com/sleepycat/bind/tuple/TupleInput.html#readSortedFloat()"><code>TupleInput.readSortedFloat()</code></a>. <p><code>Float.floatToIntBits</code> and the following bit manipulations are used to convert the signed float value to a representation that is sorted correctly by default.</p> <pre> int intVal = Float.floatToIntBits(val); intVal ^= (intVal < 0) ? 0xffffffff : 0x80000000; </pre></div> <dl><dt><span class="strong">Parameters:</span></dt><dd><code>val</code> - is the value to write to the buffer.</dd> <dt><span class="strong">Returns:</span></dt><dd>this tuple output object.</dd></dl> </li> </ul> <a name="writeSortedDouble(double)"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>writeSortedDouble</h4> <pre>public final <a href="../../../../com/sleepycat/bind/tuple/TupleOutput.html" title="class in com.sleepycat.bind.tuple">TupleOutput</a> writeSortedDouble(double val)</pre> <div class="block">Writes a signed double (eight byte) value to the buffer, with support for correct default sorting of all values. Writes values that can be read using <a href="../../../../com/sleepycat/bind/tuple/TupleInput.html#readSortedDouble()"><code>TupleInput.readSortedDouble()</code></a>. <p><code>Float.doubleToLongBits</code> and the following bit manipulations are used to convert the signed double value to a representation that is sorted correctly by default.</p> <pre> long longVal = Double.doubleToLongBits(val); longVal ^= (longVal < 0) ? 0xffffffffffffffffL : 0x8000000000000000L; </pre></div> <dl><dt><span class="strong">Parameters:</span></dt><dd><code>val</code> - is the value to write to the buffer.</dd> <dt><span class="strong">Returns:</span></dt><dd>this tuple output object.</dd></dl> </li> </ul> <a name="writeBytes(char[])"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>writeBytes</h4> <pre>public final <a href="../../../../com/sleepycat/bind/tuple/TupleOutput.html" title="class in com.sleepycat.bind.tuple">TupleOutput</a> writeBytes(char[] chars)</pre> <div class="block">Writes the specified bytes to the buffer, converting each character to an unsigned byte value. Writes values that can be read using <a href="../../../../com/sleepycat/bind/tuple/TupleInput.html#readBytes(int)"><code>TupleInput.readBytes(int)</code></a>. Only characters with values below 0x100 may be written using this method, since the high-order 8 bits of all characters are discarded.</div> <dl><dt><span class="strong">Parameters:</span></dt><dd><code>chars</code> - is the array of values to be written.</dd> <dt><span class="strong">Returns:</span></dt><dd>this tuple output object.</dd> <dt><span class="strong">Throws:</span></dt> <dd><code>java.lang.NullPointerException</code> - if the chars parameter is null.</dd></dl> </li> </ul> <a name="writeChars(char[])"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>writeChars</h4> <pre>public final <a href="../../../../com/sleepycat/bind/tuple/TupleOutput.html" title="class in com.sleepycat.bind.tuple">TupleOutput</a> writeChars(char[] chars)</pre> <div class="block">Writes the specified characters to the buffer, converting each character to a two byte unsigned value. Writes values that can be read using <a href="../../../../com/sleepycat/bind/tuple/TupleInput.html#readChars(int)"><code>TupleInput.readChars(int)</code></a>.</div> <dl><dt><span class="strong">Parameters:</span></dt><dd><code>chars</code> - is the array of characters to be written.</dd> <dt><span class="strong">Returns:</span></dt><dd>this tuple output object.</dd> <dt><span class="strong">Throws:</span></dt> <dd><code>java.lang.NullPointerException</code> - if the chars parameter is null.</dd></dl> </li> </ul> <a name="writeString(char[])"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>writeString</h4> <pre>public final <a href="../../../../com/sleepycat/bind/tuple/TupleOutput.html" title="class in com.sleepycat.bind.tuple">TupleOutput</a> writeString(char[] chars)</pre> <div class="block">Writes the specified characters to the buffer, converting each character to UTF format. Note that zero (0x0000) character values are encoded as non-zero values. Writes values that can be read using <a href="../../../../com/sleepycat/bind/tuple/TupleInput.html#readString(int)"><code>TupleInput.readString(int)</code></a> or <a href="../../../../com/sleepycat/bind/tuple/TupleInput.html#readString(char[])"><code>TupleInput.readString(char[])</code></a>.</div> <dl><dt><span class="strong">Parameters:</span></dt><dd><code>chars</code> - is the array of characters to be written.</dd> <dt><span class="strong">Returns:</span></dt><dd>this tuple output object.</dd> <dt><span class="strong">Throws:</span></dt> <dd><code>java.lang.NullPointerException</code> - if the chars parameter is null.</dd></dl> </li> </ul> <a name="writeUnsignedByte(int)"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>writeUnsignedByte</h4> <pre>public final <a href="../../../../com/sleepycat/bind/tuple/TupleOutput.html" title="class in com.sleepycat.bind.tuple">TupleOutput</a> writeUnsignedByte(int val)</pre> <div class="block">Writes an unsigned byte (one byte) value to the buffer. Writes values that can be read using <a href="../../../../com/sleepycat/bind/tuple/TupleInput.html#readUnsignedByte()"><code>TupleInput.readUnsignedByte()</code></a>.</div> <dl><dt><span class="strong">Parameters:</span></dt><dd><code>val</code> - is the value to write to the buffer.</dd> <dt><span class="strong">Returns:</span></dt><dd>this tuple output object.</dd></dl> </li> </ul> <a name="writeUnsignedShort(int)"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>writeUnsignedShort</h4> <pre>public final <a href="../../../../com/sleepycat/bind/tuple/TupleOutput.html" title="class in com.sleepycat.bind.tuple">TupleOutput</a> writeUnsignedShort(int val)</pre> <div class="block">Writes an unsigned short (two byte) value to the buffer. Writes values that can be read using <a href="../../../../com/sleepycat/bind/tuple/TupleInput.html#readUnsignedShort()"><code>TupleInput.readUnsignedShort()</code></a>.</div> <dl><dt><span class="strong">Parameters:</span></dt><dd><code>val</code> - is the value to write to the buffer.</dd> <dt><span class="strong">Returns:</span></dt><dd>this tuple output object.</dd></dl> </li> </ul> <a name="writeUnsignedInt(long)"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>writeUnsignedInt</h4> <pre>public final <a href="../../../../com/sleepycat/bind/tuple/TupleOutput.html" title="class in com.sleepycat.bind.tuple">TupleOutput</a> writeUnsignedInt(long val)</pre> <div class="block">Writes an unsigned int (four byte) value to the buffer. Writes values that can be read using <a href="../../../../com/sleepycat/bind/tuple/TupleInput.html#readUnsignedInt()"><code>TupleInput.readUnsignedInt()</code></a>.</div> <dl><dt><span class="strong">Parameters:</span></dt><dd><code>val</code> - is the value to write to the buffer.</dd> <dt><span class="strong">Returns:</span></dt><dd>this tuple output object.</dd></dl> </li> </ul> <a name="writePackedInt(int)"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>writePackedInt</h4> <pre>public final void writePackedInt(int val)</pre> <div class="block">Writes a packed integer. Note that packed integers are not appropriate for sorted values (keys) unless a custom comparator is used.</div> <dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../com/sleepycat/util/PackedInteger.html" title="class in com.sleepycat.util"><code>PackedInteger</code></a></dd></dl> </li> </ul> <a name="writePackedLong(long)"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>writePackedLong</h4> <pre>public final void writePackedLong(long val)</pre> <div class="block">Writes a packed long integer. Note that packed integers are not appropriate for sorted values (keys) unless a custom comparator is used.</div> <dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../com/sleepycat/util/PackedInteger.html" title="class in com.sleepycat.util"><code>PackedInteger</code></a></dd></dl> </li> </ul> <a name="writeBigInteger(java.math.BigInteger)"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>writeBigInteger</h4> <pre>public final <a href="../../../../com/sleepycat/bind/tuple/TupleOutput.html" title="class in com.sleepycat.bind.tuple">TupleOutput</a> writeBigInteger(java.math.BigInteger val)</pre> <div class="block">Writes a <code>BigInteger</code>. Supported <code>BigInteger</code> values are limited to those with a byte array (<code>BigInteger.toByteArray()</code>) representation with a size of 0x7fff bytes or less. The maximum <code>BigInteger</code> value is (2<sup>0x3fff7</sup> - 1) and the minimum value is (-2<sup>0x3fff7</sup>). <p>The byte format for a <code>BigInteger</code> value is:</p> <ul> <li>Byte 0 and 1: The length of the following bytes, negated if the <code>BigInteger</code> value is negative, and written as a sorted value as if <a href="../../../../com/sleepycat/bind/tuple/TupleOutput.html#writeShort(int)"><code>writeShort(int)</code></a> were called.</li> <li>Byte 2: The first byte of the <code>BigInteger.toByteArray()</code> array, written as a sorted value as if <a href="../../../../com/sleepycat/bind/tuple/TupleOutput.html#writeByte(int)"><code>writeByte(int)</code></a> were called.</li> <li>Byte 3 to N: The second and remaining bytes, if any, of the <code>BigInteger.toByteArray()</code> array, written without modification.</li> </ul> <p>This format provides correct default sorting when the default byte-by-byte comparison is used.</p></div> <dl><dt><span class="strong">Throws:</span></dt> <dd><code>java.lang.NullPointerException</code> - if val is null.</dd> <dd><code>java.lang.IllegalArgumentException</code> - if the byte array representation of val is larger than 0x7fff bytes.</dd></dl> </li> </ul> <a name="getBigIntegerByteLength(java.math.BigInteger)"> <!-- --> </a> <ul class="blockListLast"> <li class="blockList"> <h4>getBigIntegerByteLength</h4> <pre>public static int getBigIntegerByteLength(java.math.BigInteger val)</pre> <div class="block">Returns the byte length of a given <code>BigInteger</code> value.</div> <dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../com/sleepycat/bind/tuple/TupleOutput.html#writeBigInteger(java.math.BigInteger)"><code>writeBigInteger(java.math.BigInteger)</code></a></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="package-tree.html">Tree</a></li> <li><a href="../../../../deprecated-list.html">Deprecated</a></li> <li><a href="../../../../index-all.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/sleepycat/bind/tuple/TupleMarshalledBinding.html" title="class in com.sleepycat.bind.tuple"><span class="strong">Prev Class</span></a></li> <li><a href="../../../../com/sleepycat/bind/tuple/TupleTupleBinding.html" title="class in com.sleepycat.bind.tuple"><span class="strong">Next Class</span></a></li> </ul> <ul class="navList"> <li><a href="../../../../index.html?com/sleepycat/bind/tuple/TupleOutput.html" target="_top">Frames</a></li> <li><a href="TupleOutput.html" target="_top">No Frames</a></li> </ul> <ul class="navList" id="allclasses_navbar_bottom"> <li><a href="../../../../allclasses-noframe.html">All Classes</a></li> </ul> <div> <script type="text/javascript"><!-- allClassesLink = document.getElementById("allclasses_navbar_bottom"); if(window==top) { allClassesLink.style.display = "block"; } else { allClassesLink.style.display = "none"; } //--> </script> </div> <div> <ul class="subNavList"> <li>Summary: </li> <li>Nested | </li> <li><a href="#fields_inherited_from_class_com.sleepycat.util.FastOutputStream">Field</a> | </li> <li><a href="#constructor_summary">Constr</a> | </li> <li><a href="#method_summary">Method</a></li> </ul> <ul class="subNavList"> <li>Detail: </li> <li>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 ======= --> </body> </html>