• Home
  • History
  • Annotate
  • Line#
  • Navigate
  • Raw
  • Download
  • only in /asuswrt-rt-n18u-9.0.0.4.380.2695/release/src-rt/router/db-4.8.30/docs/java/com/sleepycat/bind/tuple/
1<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
2<!--NewPage-->
3<HTML>
4<HEAD>
5<!-- Generated by javadoc (build 1.6.0_03) on Mon Apr 12 16:25:48 EDT 2010 -->
6<TITLE>
7TupleInput (Oracle - Berkeley DB Java API)
8</TITLE>
9
10<META NAME="date" CONTENT="2010-04-12">
11
12<LINK REL ="stylesheet" TYPE="text/css" HREF="../../../../style.css" TITLE="Style">
13
14<SCRIPT type="text/javascript">
15function windowTitle()
16{
17    if (location.href.indexOf('is-external=true') == -1) {
18        parent.document.title="TupleInput (Oracle - Berkeley DB Java API)";
19    }
20}
21</SCRIPT>
22<NOSCRIPT>
23</NOSCRIPT>
24
25</HEAD>
26
27<BODY BGCOLOR="white" onload="windowTitle();">
28<HR>
29
30
31<!-- ========= START OF TOP NAVBAR ======= -->
32<A NAME="navbar_top"><!-- --></A>
33<A HREF="#skip-navbar_top" title="Skip navigation links"></A>
34<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
35<TR>
36<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
37<A NAME="navbar_top_firstrow"><!-- --></A>
38<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
39  <TR ALIGN="center" VALIGN="top">
40  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>
41  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
42  <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
43  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="class-use/TupleInput.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A>&nbsp;</TD>
44  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
45  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>
46  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
47  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
48  </TR>
49</TABLE>
50</TD>
51<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
52<b>Berkeley DB</b><br><font size="-1"> version 4.8.30</font></EM>
53</TD>
54</TR>
55
56<TR>
57<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
58&nbsp;<A HREF="../../../../com/sleepycat/bind/tuple/TupleBinding.html" title="class in com.sleepycat.bind.tuple"><B>PREV CLASS</B></A>&nbsp;
59&nbsp;<A HREF="../../../../com/sleepycat/bind/tuple/TupleInputBinding.html" title="class in com.sleepycat.bind.tuple"><B>NEXT CLASS</B></A></FONT></TD>
60<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
61  <A HREF="../../../../index.html?com/sleepycat/bind/tuple/TupleInput.html" target="_top"><B>FRAMES</B></A>  &nbsp;
62&nbsp;<A HREF="TupleInput.html" target="_top"><B>NO FRAMES</B></A>  &nbsp;
63&nbsp;<SCRIPT type="text/javascript">
64  <!--
65  if(window==top) {
66    document.writeln('<A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>');
67  }
68  //-->
69</SCRIPT>
70<NOSCRIPT>
71  <A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>
72</NOSCRIPT>
73
74
75</FONT></TD>
76</TR>
77<TR>
78<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
79  SUMMARY:&nbsp;NESTED&nbsp;|&nbsp;<A HREF="#fields_inherited_from_class_com.sleepycat.util.FastInputStream">FIELD</A>&nbsp;|&nbsp;<A HREF="#constructor_summary">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>
80<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
81DETAIL:&nbsp;FIELD&nbsp;|&nbsp;<A HREF="#constructor_detail">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></FONT></TD>
82</TR>
83</TABLE>
84<A NAME="skip-navbar_top"></A>
85<!-- ========= END OF TOP NAVBAR ========= -->
86
87<HR>
88<!-- ======== START OF CLASS DATA ======== -->
89<H2>
90<FONT SIZE="-1">
91com.sleepycat.bind.tuple</FONT>
92<BR>
93Class TupleInput</H2>
94<PRE>
95<A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">java.lang.Object</A>
96  <IMG SRC="../../../../resources/inherit.gif" ALT="extended by "><A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/io/InputStream.html?is-external=true" title="class or interface in java.io">java.io.InputStream</A>
97      <IMG SRC="../../../../resources/inherit.gif" ALT="extended by "><A HREF="../../../../com/sleepycat/util/FastInputStream.html" title="class in com.sleepycat.util">com.sleepycat.util.FastInputStream</A>
98          <IMG SRC="../../../../resources/inherit.gif" ALT="extended by "><B>com.sleepycat.bind.tuple.TupleInput</B>
99</PRE>
100<DL>
101<DT><B>All Implemented Interfaces:</B> <DD><A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/io/Closeable.html?is-external=true" title="class or interface in java.io">Closeable</A></DD>
102</DL>
103<HR>
104<DL>
105<DT><PRE>public class <B>TupleInput</B><DT>extends <A HREF="../../../../com/sleepycat/util/FastInputStream.html" title="class in com.sleepycat.util">FastInputStream</A></DL>
106</PRE>
107
108<P>
109An <code>InputStream</code> with <code>DataInput</code>-like methods for
110 reading tuple fields.  It is used by <code>TupleBinding</code>.
111
112 <p>This class has many methods that have the same signatures as methods in
113 the <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/io/DataInput.html?is-external=true" title="class or interface in java.io"><CODE>DataInput</CODE></A> interface.  The reason this class does not
114 implement <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/io/DataInput.html?is-external=true" title="class or interface in java.io"><CODE>DataInput</CODE></A> is because it would break the interface
115 contract for those methods because of data format differences.</p>
116
117 <p>Signed numbers are stored in the buffer in MSB (most significant byte
118 first) order with their sign bit (high-order bit) inverted to cause negative
119 numbers to be sorted first when comparing values as unsigned byte arrays,
120 as done in a database.  Unsigned numbers, including characters, are stored
121 in MSB order with no change to their sign bit.  BigInteger values are stored
122 with a preceding length having the same sign as the value.</p>
123
124 <p>Strings and character arrays are stored either as a fixed length array of
125 unicode characters, where the length must be known by the application, or as
126 a null-terminated UTF byte array.</p>
127 <ul>
128 <li>Null strings are UTF encoded as { 0xFF }, which is not allowed in a
129 standard UTF encoding.  This allows null strings, as distinct from empty or
130 zero length strings, to be represented in a tuple.  Using the default
131 comparator, null strings will be ordered last.</li>
132 <li>Zero (0x0000) character values are UTF encoded as non-zero values, and
133 therefore embedded zeros in the string are supported.  The sequence { 0xC0,
134 0x80 } is used to encode a zero character.  This UTF encoding is the same
135 one used by native Java UTF libraries.  However, this encoding of zero does
136 impact the lexicographical ordering, and zeros will not be sorted first (the
137 natural order) or last.  For all character values other than zero, the
138 default UTF byte ordering is the same as the Unicode lexicographical
139 character ordering.</li>
140 </ul>
141
142 <p>Floats and doubles are stored using two different representations: sorted
143 representation and integer-bit (IEEE 754) representation.  If you use
144 negative floating point numbers in a key, you should use sorted
145 representation; alternatively you may use integer-bit representation but you
146 will need to implement and configure a custom comparator to get correct
147 numeric ordering for negative numbers.</p>
148
149 <p>To use sorted representation use this set of methods:</p>
150 <ul>
151 <li><A HREF="../../../../com/sleepycat/bind/tuple/TupleOutput.html#writeSortedFloat(float)"><CODE>TupleOutput.writeSortedFloat(float)</CODE></A></li>
152 <li><A HREF="../../../../com/sleepycat/bind/tuple/TupleInput.html#readSortedFloat()"><CODE>readSortedFloat()</CODE></A></li>
153 <li><A HREF="../../../../com/sleepycat/bind/tuple/TupleOutput.html#writeSortedDouble(double)"><CODE>TupleOutput.writeSortedDouble(double)</CODE></A></li>
154 <li><A HREF="../../../../com/sleepycat/bind/tuple/TupleInput.html#readSortedDouble()"><CODE>readSortedDouble()</CODE></A></li>
155 </ul>
156
157 <p>To use integer-bit representation use this set of methods:</p>
158 <ul>
159 <li><A HREF="../../../../com/sleepycat/bind/tuple/TupleOutput.html#writeFloat(float)"><CODE>TupleOutput.writeFloat(float)</CODE></A></li>
160 <li><A HREF="../../../../com/sleepycat/bind/tuple/TupleInput.html#readFloat()"><CODE>readFloat()</CODE></A></li>
161 <li><A HREF="../../../../com/sleepycat/bind/tuple/TupleOutput.html#writeDouble(double)"><CODE>TupleOutput.writeDouble(double)</CODE></A></li>
162 <li><A HREF="../../../../com/sleepycat/bind/tuple/TupleInput.html#readDouble()"><CODE>readDouble()</CODE></A></li>
163 </ul>
164<P>
165
166<P>
167<HR>
168
169<P>
170<!-- =========== FIELD SUMMARY =========== -->
171
172<A NAME="field_summary"><!-- --></A>
173<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
174<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
175<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
176<B>Field Summary</B></FONT></TH>
177</TR>
178</TABLE>
179&nbsp;<A NAME="fields_inherited_from_class_com.sleepycat.util.FastInputStream"><!-- --></A>
180<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
181<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
182<TH ALIGN="left"><B>Fields inherited from class com.sleepycat.util.<A HREF="../../../../com/sleepycat/util/FastInputStream.html" title="class in com.sleepycat.util">FastInputStream</A></B></TH>
183</TR>
184<TR BGCOLOR="white" CLASS="TableRowColor">
185<TD><CODE><A HREF="../../../../com/sleepycat/util/FastInputStream.html#buf">buf</A>, <A HREF="../../../../com/sleepycat/util/FastInputStream.html#len">len</A>, <A HREF="../../../../com/sleepycat/util/FastInputStream.html#mark">mark</A>, <A HREF="../../../../com/sleepycat/util/FastInputStream.html#off">off</A></CODE></TD>
186</TR>
187</TABLE>
188&nbsp;
189<!-- ======== CONSTRUCTOR SUMMARY ======== -->
190
191<A NAME="constructor_summary"><!-- --></A>
192<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
193<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
194<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
195<B>Constructor Summary</B></FONT></TH>
196</TR>
197<TR BGCOLOR="white" CLASS="TableRowColor">
198<TD><CODE><B><A HREF="../../../../com/sleepycat/bind/tuple/TupleInput.html#TupleInput(byte[])">TupleInput</A></B>(byte[]&nbsp;buffer)</CODE>
199
200<BR>
201&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Creates a tuple input object for reading a byte array of tuple data.</TD>
202</TR>
203<TR BGCOLOR="white" CLASS="TableRowColor">
204<TD><CODE><B><A HREF="../../../../com/sleepycat/bind/tuple/TupleInput.html#TupleInput(byte[], int, int)">TupleInput</A></B>(byte[]&nbsp;buffer,
205           int&nbsp;offset,
206           int&nbsp;length)</CODE>
207
208<BR>
209&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Creates a tuple input object for reading a byte array of tuple data at
210 a given offset for a given length.</TD>
211</TR>
212<TR BGCOLOR="white" CLASS="TableRowColor">
213<TD><CODE><B><A HREF="../../../../com/sleepycat/bind/tuple/TupleInput.html#TupleInput(com.sleepycat.bind.tuple.TupleOutput)">TupleInput</A></B>(<A HREF="../../../../com/sleepycat/bind/tuple/TupleOutput.html" title="class in com.sleepycat.bind.tuple">TupleOutput</A>&nbsp;output)</CODE>
214
215<BR>
216&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Creates a tuple input object from the data contained in a tuple output
217 object.</TD>
218</TR>
219</TABLE>
220&nbsp;
221<!-- ========== METHOD SUMMARY =========== -->
222
223<A NAME="method_summary"><!-- --></A>
224<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
225<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
226<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
227<B>Method Summary</B></FONT></TH>
228</TR>
229<TR BGCOLOR="white" CLASS="TableRowColor">
230<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
231<CODE>&nbsp;int</CODE></FONT></TD>
232<TD><CODE><B><A HREF="../../../../com/sleepycat/bind/tuple/TupleInput.html#getBigIntegerByteLength()">getBigIntegerByteLength</A></B>()</CODE>
233
234<BR>
235&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns the byte length of a <code>BigInteger</code>.</TD>
236</TR>
237<TR BGCOLOR="white" CLASS="TableRowColor">
238<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
239<CODE>&nbsp;int</CODE></FONT></TD>
240<TD><CODE><B><A HREF="../../../../com/sleepycat/bind/tuple/TupleInput.html#getPackedIntByteLength()">getPackedIntByteLength</A></B>()</CODE>
241
242<BR>
243&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns the byte length of a packed integer.</TD>
244</TR>
245<TR BGCOLOR="white" CLASS="TableRowColor">
246<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
247<CODE>&nbsp;int</CODE></FONT></TD>
248<TD><CODE><B><A HREF="../../../../com/sleepycat/bind/tuple/TupleInput.html#getPackedLongByteLength()">getPackedLongByteLength</A></B>()</CODE>
249
250<BR>
251&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns the byte length of a packed long integer.</TD>
252</TR>
253<TR BGCOLOR="white" CLASS="TableRowColor">
254<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
255<CODE>&nbsp;int</CODE></FONT></TD>
256<TD><CODE><B><A HREF="../../../../com/sleepycat/bind/tuple/TupleInput.html#getStringByteLength()">getStringByteLength</A></B>()</CODE>
257
258<BR>
259&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns the byte length of a null-terminated UTF string in the data
260 buffer, including the terminator.</TD>
261</TR>
262<TR BGCOLOR="white" CLASS="TableRowColor">
263<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
264<CODE>&nbsp;<A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/math/BigInteger.html?is-external=true" title="class or interface in java.math">BigInteger</A></CODE></FONT></TD>
265<TD><CODE><B><A HREF="../../../../com/sleepycat/bind/tuple/TupleInput.html#readBigInteger()">readBigInteger</A></B>()</CODE>
266
267<BR>
268&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Reads a <code>BigInteger</code>.</TD>
269</TR>
270<TR BGCOLOR="white" CLASS="TableRowColor">
271<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
272<CODE>&nbsp;boolean</CODE></FONT></TD>
273<TD><CODE><B><A HREF="../../../../com/sleepycat/bind/tuple/TupleInput.html#readBoolean()">readBoolean</A></B>()</CODE>
274
275<BR>
276&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Reads a boolean (one byte) unsigned value from the buffer and returns
277 true if it is non-zero and false if it is zero.</TD>
278</TR>
279<TR BGCOLOR="white" CLASS="TableRowColor">
280<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
281<CODE>&nbsp;byte</CODE></FONT></TD>
282<TD><CODE><B><A HREF="../../../../com/sleepycat/bind/tuple/TupleInput.html#readByte()">readByte</A></B>()</CODE>
283
284<BR>
285&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Reads a signed byte (one byte) value from the buffer.</TD>
286</TR>
287<TR BGCOLOR="white" CLASS="TableRowColor">
288<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
289<CODE>&nbsp;void</CODE></FONT></TD>
290<TD><CODE><B><A HREF="../../../../com/sleepycat/bind/tuple/TupleInput.html#readBytes(char[])">readBytes</A></B>(char[]&nbsp;chars)</CODE>
291
292<BR>
293&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Reads the specified number of bytes from the buffer, converting each
294 unsigned byte value to a character of the resulting array.</TD>
295</TR>
296<TR BGCOLOR="white" CLASS="TableRowColor">
297<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
298<CODE>&nbsp;<A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A></CODE></FONT></TD>
299<TD><CODE><B><A HREF="../../../../com/sleepycat/bind/tuple/TupleInput.html#readBytes(int)">readBytes</A></B>(int&nbsp;length)</CODE>
300
301<BR>
302&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Reads the specified number of bytes from the buffer, converting each
303 unsigned byte value to a character of the resulting string.</TD>
304</TR>
305<TR BGCOLOR="white" CLASS="TableRowColor">
306<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
307<CODE>&nbsp;char</CODE></FONT></TD>
308<TD><CODE><B><A HREF="../../../../com/sleepycat/bind/tuple/TupleInput.html#readChar()">readChar</A></B>()</CODE>
309
310<BR>
311&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Reads a char (two byte) unsigned value from the buffer.</TD>
312</TR>
313<TR BGCOLOR="white" CLASS="TableRowColor">
314<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
315<CODE>&nbsp;void</CODE></FONT></TD>
316<TD><CODE><B><A HREF="../../../../com/sleepycat/bind/tuple/TupleInput.html#readChars(char[])">readChars</A></B>(char[]&nbsp;chars)</CODE>
317
318<BR>
319&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Reads the specified number of characters from the buffer, converting
320 each two byte unsigned value to a character of the resulting array.</TD>
321</TR>
322<TR BGCOLOR="white" CLASS="TableRowColor">
323<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
324<CODE>&nbsp;<A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A></CODE></FONT></TD>
325<TD><CODE><B><A HREF="../../../../com/sleepycat/bind/tuple/TupleInput.html#readChars(int)">readChars</A></B>(int&nbsp;length)</CODE>
326
327<BR>
328&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Reads the specified number of characters from the buffer, converting
329 each two byte unsigned value to a character of the resulting string.</TD>
330</TR>
331<TR BGCOLOR="white" CLASS="TableRowColor">
332<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
333<CODE>&nbsp;double</CODE></FONT></TD>
334<TD><CODE><B><A HREF="../../../../com/sleepycat/bind/tuple/TupleInput.html#readDouble()">readDouble</A></B>()</CODE>
335
336<BR>
337&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Reads a signed double (eight byte) value from the buffer.</TD>
338</TR>
339<TR BGCOLOR="white" CLASS="TableRowColor">
340<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
341<CODE>&nbsp;float</CODE></FONT></TD>
342<TD><CODE><B><A HREF="../../../../com/sleepycat/bind/tuple/TupleInput.html#readFloat()">readFloat</A></B>()</CODE>
343
344<BR>
345&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Reads a signed float (four byte) value from the buffer.</TD>
346</TR>
347<TR BGCOLOR="white" CLASS="TableRowColor">
348<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
349<CODE>&nbsp;int</CODE></FONT></TD>
350<TD><CODE><B><A HREF="../../../../com/sleepycat/bind/tuple/TupleInput.html#readInt()">readInt</A></B>()</CODE>
351
352<BR>
353&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Reads a signed int (four byte) value from the buffer.</TD>
354</TR>
355<TR BGCOLOR="white" CLASS="TableRowColor">
356<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
357<CODE>&nbsp;long</CODE></FONT></TD>
358<TD><CODE><B><A HREF="../../../../com/sleepycat/bind/tuple/TupleInput.html#readLong()">readLong</A></B>()</CODE>
359
360<BR>
361&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Reads a signed long (eight byte) value from the buffer.</TD>
362</TR>
363<TR BGCOLOR="white" CLASS="TableRowColor">
364<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
365<CODE>&nbsp;int</CODE></FONT></TD>
366<TD><CODE><B><A HREF="../../../../com/sleepycat/bind/tuple/TupleInput.html#readPackedInt()">readPackedInt</A></B>()</CODE>
367
368<BR>
369&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Reads a packed integer.</TD>
370</TR>
371<TR BGCOLOR="white" CLASS="TableRowColor">
372<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
373<CODE>&nbsp;long</CODE></FONT></TD>
374<TD><CODE><B><A HREF="../../../../com/sleepycat/bind/tuple/TupleInput.html#readPackedLong()">readPackedLong</A></B>()</CODE>
375
376<BR>
377&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Reads a packed long integer.</TD>
378</TR>
379<TR BGCOLOR="white" CLASS="TableRowColor">
380<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
381<CODE>&nbsp;short</CODE></FONT></TD>
382<TD><CODE><B><A HREF="../../../../com/sleepycat/bind/tuple/TupleInput.html#readShort()">readShort</A></B>()</CODE>
383
384<BR>
385&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Reads a signed short (two byte) value from the buffer.</TD>
386</TR>
387<TR BGCOLOR="white" CLASS="TableRowColor">
388<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
389<CODE>&nbsp;double</CODE></FONT></TD>
390<TD><CODE><B><A HREF="../../../../com/sleepycat/bind/tuple/TupleInput.html#readSortedDouble()">readSortedDouble</A></B>()</CODE>
391
392<BR>
393&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Reads a signed double (eight byte) value from the buffer, with support
394 for correct default sorting of all values.</TD>
395</TR>
396<TR BGCOLOR="white" CLASS="TableRowColor">
397<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
398<CODE>&nbsp;float</CODE></FONT></TD>
399<TD><CODE><B><A HREF="../../../../com/sleepycat/bind/tuple/TupleInput.html#readSortedFloat()">readSortedFloat</A></B>()</CODE>
400
401<BR>
402&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Reads a signed float (four byte) value from the buffer, with support
403 for correct default sorting of all values.</TD>
404</TR>
405<TR BGCOLOR="white" CLASS="TableRowColor">
406<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
407<CODE>&nbsp;<A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A></CODE></FONT></TD>
408<TD><CODE><B><A HREF="../../../../com/sleepycat/bind/tuple/TupleInput.html#readString()">readString</A></B>()</CODE>
409
410<BR>
411&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Reads a null-terminated UTF string from the data buffer and converts
412 the data from UTF to Unicode.</TD>
413</TR>
414<TR BGCOLOR="white" CLASS="TableRowColor">
415<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
416<CODE>&nbsp;void</CODE></FONT></TD>
417<TD><CODE><B><A HREF="../../../../com/sleepycat/bind/tuple/TupleInput.html#readString(char[])">readString</A></B>(char[]&nbsp;chars)</CODE>
418
419<BR>
420&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Reads the specified number of UTF characters string from the data
421 buffer and converts the data from UTF to Unicode.</TD>
422</TR>
423<TR BGCOLOR="white" CLASS="TableRowColor">
424<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
425<CODE>&nbsp;<A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A></CODE></FONT></TD>
426<TD><CODE><B><A HREF="../../../../com/sleepycat/bind/tuple/TupleInput.html#readString(int)">readString</A></B>(int&nbsp;length)</CODE>
427
428<BR>
429&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Reads the specified number of UTF characters string from the data
430 buffer and converts the data from UTF to Unicode.</TD>
431</TR>
432<TR BGCOLOR="white" CLASS="TableRowColor">
433<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
434<CODE>&nbsp;int</CODE></FONT></TD>
435<TD><CODE><B><A HREF="../../../../com/sleepycat/bind/tuple/TupleInput.html#readUnsignedByte()">readUnsignedByte</A></B>()</CODE>
436
437<BR>
438&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Reads an unsigned byte (one byte) value from the buffer.</TD>
439</TR>
440<TR BGCOLOR="white" CLASS="TableRowColor">
441<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
442<CODE>&nbsp;long</CODE></FONT></TD>
443<TD><CODE><B><A HREF="../../../../com/sleepycat/bind/tuple/TupleInput.html#readUnsignedInt()">readUnsignedInt</A></B>()</CODE>
444
445<BR>
446&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Reads an unsigned int (four byte) value from the buffer.</TD>
447</TR>
448<TR BGCOLOR="white" CLASS="TableRowColor">
449<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
450<CODE>&nbsp;int</CODE></FONT></TD>
451<TD><CODE><B><A HREF="../../../../com/sleepycat/bind/tuple/TupleInput.html#readUnsignedShort()">readUnsignedShort</A></B>()</CODE>
452
453<BR>
454&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Reads an unsigned short (two byte) value from the buffer.</TD>
455</TR>
456</TABLE>
457&nbsp;<A NAME="methods_inherited_from_class_com.sleepycat.util.FastInputStream"><!-- --></A>
458<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
459<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
460<TH ALIGN="left"><B>Methods inherited from class com.sleepycat.util.<A HREF="../../../../com/sleepycat/util/FastInputStream.html" title="class in com.sleepycat.util">FastInputStream</A></B></TH>
461</TR>
462<TR BGCOLOR="white" CLASS="TableRowColor">
463<TD><CODE><A HREF="../../../../com/sleepycat/util/FastInputStream.html#available()">available</A>, <A HREF="../../../../com/sleepycat/util/FastInputStream.html#getBufferBytes()">getBufferBytes</A>, <A HREF="../../../../com/sleepycat/util/FastInputStream.html#getBufferLength()">getBufferLength</A>, <A HREF="../../../../com/sleepycat/util/FastInputStream.html#getBufferOffset()">getBufferOffset</A>, <A HREF="../../../../com/sleepycat/util/FastInputStream.html#mark(int)">mark</A>, <A HREF="../../../../com/sleepycat/util/FastInputStream.html#markSupported()">markSupported</A>, <A HREF="../../../../com/sleepycat/util/FastInputStream.html#read()">read</A>, <A HREF="../../../../com/sleepycat/util/FastInputStream.html#read(byte[])">read</A>, <A HREF="../../../../com/sleepycat/util/FastInputStream.html#read(byte[], int, int)">read</A>, <A HREF="../../../../com/sleepycat/util/FastInputStream.html#readFast()">readFast</A>, <A HREF="../../../../com/sleepycat/util/FastInputStream.html#readFast(byte[])">readFast</A>, <A HREF="../../../../com/sleepycat/util/FastInputStream.html#readFast(byte[], int, int)">readFast</A>, <A HREF="../../../../com/sleepycat/util/FastInputStream.html#reset()">reset</A>, <A HREF="../../../../com/sleepycat/util/FastInputStream.html#skip(long)">skip</A>, <A HREF="../../../../com/sleepycat/util/FastInputStream.html#skipFast(int)">skipFast</A></CODE></TD>
464</TR>
465</TABLE>
466&nbsp;<A NAME="methods_inherited_from_class_java.io.InputStream"><!-- --></A>
467<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
468<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
469<TH ALIGN="left"><B>Methods inherited from class java.io.<A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/io/InputStream.html?is-external=true" title="class or interface in java.io">InputStream</A></B></TH>
470</TR>
471<TR BGCOLOR="white" CLASS="TableRowColor">
472<TD><CODE><A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/io/InputStream.html?is-external=true#close()" title="class or interface in java.io">close</A></CODE></TD>
473</TR>
474</TABLE>
475&nbsp;<A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A>
476<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
477<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
478<TH ALIGN="left"><B>Methods inherited from class java.lang.<A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</A></B></TH>
479</TR>
480<TR BGCOLOR="white" CLASS="TableRowColor">
481<TD><CODE><A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Object.html?is-external=true#clone()" title="class or interface in java.lang">clone</A>, <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Object.html?is-external=true#equals(java.lang.Object)" title="class or interface in java.lang">equals</A>, <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Object.html?is-external=true#finalize()" title="class or interface in java.lang">finalize</A>, <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Object.html?is-external=true#getClass()" title="class or interface in java.lang">getClass</A>, <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Object.html?is-external=true#hashCode()" title="class or interface in java.lang">hashCode</A>, <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Object.html?is-external=true#notify()" title="class or interface in java.lang">notify</A>, <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Object.html?is-external=true#notifyAll()" title="class or interface in java.lang">notifyAll</A>, <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Object.html?is-external=true#toString()" title="class or interface in java.lang">toString</A>, <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Object.html?is-external=true#wait()" title="class or interface in java.lang">wait</A>, <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Object.html?is-external=true#wait(long)" title="class or interface in java.lang">wait</A>, <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Object.html?is-external=true#wait(long, int)" title="class or interface in java.lang">wait</A></CODE></TD>
482</TR>
483</TABLE>
484&nbsp;
485<P>
486
487<!-- ========= CONSTRUCTOR DETAIL ======== -->
488
489<A NAME="constructor_detail"><!-- --></A>
490<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
491<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
492<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
493<B>Constructor Detail</B></FONT></TH>
494</TR>
495</TABLE>
496
497<A NAME="TupleInput(byte[])"><!-- --></A><H3>
498TupleInput</H3>
499<PRE>
500public <B>TupleInput</B>(byte[]&nbsp;buffer)</PRE>
501<DL>
502<DD>Creates a tuple input object for reading a byte array of tuple data.  A
503 reference to the byte array will be kept by this object (it will not be
504 copied) and therefore the byte array should not be modified while this
505 object is in use.
506<P>
507<DL>
508<DT><B>Parameters:</B><DD><CODE>buffer</CODE> - is the byte array to be read and should contain data in
509 tuple format.</DL>
510</DL>
511<HR>
512
513<A NAME="TupleInput(byte[], int, int)"><!-- --></A><H3>
514TupleInput</H3>
515<PRE>
516public <B>TupleInput</B>(byte[]&nbsp;buffer,
517                  int&nbsp;offset,
518                  int&nbsp;length)</PRE>
519<DL>
520<DD>Creates a tuple input object for reading a byte array of tuple data at
521 a given offset for a given length.  A reference to the byte array will
522 be kept by this object (it will not be copied) and therefore the byte
523 array should not be modified while this object is in use.
524<P>
525<DL>
526<DT><B>Parameters:</B><DD><CODE>buffer</CODE> - is the byte array to be read and should contain data in
527 tuple format.<DD><CODE>offset</CODE> - is the byte offset at which to begin reading.<DD><CODE>length</CODE> - is the number of bytes to be read.</DL>
528</DL>
529<HR>
530
531<A NAME="TupleInput(com.sleepycat.bind.tuple.TupleOutput)"><!-- --></A><H3>
532TupleInput</H3>
533<PRE>
534public <B>TupleInput</B>(<A HREF="../../../../com/sleepycat/bind/tuple/TupleOutput.html" title="class in com.sleepycat.bind.tuple">TupleOutput</A>&nbsp;output)</PRE>
535<DL>
536<DD>Creates a tuple input object from the data contained in a tuple output
537 object.  A reference to the tuple output's byte array will be kept by
538 this object (it will not be copied) and therefore the tuple output
539 object should not be modified while this object is in use.
540<P>
541<DL>
542<DT><B>Parameters:</B><DD><CODE>output</CODE> - is the tuple output object containing the data to be read.</DL>
543</DL>
544
545<!-- ============ METHOD DETAIL ========== -->
546
547<A NAME="method_detail"><!-- --></A>
548<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
549<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
550<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
551<B>Method Detail</B></FONT></TH>
552</TR>
553</TABLE>
554
555<A NAME="readString()"><!-- --></A><H3>
556readString</H3>
557<PRE>
558public final <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> <B>readString</B>()
559                        throws <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/IndexOutOfBoundsException.html?is-external=true" title="class or interface in java.lang">IndexOutOfBoundsException</A>,
560                               <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/IllegalArgumentException.html?is-external=true" title="class or interface in java.lang">IllegalArgumentException</A></PRE>
561<DL>
562<DD>Reads a null-terminated UTF string from the data buffer and converts
563 the data from UTF to Unicode.
564 Reads values that were written using <A HREF="../../../../com/sleepycat/bind/tuple/TupleOutput.html#writeString(java.lang.String)"><CODE>TupleOutput.writeString(String)</CODE></A>.
565<P>
566<DD><DL>
567
568<DT><B>Returns:</B><DD>the converted string.
569<DT><B>Throws:</B>
570<DD><CODE><A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/IndexOutOfBoundsException.html?is-external=true" title="class or interface in java.lang">IndexOutOfBoundsException</A></CODE> - if no null terminating byte is found
571 in the buffer.
572<DD><CODE><A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/IllegalArgumentException.html?is-external=true" title="class or interface in java.lang">IllegalArgumentException</A></CODE> - malformed UTF data is encountered.</DL>
573</DD>
574</DL>
575<HR>
576
577<A NAME="readChar()"><!-- --></A><H3>
578readChar</H3>
579<PRE>
580public final char <B>readChar</B>()
581                    throws <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/IndexOutOfBoundsException.html?is-external=true" title="class or interface in java.lang">IndexOutOfBoundsException</A></PRE>
582<DL>
583<DD>Reads a char (two byte) unsigned value from the buffer.
584 Reads values that were written using <A HREF="../../../../com/sleepycat/bind/tuple/TupleOutput.html#writeChar(int)"><CODE>TupleOutput.writeChar(int)</CODE></A>.
585<P>
586<DD><DL>
587
588<DT><B>Returns:</B><DD>the value read from the buffer.
589<DT><B>Throws:</B>
590<DD><CODE><A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/IndexOutOfBoundsException.html?is-external=true" title="class or interface in java.lang">IndexOutOfBoundsException</A></CODE> - if not enough bytes are available in
591 the buffer.</DL>
592</DD>
593</DL>
594<HR>
595
596<A NAME="readBoolean()"><!-- --></A><H3>
597readBoolean</H3>
598<PRE>
599public final boolean <B>readBoolean</B>()
600                          throws <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/IndexOutOfBoundsException.html?is-external=true" title="class or interface in java.lang">IndexOutOfBoundsException</A></PRE>
601<DL>
602<DD>Reads a boolean (one byte) unsigned value from the buffer and returns
603 true if it is non-zero and false if it is zero.
604 Reads values that were written using <A HREF="../../../../com/sleepycat/bind/tuple/TupleOutput.html#writeBoolean(boolean)"><CODE>TupleOutput.writeBoolean(boolean)</CODE></A>.
605<P>
606<DD><DL>
607
608<DT><B>Returns:</B><DD>the value read from the buffer.
609<DT><B>Throws:</B>
610<DD><CODE><A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/IndexOutOfBoundsException.html?is-external=true" title="class or interface in java.lang">IndexOutOfBoundsException</A></CODE> - if not enough bytes are available in
611 the buffer.</DL>
612</DD>
613</DL>
614<HR>
615
616<A NAME="readByte()"><!-- --></A><H3>
617readByte</H3>
618<PRE>
619public final byte <B>readByte</B>()
620                    throws <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/IndexOutOfBoundsException.html?is-external=true" title="class or interface in java.lang">IndexOutOfBoundsException</A></PRE>
621<DL>
622<DD>Reads a signed byte (one byte) value from the buffer.
623 Reads values that were written using <A HREF="../../../../com/sleepycat/bind/tuple/TupleOutput.html#writeByte(int)"><CODE>TupleOutput.writeByte(int)</CODE></A>.
624<P>
625<DD><DL>
626
627<DT><B>Returns:</B><DD>the value read from the buffer.
628<DT><B>Throws:</B>
629<DD><CODE><A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/IndexOutOfBoundsException.html?is-external=true" title="class or interface in java.lang">IndexOutOfBoundsException</A></CODE> - if not enough bytes are available in
630 the buffer.</DL>
631</DD>
632</DL>
633<HR>
634
635<A NAME="readShort()"><!-- --></A><H3>
636readShort</H3>
637<PRE>
638public final short <B>readShort</B>()
639                      throws <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/IndexOutOfBoundsException.html?is-external=true" title="class or interface in java.lang">IndexOutOfBoundsException</A></PRE>
640<DL>
641<DD>Reads a signed short (two byte) value from the buffer.
642 Reads values that were written using <A HREF="../../../../com/sleepycat/bind/tuple/TupleOutput.html#writeShort(int)"><CODE>TupleOutput.writeShort(int)</CODE></A>.
643<P>
644<DD><DL>
645
646<DT><B>Returns:</B><DD>the value read from the buffer.
647<DT><B>Throws:</B>
648<DD><CODE><A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/IndexOutOfBoundsException.html?is-external=true" title="class or interface in java.lang">IndexOutOfBoundsException</A></CODE> - if not enough bytes are available in
649 the buffer.</DL>
650</DD>
651</DL>
652<HR>
653
654<A NAME="readInt()"><!-- --></A><H3>
655readInt</H3>
656<PRE>
657public final int <B>readInt</B>()
658                  throws <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/IndexOutOfBoundsException.html?is-external=true" title="class or interface in java.lang">IndexOutOfBoundsException</A></PRE>
659<DL>
660<DD>Reads a signed int (four byte) value from the buffer.
661 Reads values that were written using <A HREF="../../../../com/sleepycat/bind/tuple/TupleOutput.html#writeInt(int)"><CODE>TupleOutput.writeInt(int)</CODE></A>.
662<P>
663<DD><DL>
664
665<DT><B>Returns:</B><DD>the value read from the buffer.
666<DT><B>Throws:</B>
667<DD><CODE><A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/IndexOutOfBoundsException.html?is-external=true" title="class or interface in java.lang">IndexOutOfBoundsException</A></CODE> - if not enough bytes are available in
668 the buffer.</DL>
669</DD>
670</DL>
671<HR>
672
673<A NAME="readLong()"><!-- --></A><H3>
674readLong</H3>
675<PRE>
676public final long <B>readLong</B>()
677                    throws <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/IndexOutOfBoundsException.html?is-external=true" title="class or interface in java.lang">IndexOutOfBoundsException</A></PRE>
678<DL>
679<DD>Reads a signed long (eight byte) value from the buffer.
680 Reads values that were written using <A HREF="../../../../com/sleepycat/bind/tuple/TupleOutput.html#writeLong(long)"><CODE>TupleOutput.writeLong(long)</CODE></A>.
681<P>
682<DD><DL>
683
684<DT><B>Returns:</B><DD>the value read from the buffer.
685<DT><B>Throws:</B>
686<DD><CODE><A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/IndexOutOfBoundsException.html?is-external=true" title="class or interface in java.lang">IndexOutOfBoundsException</A></CODE> - if not enough bytes are available in
687 the buffer.</DL>
688</DD>
689</DL>
690<HR>
691
692<A NAME="readFloat()"><!-- --></A><H3>
693readFloat</H3>
694<PRE>
695public final float <B>readFloat</B>()
696                      throws <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/IndexOutOfBoundsException.html?is-external=true" title="class or interface in java.lang">IndexOutOfBoundsException</A></PRE>
697<DL>
698<DD>Reads a signed float (four byte) value from the buffer.
699 Reads values that were written using <A HREF="../../../../com/sleepycat/bind/tuple/TupleOutput.html#writeFloat(float)"><CODE>TupleOutput.writeFloat(float)</CODE></A>.
700 <code>Float.intBitsToFloat</code> is used to convert the signed int
701 value.
702
703 <p><em>Note:</em> This method operations on byte array values that by
704 default (without a custom comparator) do <em>not</em> sort correctly for
705 negative values.  Only non-negative values are sorted correctly by
706 default.  To sort all values correctly by default, use <A HREF="../../../../com/sleepycat/bind/tuple/TupleInput.html#readSortedFloat()"><CODE>readSortedFloat()</CODE></A>.</p>
707<P>
708<DD><DL>
709
710<DT><B>Returns:</B><DD>the value read from the buffer.
711<DT><B>Throws:</B>
712<DD><CODE><A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/IndexOutOfBoundsException.html?is-external=true" title="class or interface in java.lang">IndexOutOfBoundsException</A></CODE> - if not enough bytes are available in
713 the buffer.</DL>
714</DD>
715</DL>
716<HR>
717
718<A NAME="readDouble()"><!-- --></A><H3>
719readDouble</H3>
720<PRE>
721public final double <B>readDouble</B>()
722                        throws <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/IndexOutOfBoundsException.html?is-external=true" title="class or interface in java.lang">IndexOutOfBoundsException</A></PRE>
723<DL>
724<DD>Reads a signed double (eight byte) value from the buffer.
725 Reads values that were written using <A HREF="../../../../com/sleepycat/bind/tuple/TupleOutput.html#writeDouble(double)"><CODE>TupleOutput.writeDouble(double)</CODE></A>.
726 <code>Double.longBitsToDouble</code> is used to convert the signed long
727 value.
728
729 <p><em>Note:</em> This method operations on byte array values that by
730 default (without a custom comparator) do <em>not</em> sort correctly for
731 negative values.  Only non-negative values are sorted correctly by
732 default.  To sort all values correctly by default, use <A HREF="../../../../com/sleepycat/bind/tuple/TupleInput.html#readSortedDouble()"><CODE>readSortedDouble()</CODE></A>.</p>
733<P>
734<DD><DL>
735
736<DT><B>Returns:</B><DD>the value read from the buffer.
737<DT><B>Throws:</B>
738<DD><CODE><A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/IndexOutOfBoundsException.html?is-external=true" title="class or interface in java.lang">IndexOutOfBoundsException</A></CODE> - if not enough bytes are available in
739 the buffer.</DL>
740</DD>
741</DL>
742<HR>
743
744<A NAME="readSortedFloat()"><!-- --></A><H3>
745readSortedFloat</H3>
746<PRE>
747public final float <B>readSortedFloat</B>()
748                            throws <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/IndexOutOfBoundsException.html?is-external=true" title="class or interface in java.lang">IndexOutOfBoundsException</A></PRE>
749<DL>
750<DD>Reads a signed float (four byte) value from the buffer, with support
751 for correct default sorting of all values.
752 Reads values that were written using <A HREF="../../../../com/sleepycat/bind/tuple/TupleOutput.html#writeSortedFloat(float)"><CODE>TupleOutput.writeSortedFloat(float)</CODE></A>.
753
754 <p><code>Float.intBitsToFloat</code> and the following bit
755 manipulations are used to convert the stored representation to a signed
756 float value.</p>
757 <pre>
758  int val = ... // get stored bits
759  val ^= (val &lt; 0) ? 0x80000000 : 0xffffffff;
760  return Float.intBitsToFloat(val);
761 </pre>
762<P>
763<DD><DL>
764
765<DT><B>Returns:</B><DD>the value read from the buffer.
766<DT><B>Throws:</B>
767<DD><CODE><A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/IndexOutOfBoundsException.html?is-external=true" title="class or interface in java.lang">IndexOutOfBoundsException</A></CODE> - if not enough bytes are available in
768 the buffer.</DL>
769</DD>
770</DL>
771<HR>
772
773<A NAME="readSortedDouble()"><!-- --></A><H3>
774readSortedDouble</H3>
775<PRE>
776public final double <B>readSortedDouble</B>()
777                              throws <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/IndexOutOfBoundsException.html?is-external=true" title="class or interface in java.lang">IndexOutOfBoundsException</A></PRE>
778<DL>
779<DD>Reads a signed double (eight byte) value from the buffer, with support
780 for correct default sorting of all values.
781 Reads values that were written using <A HREF="../../../../com/sleepycat/bind/tuple/TupleOutput.html#writeSortedDouble(double)"><CODE>TupleOutput.writeSortedDouble(double)</CODE></A>.
782
783 <p><code>Float.longBitsToDouble</code> and the following bit
784 manipulations are used to convert the stored representation to a signed
785 double value.</p>
786 <pre>
787  int val = ... // get stored bits
788        val ^= (val &lt; 0) ? 0x8000000000000000L : 0xffffffffffffffffL;
789        return Double.longBitsToDouble(val);
790 </pre>
791<P>
792<DD><DL>
793
794<DT><B>Returns:</B><DD>the value read from the buffer.
795<DT><B>Throws:</B>
796<DD><CODE><A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/IndexOutOfBoundsException.html?is-external=true" title="class or interface in java.lang">IndexOutOfBoundsException</A></CODE> - if not enough bytes are available in
797 the buffer.</DL>
798</DD>
799</DL>
800<HR>
801
802<A NAME="readUnsignedByte()"><!-- --></A><H3>
803readUnsignedByte</H3>
804<PRE>
805public final int <B>readUnsignedByte</B>()
806                           throws <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/IndexOutOfBoundsException.html?is-external=true" title="class or interface in java.lang">IndexOutOfBoundsException</A></PRE>
807<DL>
808<DD>Reads an unsigned byte (one byte) value from the buffer.
809 Reads values that were written using <A HREF="../../../../com/sleepycat/bind/tuple/TupleOutput.html#writeUnsignedByte(int)"><CODE>TupleOutput.writeUnsignedByte(int)</CODE></A>.
810<P>
811<DD><DL>
812
813<DT><B>Returns:</B><DD>the value read from the buffer.
814<DT><B>Throws:</B>
815<DD><CODE><A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/IndexOutOfBoundsException.html?is-external=true" title="class or interface in java.lang">IndexOutOfBoundsException</A></CODE> - if not enough bytes are available in
816 the buffer.</DL>
817</DD>
818</DL>
819<HR>
820
821<A NAME="readUnsignedShort()"><!-- --></A><H3>
822readUnsignedShort</H3>
823<PRE>
824public final int <B>readUnsignedShort</B>()
825                            throws <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/IndexOutOfBoundsException.html?is-external=true" title="class or interface in java.lang">IndexOutOfBoundsException</A></PRE>
826<DL>
827<DD>Reads an unsigned short (two byte) value from the buffer.
828 Reads values that were written using <A HREF="../../../../com/sleepycat/bind/tuple/TupleOutput.html#writeUnsignedShort(int)"><CODE>TupleOutput.writeUnsignedShort(int)</CODE></A>.
829<P>
830<DD><DL>
831
832<DT><B>Returns:</B><DD>the value read from the buffer.
833<DT><B>Throws:</B>
834<DD><CODE><A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/IndexOutOfBoundsException.html?is-external=true" title="class or interface in java.lang">IndexOutOfBoundsException</A></CODE> - if not enough bytes are available in
835 the buffer.</DL>
836</DD>
837</DL>
838<HR>
839
840<A NAME="readUnsignedInt()"><!-- --></A><H3>
841readUnsignedInt</H3>
842<PRE>
843public final long <B>readUnsignedInt</B>()
844                           throws <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/IndexOutOfBoundsException.html?is-external=true" title="class or interface in java.lang">IndexOutOfBoundsException</A></PRE>
845<DL>
846<DD>Reads an unsigned int (four byte) value from the buffer.
847 Reads values that were written using <A HREF="../../../../com/sleepycat/bind/tuple/TupleOutput.html#writeUnsignedInt(long)"><CODE>TupleOutput.writeUnsignedInt(long)</CODE></A>.
848<P>
849<DD><DL>
850
851<DT><B>Returns:</B><DD>the value read from the buffer.
852<DT><B>Throws:</B>
853<DD><CODE><A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/IndexOutOfBoundsException.html?is-external=true" title="class or interface in java.lang">IndexOutOfBoundsException</A></CODE> - if not enough bytes are available in
854 the buffer.</DL>
855</DD>
856</DL>
857<HR>
858
859<A NAME="readBytes(int)"><!-- --></A><H3>
860readBytes</H3>
861<PRE>
862public final <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> <B>readBytes</B>(int&nbsp;length)
863                       throws <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/IndexOutOfBoundsException.html?is-external=true" title="class or interface in java.lang">IndexOutOfBoundsException</A></PRE>
864<DL>
865<DD>Reads the specified number of bytes from the buffer, converting each
866 unsigned byte value to a character of the resulting string.
867 Reads values that were written using <A HREF="../../../../com/sleepycat/bind/tuple/TupleOutput.html#writeBytes(java.lang.String)"><CODE>TupleOutput.writeBytes(java.lang.String)</CODE></A>.
868 Only characters with values below 0x100 may be read using this method.
869<P>
870<DD><DL>
871<DT><B>Parameters:</B><DD><CODE>length</CODE> - is the number of bytes to be read.
872<DT><B>Returns:</B><DD>the value read from the buffer.
873<DT><B>Throws:</B>
874<DD><CODE><A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/IndexOutOfBoundsException.html?is-external=true" title="class or interface in java.lang">IndexOutOfBoundsException</A></CODE> - if not enough bytes are available in
875 the buffer.</DL>
876</DD>
877</DL>
878<HR>
879
880<A NAME="readChars(int)"><!-- --></A><H3>
881readChars</H3>
882<PRE>
883public final <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> <B>readChars</B>(int&nbsp;length)
884                       throws <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/IndexOutOfBoundsException.html?is-external=true" title="class or interface in java.lang">IndexOutOfBoundsException</A></PRE>
885<DL>
886<DD>Reads the specified number of characters from the buffer, converting
887 each two byte unsigned value to a character of the resulting string.
888 Reads values that were written using <A HREF="../../../../com/sleepycat/bind/tuple/TupleOutput.html#writeChars(java.lang.String)"><CODE>TupleOutput.writeChars(java.lang.String)</CODE></A>.
889<P>
890<DD><DL>
891<DT><B>Parameters:</B><DD><CODE>length</CODE> - is the number of characters to be read.
892<DT><B>Returns:</B><DD>the value read from the buffer.
893<DT><B>Throws:</B>
894<DD><CODE><A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/IndexOutOfBoundsException.html?is-external=true" title="class or interface in java.lang">IndexOutOfBoundsException</A></CODE> - if not enough bytes are available in
895 the buffer.</DL>
896</DD>
897</DL>
898<HR>
899
900<A NAME="readBytes(char[])"><!-- --></A><H3>
901readBytes</H3>
902<PRE>
903public final void <B>readBytes</B>(char[]&nbsp;chars)
904                     throws <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/IndexOutOfBoundsException.html?is-external=true" title="class or interface in java.lang">IndexOutOfBoundsException</A></PRE>
905<DL>
906<DD>Reads the specified number of bytes from the buffer, converting each
907 unsigned byte value to a character of the resulting array.
908 Reads values that were written using <A HREF="../../../../com/sleepycat/bind/tuple/TupleOutput.html#writeBytes(java.lang.String)"><CODE>TupleOutput.writeBytes(java.lang.String)</CODE></A>.
909 Only characters with values below 0x100 may be read using this method.
910<P>
911<DD><DL>
912<DT><B>Parameters:</B><DD><CODE>chars</CODE> - is the array to receive the data and whose length is used
913 to determine the number of bytes to be read.
914<DT><B>Throws:</B>
915<DD><CODE><A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/IndexOutOfBoundsException.html?is-external=true" title="class or interface in java.lang">IndexOutOfBoundsException</A></CODE> - if not enough bytes are available in
916 the buffer.</DL>
917</DD>
918</DL>
919<HR>
920
921<A NAME="readChars(char[])"><!-- --></A><H3>
922readChars</H3>
923<PRE>
924public final void <B>readChars</B>(char[]&nbsp;chars)
925                     throws <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/IndexOutOfBoundsException.html?is-external=true" title="class or interface in java.lang">IndexOutOfBoundsException</A></PRE>
926<DL>
927<DD>Reads the specified number of characters from the buffer, converting
928 each two byte unsigned value to a character of the resulting array.
929 Reads values that were written using <A HREF="../../../../com/sleepycat/bind/tuple/TupleOutput.html#writeChars(java.lang.String)"><CODE>TupleOutput.writeChars(java.lang.String)</CODE></A>.
930<P>
931<DD><DL>
932<DT><B>Parameters:</B><DD><CODE>chars</CODE> - is the array to receive the data and whose length is used
933 to determine the number of characters to be read.
934<DT><B>Throws:</B>
935<DD><CODE><A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/IndexOutOfBoundsException.html?is-external=true" title="class or interface in java.lang">IndexOutOfBoundsException</A></CODE> - if not enough bytes are available in
936 the buffer.</DL>
937</DD>
938</DL>
939<HR>
940
941<A NAME="readString(int)"><!-- --></A><H3>
942readString</H3>
943<PRE>
944public final <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> <B>readString</B>(int&nbsp;length)
945                        throws <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/IndexOutOfBoundsException.html?is-external=true" title="class or interface in java.lang">IndexOutOfBoundsException</A>,
946                               <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/IllegalArgumentException.html?is-external=true" title="class or interface in java.lang">IllegalArgumentException</A></PRE>
947<DL>
948<DD>Reads the specified number of UTF characters string from the data
949 buffer and converts the data from UTF to Unicode.
950 Reads values that were written using <A HREF="../../../../com/sleepycat/bind/tuple/TupleOutput.html#writeString(char[])"><CODE>TupleOutput.writeString(char[])</CODE></A>.
951<P>
952<DD><DL>
953<DT><B>Parameters:</B><DD><CODE>length</CODE> - is the number of characters to be read.
954<DT><B>Returns:</B><DD>the converted string.
955<DT><B>Throws:</B>
956<DD><CODE><A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/IndexOutOfBoundsException.html?is-external=true" title="class or interface in java.lang">IndexOutOfBoundsException</A></CODE> - if no null terminating byte is found
957 in the buffer.
958<DD><CODE><A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/IllegalArgumentException.html?is-external=true" title="class or interface in java.lang">IllegalArgumentException</A></CODE> - malformed UTF data is encountered.</DL>
959</DD>
960</DL>
961<HR>
962
963<A NAME="readString(char[])"><!-- --></A><H3>
964readString</H3>
965<PRE>
966public final void <B>readString</B>(char[]&nbsp;chars)
967                      throws <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/IndexOutOfBoundsException.html?is-external=true" title="class or interface in java.lang">IndexOutOfBoundsException</A>,
968                             <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/IllegalArgumentException.html?is-external=true" title="class or interface in java.lang">IllegalArgumentException</A></PRE>
969<DL>
970<DD>Reads the specified number of UTF characters string from the data
971 buffer and converts the data from UTF to Unicode.
972 Reads values that were written using <A HREF="../../../../com/sleepycat/bind/tuple/TupleOutput.html#writeString(char[])"><CODE>TupleOutput.writeString(char[])</CODE></A>.
973<P>
974<DD><DL>
975<DT><B>Parameters:</B><DD><CODE>chars</CODE> - is the array to receive the data and whose length is used
976 to determine the number of characters to be read.
977<DT><B>Throws:</B>
978<DD><CODE><A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/IndexOutOfBoundsException.html?is-external=true" title="class or interface in java.lang">IndexOutOfBoundsException</A></CODE> - if no null terminating byte is found
979 in the buffer.
980<DD><CODE><A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/IllegalArgumentException.html?is-external=true" title="class or interface in java.lang">IllegalArgumentException</A></CODE> - malformed UTF data is encountered.</DL>
981</DD>
982</DL>
983<HR>
984
985<A NAME="getStringByteLength()"><!-- --></A><H3>
986getStringByteLength</H3>
987<PRE>
988public final int <B>getStringByteLength</B>()
989                              throws <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/IndexOutOfBoundsException.html?is-external=true" title="class or interface in java.lang">IndexOutOfBoundsException</A>,
990                                     <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/IllegalArgumentException.html?is-external=true" title="class or interface in java.lang">IllegalArgumentException</A></PRE>
991<DL>
992<DD>Returns the byte length of a null-terminated UTF string in the data
993 buffer, including the terminator.  Used with string values that were
994 written using <A HREF="../../../../com/sleepycat/bind/tuple/TupleOutput.html#writeString(java.lang.String)"><CODE>TupleOutput.writeString(String)</CODE></A>.
995<P>
996<DD><DL>
997
998<DT><B>Throws:</B>
999<DD><CODE><A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/IndexOutOfBoundsException.html?is-external=true" title="class or interface in java.lang">IndexOutOfBoundsException</A></CODE> - if no null terminating byte is found
1000 in the buffer.
1001<DD><CODE><A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/IllegalArgumentException.html?is-external=true" title="class or interface in java.lang">IllegalArgumentException</A></CODE> - malformed UTF data is encountered.</DL>
1002</DD>
1003</DL>
1004<HR>
1005
1006<A NAME="readPackedInt()"><!-- --></A><H3>
1007readPackedInt</H3>
1008<PRE>
1009public final int <B>readPackedInt</B>()</PRE>
1010<DL>
1011<DD>Reads a packed integer.  Note that packed integers are not appropriate
1012 for sorted values (keys) unless a custom comparator is used.
1013<P>
1014<DD><DL>
1015<DT><B>See Also:</B><DD><A HREF="../../../../com/sleepycat/util/PackedInteger.html" title="class in com.sleepycat.util"><CODE>PackedInteger</CODE></A></DL>
1016</DD>
1017</DL>
1018<HR>
1019
1020<A NAME="getPackedIntByteLength()"><!-- --></A><H3>
1021getPackedIntByteLength</H3>
1022<PRE>
1023public final int <B>getPackedIntByteLength</B>()</PRE>
1024<DL>
1025<DD>Returns the byte length of a packed integer.
1026<P>
1027<DD><DL>
1028<DT><B>See Also:</B><DD><A HREF="../../../../com/sleepycat/util/PackedInteger.html" title="class in com.sleepycat.util"><CODE>PackedInteger</CODE></A></DL>
1029</DD>
1030</DL>
1031<HR>
1032
1033<A NAME="readPackedLong()"><!-- --></A><H3>
1034readPackedLong</H3>
1035<PRE>
1036public final long <B>readPackedLong</B>()</PRE>
1037<DL>
1038<DD>Reads a packed long integer.  Note that packed integers are not
1039 appropriate for sorted values (keys) unless a custom comparator is used.
1040<P>
1041<DD><DL>
1042<DT><B>See Also:</B><DD><A HREF="../../../../com/sleepycat/util/PackedInteger.html" title="class in com.sleepycat.util"><CODE>PackedInteger</CODE></A></DL>
1043</DD>
1044</DL>
1045<HR>
1046
1047<A NAME="getPackedLongByteLength()"><!-- --></A><H3>
1048getPackedLongByteLength</H3>
1049<PRE>
1050public final int <B>getPackedLongByteLength</B>()</PRE>
1051<DL>
1052<DD>Returns the byte length of a packed long integer.
1053<P>
1054<DD><DL>
1055<DT><B>See Also:</B><DD><A HREF="../../../../com/sleepycat/util/PackedInteger.html" title="class in com.sleepycat.util"><CODE>PackedInteger</CODE></A></DL>
1056</DD>
1057</DL>
1058<HR>
1059
1060<A NAME="readBigInteger()"><!-- --></A><H3>
1061readBigInteger</H3>
1062<PRE>
1063public final <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/math/BigInteger.html?is-external=true" title="class or interface in java.math">BigInteger</A> <B>readBigInteger</B>()</PRE>
1064<DL>
1065<DD>Reads a <code>BigInteger</code>.
1066<P>
1067<DD><DL>
1068<DT><B>See Also:</B><DD><A HREF="../../../../com/sleepycat/bind/tuple/TupleOutput.html#writeBigInteger(java.math.BigInteger)"><CODE>TupleOutput.writeBigInteger(java.math.BigInteger)</CODE></A></DL>
1069</DD>
1070</DL>
1071<HR>
1072
1073<A NAME="getBigIntegerByteLength()"><!-- --></A><H3>
1074getBigIntegerByteLength</H3>
1075<PRE>
1076public final int <B>getBigIntegerByteLength</B>()</PRE>
1077<DL>
1078<DD>Returns the byte length of a <code>BigInteger</code>.
1079<P>
1080<DD><DL>
1081<DT><B>See Also:</B><DD><A HREF="../../../../com/sleepycat/bind/tuple/TupleOutput.html#writeBigInteger(java.math.BigInteger)"><CODE>TupleOutput.writeBigInteger(java.math.BigInteger)</CODE></A></DL>
1082</DD>
1083</DL>
1084<!-- ========= END OF CLASS DATA ========= -->
1085<HR>
1086
1087
1088<!-- ======= START OF BOTTOM NAVBAR ====== -->
1089<A NAME="navbar_bottom"><!-- --></A>
1090<A HREF="#skip-navbar_bottom" title="Skip navigation links"></A>
1091<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
1092<TR>
1093<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
1094<A NAME="navbar_bottom_firstrow"><!-- --></A>
1095<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
1096  <TR ALIGN="center" VALIGN="top">
1097  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>
1098  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
1099  <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
1100  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="class-use/TupleInput.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A>&nbsp;</TD>
1101  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
1102  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>
1103  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
1104  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
1105  </TR>
1106</TABLE>
1107</TD>
1108<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
1109<b>Berkeley DB</b><br><font size="-1"> version 4.8.30</font></EM>
1110</TD>
1111</TR>
1112
1113<TR>
1114<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
1115&nbsp;<A HREF="../../../../com/sleepycat/bind/tuple/TupleBinding.html" title="class in com.sleepycat.bind.tuple"><B>PREV CLASS</B></A>&nbsp;
1116&nbsp;<A HREF="../../../../com/sleepycat/bind/tuple/TupleInputBinding.html" title="class in com.sleepycat.bind.tuple"><B>NEXT CLASS</B></A></FONT></TD>
1117<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
1118  <A HREF="../../../../index.html?com/sleepycat/bind/tuple/TupleInput.html" target="_top"><B>FRAMES</B></A>  &nbsp;
1119&nbsp;<A HREF="TupleInput.html" target="_top"><B>NO FRAMES</B></A>  &nbsp;
1120&nbsp;<SCRIPT type="text/javascript">
1121  <!--
1122  if(window==top) {
1123    document.writeln('<A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>');
1124  }
1125  //-->
1126</SCRIPT>
1127<NOSCRIPT>
1128  <A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>
1129</NOSCRIPT>
1130
1131
1132</FONT></TD>
1133</TR>
1134<TR>
1135<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
1136  SUMMARY:&nbsp;NESTED&nbsp;|&nbsp;<A HREF="#fields_inherited_from_class_com.sleepycat.util.FastInputStream">FIELD</A>&nbsp;|&nbsp;<A HREF="#constructor_summary">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>
1137<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
1138DETAIL:&nbsp;FIELD&nbsp;|&nbsp;<A HREF="#constructor_detail">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></FONT></TD>
1139</TR>
1140</TABLE>
1141<A NAME="skip-navbar_bottom"></A>
1142<!-- ======== END OF BOTTOM NAVBAR ======= -->
1143
1144<HR>
1145<font size=1>Copyright (c) 1996-2009 Oracle.  All rights reserved.</font>
1146</BODY>
1147</HTML>
1148