<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN""http://www.w3.org/TR/REC-html40/loose.dtd">
<!--NewPage-->
<HTML>
<HEAD>
<!-- Generated by javadoc on Wed Dec 03 16:22:07 EST 2003 -->
<TITLE>
TupleInput (Sleepycat Software, Inc. - Berkeley DB Java API)
</TITLE>
<META NAME="keywords" CONTENT="com.sleepycat.bdb.bind.tuple.TupleInput,TupleInput class">
<LINK REL ="stylesheet" TYPE="text/css" HREF="../../../../../style.css" TITLE="Style">
</HEAD>
<SCRIPT>
function asd()
{
parent.document.title="TupleInput (Sleepycat Software, Inc. - Berkeley DB Java API)";
}
</SCRIPT>
<BODY BGCOLOR="white" onload="asd();">
<!-- ========== START OF NAVBAR ========== -->
<A NAME="navbar_top"><!-- --></A>
<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0">
<TR>
<TD COLSPAN=3 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
<A NAME="navbar_top_firstrow"><!-- --></A>
<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3">
<TR ALIGN="center" VALIGN="top">
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD>
<TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="class-use/TupleInput.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD>
</TR>
</TABLE>
</TD>
<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
<b>Berkeley DB</b><br><font size="-1"> version 4.2.52</font></EM>
</TD>
</TR>
<TR>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
<A HREF="../../../../../com/sleepycat/bdb/bind/tuple/TupleFormat.html"><B>PREV CLASS</B></A>
<A HREF="../../../../../com/sleepycat/bdb/bind/tuple/TupleInputBinding.html"><B>NEXT CLASS</B></A></FONT></TD>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
<A HREF="../../../../../index.html" TARGET="_top"><B>FRAMES</B></A>
<A HREF="TupleInput.html" TARGET="_top"><B>NO FRAMES</B></A>
<SCRIPT>
<!--
if(window==top) {
document.writeln('<A HREF="../../../../../allclasses-noframe.html" TARGET=""><B>All Classes</B></A>');
}
</SCRIPT>
<NOSCRIPT>
<A HREF="../../../../../allclasses-noframe.html" TARGET=""><B>All Classes</B></A>
</NOSCRIPT>
</FONT></TD>
</TR>
<TR>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
SUMMARY: NESTED | FIELD | <A HREF="#constructor_summary">CONSTR</A> | <A HREF="#method_summary">METHOD</A></FONT></TD>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
DETAIL: FIELD | <A HREF="#constructor_detail">CONSTR</A> | <A HREF="#method_detail">METHOD</A></FONT></TD>
</TR>
</TABLE>
<!-- =========== END OF NAVBAR =========== -->
<HR>
<!-- ======== START OF CLASS DATA ======== -->
<H2>
<FONT SIZE="-1">
com.sleepycat.bdb.bind.tuple</FONT>
<BR>
Class TupleInput</H2>
<PRE>
<A HREF="http://java.sun.com/j2se/1.3/docs/api/java/lang/Object.html">java.lang.Object</A>
|
+--<A HREF="http://java.sun.com/j2se/1.3/docs/api/java/io/InputStream.html">java.io.InputStream</A>
|
+--<A HREF="../../../../../com/sleepycat/bdb/util/FastInputStream.html">com.sleepycat.bdb.util.FastInputStream</A>
|
+--<B>com.sleepycat.bdb.bind.tuple.TupleInput</B>
</PRE>
<HR>
<DL>
<DT>public class <B>TupleInput</B><DT>extends <A HREF="../../../../../com/sleepycat/bdb/util/FastInputStream.html">FastInputStream</A></DL>
<P>
Used by tuple bindings to read tuple data.
<p>This class has many methods that have the same signatures as methods in
the <A HREF="http://java.sun.com/j2se/1.3/docs/api/java/io/DataInput.html"><CODE>DataInput</CODE></A> interface. The reason this class does not
implement <A HREF="http://java.sun.com/j2se/1.3/docs/api/java/io/DataInput.html"><CODE>DataInput</CODE></A> 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.</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>
<p>Floats and doubles are stored in standard integer-bit representation and
are therefore not ordered by numeric value.</p>
<P>
<P>
<HR>
<P>
<!-- ======== NESTED CLASS SUMMARY ======== -->
<!-- =========== FIELD SUMMARY =========== -->
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
<A NAME="constructor_summary"><!-- --></A>
<TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TD COLSPAN=2><FONT SIZE="+2">
<B>Constructor Summary</B></FONT></TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD><CODE><B><A HREF="../../../../../com/sleepycat/bdb/bind/tuple/TupleInput.html#TupleInput(byte[])">TupleInput</A></B>(byte[] buffer)</CODE>
<BR>
Creates a tuple input object for reading a byte array of tuple data.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD><CODE><B><A HREF="../../../../../com/sleepycat/bdb/bind/tuple/TupleInput.html#TupleInput(byte[], int, int)">TupleInput</A></B>(byte[] buffer,
int offset,
int length)</CODE>
<BR>
Creates a tuple input object for reading a byte array of tuple data at
a given offset for a given length.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD><CODE><B><A HREF="../../../../../com/sleepycat/bdb/bind/tuple/TupleInput.html#TupleInput(com.sleepycat.bdb.bind.tuple.TupleOutput)">TupleInput</A></B>(<A HREF="../../../../../com/sleepycat/bdb/bind/tuple/TupleOutput.html">TupleOutput</A> output)</CODE>
<BR>
Creates a tuple input object from the data contained in a tuple output
object.</TD>
</TR>
</TABLE>
<!-- ========== METHOD SUMMARY =========== -->
<A NAME="method_summary"><!-- --></A>
<TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TD COLSPAN=2><FONT SIZE="+2">
<B>Method Summary</B></FONT></TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> boolean</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../../com/sleepycat/bdb/bind/tuple/TupleInput.html#readBoolean()">readBoolean</A></B>()</CODE>
<BR>
Reads a boolean (one byte) unsigned value from the buffer and returns
true if it is non-zero and false if it is zero.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> byte</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../../com/sleepycat/bdb/bind/tuple/TupleInput.html#readByte()">readByte</A></B>()</CODE>
<BR>
Reads a signed byte (one byte) value from the buffer.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> void</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../../com/sleepycat/bdb/bind/tuple/TupleInput.html#readBytes(char[])">readBytes</A></B>(char[] chars)</CODE>
<BR>
Reads the specified number of bytes from the buffer, converting each
unsigned byte value to a character of the resulting array.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> <A HREF="http://java.sun.com/j2se/1.3/docs/api/java/lang/String.html">String</A></CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../../com/sleepycat/bdb/bind/tuple/TupleInput.html#readBytes(int)">readBytes</A></B>(int length)</CODE>
<BR>
Reads the specified number of bytes from the buffer, converting each
unsigned byte value to a character of the resulting string.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> char</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../../com/sleepycat/bdb/bind/tuple/TupleInput.html#readChar()">readChar</A></B>()</CODE>
<BR>
Reads a char (two byte) unsigned value from the buffer.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> void</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../../com/sleepycat/bdb/bind/tuple/TupleInput.html#readChars(char[])">readChars</A></B>(char[] chars)</CODE>
<BR>
Reads the specified number of characters from the buffer, converting
each two byte unsigned value to a character of the resulting array.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> <A HREF="http://java.sun.com/j2se/1.3/docs/api/java/lang/String.html">String</A></CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../../com/sleepycat/bdb/bind/tuple/TupleInput.html#readChars(int)">readChars</A></B>(int length)</CODE>
<BR>
Reads the specified number of characters from the buffer, converting
each two byte unsigned value to a character of the resulting string.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> double</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../../com/sleepycat/bdb/bind/tuple/TupleInput.html#readDouble()">readDouble</A></B>()</CODE>
<BR>
Reads a signed double (eight byte) value from the buffer.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> float</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../../com/sleepycat/bdb/bind/tuple/TupleInput.html#readFloat()">readFloat</A></B>()</CODE>
<BR>
Reads a signed float (four byte) value from the buffer.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> int</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../../com/sleepycat/bdb/bind/tuple/TupleInput.html#readInt()">readInt</A></B>()</CODE>
<BR>
Reads a signed int (four byte) value from the buffer.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> long</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../../com/sleepycat/bdb/bind/tuple/TupleInput.html#readLong()">readLong</A></B>()</CODE>
<BR>
Reads a signed long (eight byte) value from the buffer.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> short</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../../com/sleepycat/bdb/bind/tuple/TupleInput.html#readShort()">readShort</A></B>()</CODE>
<BR>
Reads a signed short (two byte) value from the buffer.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> <A HREF="http://java.sun.com/j2se/1.3/docs/api/java/lang/String.html">String</A></CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../../com/sleepycat/bdb/bind/tuple/TupleInput.html#readString()">readString</A></B>()</CODE>
<BR>
Reads a null-terminated UTF string from the data buffer and converts
the data from UTF to Unicode.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> void</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../../com/sleepycat/bdb/bind/tuple/TupleInput.html#readString(char[])">readString</A></B>(char[] chars)</CODE>
<BR>
Reads the specified number of UTF characters string from the data
buffer and converts the data from UTF to Unicode.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> <A HREF="http://java.sun.com/j2se/1.3/docs/api/java/lang/String.html">String</A></CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../../com/sleepycat/bdb/bind/tuple/TupleInput.html#readString(int)">readString</A></B>(int length)</CODE>
<BR>
Reads the specified number of UTF characters string from the data
buffer and converts the data from UTF to Unicode.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> int</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../../com/sleepycat/bdb/bind/tuple/TupleInput.html#readUnsignedByte()">readUnsignedByte</A></B>()</CODE>
<BR>
Reads an unsigned byte (one byte) value from the buffer.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> long</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../../com/sleepycat/bdb/bind/tuple/TupleInput.html#readUnsignedInt()">readUnsignedInt</A></B>()</CODE>
<BR>
Reads an unsigned int (four byte) value from the buffer.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> int</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../../com/sleepycat/bdb/bind/tuple/TupleInput.html#readUnsignedShort()">readUnsignedShort</A></B>()</CODE>
<BR>
Reads an unsigned short (two byte) value from the buffer.</TD>
</TR>
</TABLE>
<A NAME="methods_inherited_from_class_com.sleepycat.bdb.util.FastInputStream"><!-- --></A>
<TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%">
<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
<TD><B>Methods inherited from class com.sleepycat.bdb.util.<A HREF="../../../../../com/sleepycat/bdb/util/FastInputStream.html">FastInputStream</A></B></TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD><CODE><A HREF="../../../../../com/sleepycat/bdb/util/FastInputStream.html#available()">available</A>, <A HREF="../../../../../com/sleepycat/bdb/util/FastInputStream.html#getBufferBytes()">getBufferBytes</A>, <A HREF="../../../../../com/sleepycat/bdb/util/FastInputStream.html#getBufferLength()">getBufferLength</A>, <A HREF="../../../../../com/sleepycat/bdb/util/FastInputStream.html#getBufferOffset()">getBufferOffset</A>, <A HREF="../../../../../com/sleepycat/bdb/util/FastInputStream.html#mark(int)">mark</A>, <A HREF="../../../../../com/sleepycat/bdb/util/FastInputStream.html#markSupported()">markSupported</A>, <A HREF="../../../../../com/sleepycat/bdb/util/FastInputStream.html#read()">read</A>, <A HREF="../../../../../com/sleepycat/bdb/util/FastInputStream.html#read(byte[])">read</A>, <A HREF="../../../../../com/sleepycat/bdb/util/FastInputStream.html#read(byte[], int, int)">read</A>, <A HREF="../../../../../com/sleepycat/bdb/util/FastInputStream.html#reset()">reset</A>, <A HREF="../../../../../com/sleepycat/bdb/util/FastInputStream.html#skip(long)">skip</A></CODE></TD>
</TR>
</TABLE>
<A NAME="methods_inherited_from_class_java.io.InputStream"><!-- --></A>
<TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%">
<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
<TD><B>Methods inherited from class java.io.<A HREF="http://java.sun.com/j2se/1.3/docs/api/java/io/InputStream.html">InputStream</A></B></TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD><CODE><A HREF="http://java.sun.com/j2se/1.3/docs/api/java/io/InputStream.html#close()">close</A></CODE></TD>
</TR>
</TABLE>
<A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A>
<TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%">
<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
<TD><B>Methods inherited from class java.lang.<A HREF="http://java.sun.com/j2se/1.3/docs/api/java/lang/Object.html">Object</A></B></TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD><CODE><A HREF="http://java.sun.com/j2se/1.3/docs/api/java/lang/Object.html#equals(java.lang.Object)">equals</A>, <A HREF="http://java.sun.com/j2se/1.3/docs/api/java/lang/Object.html#getClass()">getClass</A>, <A HREF="http://java.sun.com/j2se/1.3/docs/api/java/lang/Object.html#hashCode()">hashCode</A>, <A HREF="http://java.sun.com/j2se/1.3/docs/api/java/lang/Object.html#notify()">notify</A>, <A HREF="http://java.sun.com/j2se/1.3/docs/api/java/lang/Object.html#notifyAll()">notifyAll</A>, <A HREF="http://java.sun.com/j2se/1.3/docs/api/java/lang/Object.html#toString()">toString</A>, <A HREF="http://java.sun.com/j2se/1.3/docs/api/java/lang/Object.html#wait()">wait</A>, <A HREF="http://java.sun.com/j2se/1.3/docs/api/java/lang/Object.html#wait(long)">wait</A>, <A HREF="http://java.sun.com/j2se/1.3/docs/api/java/lang/Object.html#wait(long, int)">wait</A></CODE></TD>
</TR>
</TABLE>
<P>
<!-- ============ FIELD DETAIL =========== -->
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<A NAME="constructor_detail"><!-- --></A>
<TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TD COLSPAN=1><FONT SIZE="+2">
<B>Constructor Detail</B></FONT></TD>
</TR>
</TABLE>
<A NAME="TupleInput(byte[])"><!-- --></A><H3>
TupleInput</H3>
<PRE>
public <B>TupleInput</B>(byte[] buffer)</PRE>
<DL>
<DD>Creates a tuple input object for reading a byte array of tuple data. A
reference to the byte array will be kept by this object (it will not be
copied) and therefore the byte array should not be modified while this
object is in use.
<P>
<DT><B>Parameters:</B><DD><CODE>buffer</CODE> - is the byte array to be read and should contain data in
tuple format.</DL>
<HR>
<A NAME="TupleInput(byte[], int, int)"><!-- --></A><H3>
TupleInput</H3>
<PRE>
public <B>TupleInput</B>(byte[] buffer,
int offset,
int length)</PRE>
<DL>
<DD>Creates a tuple input object for reading a byte array of tuple data at
a given offset for a given length. A reference to the byte array will
be kept by this object (it will not be copied) and therefore the byte
array should not be modified while this object is in use.
<P>
<DT><B>Parameters:</B><DD><CODE>buffer</CODE> - is the byte array to be read and should contain data in
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>
<HR>
<A NAME="TupleInput(com.sleepycat.bdb.bind.tuple.TupleOutput)"><!-- --></A><H3>
TupleInput</H3>
<PRE>
public <B>TupleInput</B>(<A HREF="../../../../../com/sleepycat/bdb/bind/tuple/TupleOutput.html">TupleOutput</A> output)</PRE>
<DL>
<DD>Creates a tuple input object from the data contained in a tuple output
object. A reference to the tuple output's byte array will be kept by
this object (it will not be copied) and therefore the tuple output
object should not be modified while this object is in use.
<P>
<DT><B>Parameters:</B><DD><CODE>output</CODE> - is the tuple output object containing the data to be read.</DL>
<!-- ============ METHOD DETAIL ========== -->
<A NAME="method_detail"><!-- --></A>
<TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TD COLSPAN=1><FONT SIZE="+2">
<B>Method Detail</B></FONT></TD>
</TR>
</TABLE>
<A NAME="readString()"><!-- --></A><H3>
readString</H3>
<PRE>
public final <A HREF="http://java.sun.com/j2se/1.3/docs/api/java/lang/String.html">String</A> <B>readString</B>()
throws <A HREF="http://java.sun.com/j2se/1.3/docs/api/java/io/IOException.html">IOException</A></PRE>
<DL>
<DD>Reads a null-terminated UTF string from the data buffer and converts
the data from UTF to Unicode.
Reads values that were written using <A HREF="../../../../../com/sleepycat/bdb/bind/tuple/TupleOutput.html#writeString(java.lang.String)"><CODE>TupleOutput.writeString(String)</CODE></A>.
<P>
<DD><DL>
<DT><B>Returns:</B><DD>the converted string.
<DT><B>Throws:</B>
<DD><CODE><A HREF="http://java.sun.com/j2se/1.3/docs/api/java/io/IOException.html">IOException</A></CODE> - if no null terminating byte is found in the buffer
or malformed UTF data is encountered.</DL>
</DD>
</DL>
<HR>
<A NAME="readChar()"><!-- --></A><H3>
readChar</H3>
<PRE>
public final char <B>readChar</B>()
throws <A HREF="http://java.sun.com/j2se/1.3/docs/api/java/io/IOException.html">IOException</A></PRE>
<DL>
<DD>Reads a char (two byte) unsigned value from the buffer.
Reads values that were written using <A HREF="../../../../../com/sleepycat/bdb/bind/tuple/TupleOutput.html#writeChar(int)"><CODE>TupleOutput.writeChar(int)</CODE></A>.
<P>
<DD><DL>
<DT><B>Returns:</B><DD>the value read from the buffer.
<DT><B>Throws:</B>
<DD><CODE><A HREF="http://java.sun.com/j2se/1.3/docs/api/java/io/IOException.html">IOException</A></CODE> - if not enough bytes are available in the buffer.</DL>
</DD>
</DL>
<HR>
<A NAME="readBoolean()"><!-- --></A><H3>
readBoolean</H3>
<PRE>
public final boolean <B>readBoolean</B>()
throws <A HREF="http://java.sun.com/j2se/1.3/docs/api/java/io/IOException.html">IOException</A></PRE>
<DL>
<DD>Reads a boolean (one byte) unsigned value from the buffer and returns
true if it is non-zero and false if it is zero.
Reads values that were written using <A HREF="../../../../../com/sleepycat/bdb/bind/tuple/TupleOutput.html#writeBoolean(boolean)"><CODE>TupleOutput.writeBoolean(boolean)</CODE></A>.
<P>
<DD><DL>
<DT><B>Returns:</B><DD>the value read from the buffer.
<DT><B>Throws:</B>
<DD><CODE><A HREF="http://java.sun.com/j2se/1.3/docs/api/java/io/IOException.html">IOException</A></CODE> - if not enough bytes are available in the buffer.</DL>
</DD>
</DL>
<HR>
<A NAME="readByte()"><!-- --></A><H3>
readByte</H3>
<PRE>
public final byte <B>readByte</B>()
throws <A HREF="http://java.sun.com/j2se/1.3/docs/api/java/io/IOException.html">IOException</A></PRE>
<DL>
<DD>Reads a signed byte (one byte) value from the buffer.
Reads values that were written using <A HREF="../../../../../com/sleepycat/bdb/bind/tuple/TupleOutput.html#writeByte(int)"><CODE>TupleOutput.writeByte(int)</CODE></A>.
<P>
<DD><DL>
<DT><B>Returns:</B><DD>the value read from the buffer.
<DT><B>Throws:</B>
<DD><CODE><A HREF="http://java.sun.com/j2se/1.3/docs/api/java/io/IOException.html">IOException</A></CODE> - if not enough bytes are available in the buffer.</DL>
</DD>
</DL>
<HR>
<A NAME="readShort()"><!-- --></A><H3>
readShort</H3>
<PRE>
public final short <B>readShort</B>()
throws <A HREF="http://java.sun.com/j2se/1.3/docs/api/java/io/IOException.html">IOException</A></PRE>
<DL>
<DD>Reads a signed short (two byte) value from the buffer.
Reads values that were written using <A HREF="../../../../../com/sleepycat/bdb/bind/tuple/TupleOutput.html#writeShort(int)"><CODE>TupleOutput.writeShort(int)</CODE></A>.
<P>
<DD><DL>
<DT><B>Returns:</B><DD>the value read from the buffer.
<DT><B>Throws:</B>
<DD><CODE><A HREF="http://java.sun.com/j2se/1.3/docs/api/java/io/IOException.html">IOException</A></CODE> - if not enough bytes are available in the buffer.</DL>
</DD>
</DL>
<HR>
<A NAME="readInt()"><!-- --></A><H3>
readInt</H3>
<PRE>
public final int <B>readInt</B>()
throws <A HREF="http://java.sun.com/j2se/1.3/docs/api/java/io/IOException.html">IOException</A></PRE>
<DL>
<DD>Reads a signed int (four byte) value from the buffer.
Reads values that were written using <A HREF="../../../../../com/sleepycat/bdb/bind/tuple/TupleOutput.html#writeInt(int)"><CODE>TupleOutput.writeInt(int)</CODE></A>.
<P>
<DD><DL>
<DT><B>Returns:</B><DD>the value read from the buffer.
<DT><B>Throws:</B>
<DD><CODE><A HREF="http://java.sun.com/j2se/1.3/docs/api/java/io/IOException.html">IOException</A></CODE> - if not enough bytes are available in the buffer.</DL>
</DD>
</DL>
<HR>
<A NAME="readLong()"><!-- --></A><H3>
readLong</H3>
<PRE>
public final long <B>readLong</B>()
throws <A HREF="http://java.sun.com/j2se/1.3/docs/api/java/io/IOException.html">IOException</A></PRE>
<DL>
<DD>Reads a signed long (eight byte) value from the buffer.
Reads values that were written using <A HREF="../../../../../com/sleepycat/bdb/bind/tuple/TupleOutput.html#writeLong(long)"><CODE>TupleOutput.writeLong(long)</CODE></A>.
<P>
<DD><DL>
<DT><B>Returns:</B><DD>the value read from the buffer.
<DT><B>Throws:</B>
<DD><CODE><A HREF="http://java.sun.com/j2se/1.3/docs/api/java/io/IOException.html">IOException</A></CODE> - if not enough bytes are available in the buffer.</DL>
</DD>
</DL>
<HR>
<A NAME="readFloat()"><!-- --></A><H3>
readFloat</H3>
<PRE>
public final float <B>readFloat</B>()
throws <A HREF="http://java.sun.com/j2se/1.3/docs/api/java/io/IOException.html">IOException</A></PRE>
<DL>
<DD>Reads a signed float (four byte) value from the buffer.
Reads values that were written using <A HREF="../../../../../com/sleepycat/bdb/bind/tuple/TupleOutput.html#writeFloat(float)"><CODE>TupleOutput.writeFloat(float)</CODE></A>.
<code>Float.intBitsToFloat</code> is used to convert the signed int
value.
<P>
<DD><DL>
<DT><B>Returns:</B><DD>the value read from the buffer.
<DT><B>Throws:</B>
<DD><CODE><A HREF="http://java.sun.com/j2se/1.3/docs/api/java/io/IOException.html">IOException</A></CODE> - if not enough bytes are available in the buffer.</DL>
</DD>
</DL>
<HR>
<A NAME="readDouble()"><!-- --></A><H3>
readDouble</H3>
<PRE>
public final double <B>readDouble</B>()
throws <A HREF="http://java.sun.com/j2se/1.3/docs/api/java/io/IOException.html">IOException</A></PRE>
<DL>
<DD>Reads a signed double (eight byte) value from the buffer.
Reads values that were written using <A HREF="../../../../../com/sleepycat/bdb/bind/tuple/TupleOutput.html#writeDouble(double)"><CODE>TupleOutput.writeDouble(double)</CODE></A>.
<code>Double.longBitsToDouble</code> is used to convert the signed long
value.
<P>
<DD><DL>
<DT><B>Returns:</B><DD>the value read from the buffer.
<DT><B>Throws:</B>
<DD><CODE><A HREF="http://java.sun.com/j2se/1.3/docs/api/java/io/IOException.html">IOException</A></CODE> - if not enough bytes are available in the buffer.</DL>
</DD>
</DL>
<HR>
<A NAME="readUnsignedByte()"><!-- --></A><H3>
readUnsignedByte</H3>
<PRE>
public final int <B>readUnsignedByte</B>()
throws <A HREF="http://java.sun.com/j2se/1.3/docs/api/java/io/IOException.html">IOException</A></PRE>
<DL>
<DD>Reads an unsigned byte (one byte) value from the buffer.
Reads values that were written using <A HREF="../../../../../com/sleepycat/bdb/bind/tuple/TupleOutput.html#writeUnsignedByte(int)"><CODE>TupleOutput.writeUnsignedByte(int)</CODE></A>.
<P>
<DD><DL>
<DT><B>Returns:</B><DD>the value read from the buffer.
<DT><B>Throws:</B>
<DD><CODE><A HREF="http://java.sun.com/j2se/1.3/docs/api/java/io/IOException.html">IOException</A></CODE> - if not enough bytes are available in the buffer.</DL>
</DD>
</DL>
<HR>
<A NAME="readUnsignedShort()"><!-- --></A><H3>
readUnsignedShort</H3>
<PRE>
public final int <B>readUnsignedShort</B>()
throws <A HREF="http://java.sun.com/j2se/1.3/docs/api/java/io/IOException.html">IOException</A></PRE>
<DL>
<DD>Reads an unsigned short (two byte) value from the buffer.
Reads values that were written using <A HREF="../../../../../com/sleepycat/bdb/bind/tuple/TupleOutput.html#writeUnsignedShort(int)"><CODE>TupleOutput.writeUnsignedShort(int)</CODE></A>.
<P>
<DD><DL>
<DT><B>Returns:</B><DD>the value read from the buffer.
<DT><B>Throws:</B>
<DD><CODE><A HREF="http://java.sun.com/j2se/1.3/docs/api/java/io/IOException.html">IOException</A></CODE> - if not enough bytes are available in the buffer.</DL>
</DD>
</DL>
<HR>
<A NAME="readUnsignedInt()"><!-- --></A><H3>
readUnsignedInt</H3>
<PRE>
public final long <B>readUnsignedInt</B>()
throws <A HREF="http://java.sun.com/j2se/1.3/docs/api/java/io/IOException.html">IOException</A></PRE>
<DL>
<DD>Reads an unsigned int (four byte) value from the buffer.
Reads values that were written using <A HREF="../../../../../com/sleepycat/bdb/bind/tuple/TupleOutput.html#writeUnsignedInt(long)"><CODE>TupleOutput.writeUnsignedInt(long)</CODE></A>.
<P>
<DD><DL>
<DT><B>Returns:</B><DD>the value read from the buffer.
<DT><B>Throws:</B>
<DD><CODE><A HREF="http://java.sun.com/j2se/1.3/docs/api/java/io/IOException.html">IOException</A></CODE> - if not enough bytes are available in the buffer.</DL>
</DD>
</DL>
<HR>
<A NAME="readBytes(int)"><!-- --></A><H3>
readBytes</H3>
<PRE>
public final <A HREF="http://java.sun.com/j2se/1.3/docs/api/java/lang/String.html">String</A> <B>readBytes</B>(int length)
throws <A HREF="http://java.sun.com/j2se/1.3/docs/api/java/io/IOException.html">IOException</A></PRE>
<DL>
<DD>Reads the specified number of bytes from the buffer, converting each
unsigned byte value to a character of the resulting string.
Reads values that were written using <A HREF="../../../../../com/sleepycat/bdb/bind/tuple/TupleOutput.html#writeBytes(java.lang.String)"><CODE>TupleOutput.writeBytes(java.lang.String)</CODE></A>.
Only characters with values below 0x100 may be read using this method.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>length</CODE> - is the number of bytes to be read.
<DT><B>Returns:</B><DD>the value read from the buffer.
<DT><B>Throws:</B>
<DD><CODE><A HREF="http://java.sun.com/j2se/1.3/docs/api/java/io/IOException.html">IOException</A></CODE> - if not enough bytes are available in the buffer.</DL>
</DD>
</DL>
<HR>
<A NAME="readChars(int)"><!-- --></A><H3>
readChars</H3>
<PRE>
public final <A HREF="http://java.sun.com/j2se/1.3/docs/api/java/lang/String.html">String</A> <B>readChars</B>(int length)
throws <A HREF="http://java.sun.com/j2se/1.3/docs/api/java/io/IOException.html">IOException</A></PRE>
<DL>
<DD>Reads the specified number of characters from the buffer, converting
each two byte unsigned value to a character of the resulting string.
Reads values that were written using <A HREF="../../../../../com/sleepycat/bdb/bind/tuple/TupleOutput.html#writeChars(java.lang.String)"><CODE>TupleOutput.writeChars(java.lang.String)</CODE></A>.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>length</CODE> - is the number of characters to be read.
<DT><B>Returns:</B><DD>the value read from the buffer.
<DT><B>Throws:</B>
<DD><CODE><A HREF="http://java.sun.com/j2se/1.3/docs/api/java/io/IOException.html">IOException</A></CODE> - if not enough bytes are available in the buffer.</DL>
</DD>
</DL>
<HR>
<A NAME="readBytes(char[])"><!-- --></A><H3>
readBytes</H3>
<PRE>
public final void <B>readBytes</B>(char[] chars)
throws <A HREF="http://java.sun.com/j2se/1.3/docs/api/java/io/IOException.html">IOException</A></PRE>
<DL>
<DD>Reads the specified number of bytes from the buffer, converting each
unsigned byte value to a character of the resulting array.
Reads values that were written using <A HREF="../../../../../com/sleepycat/bdb/bind/tuple/TupleOutput.html#writeBytes(java.lang.String)"><CODE>TupleOutput.writeBytes(java.lang.String)</CODE></A>.
Only characters with values below 0x100 may be read using this method.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>chars</CODE> - is the array to receive the data and whose length is used
to determine the number of bytes to be read.
<DT><B>Returns:</B><DD>the value read from the buffer.
<DT><B>Throws:</B>
<DD><CODE><A HREF="http://java.sun.com/j2se/1.3/docs/api/java/io/IOException.html">IOException</A></CODE> - if not enough bytes are available in the buffer.</DL>
</DD>
</DL>
<HR>
<A NAME="readChars(char[])"><!-- --></A><H3>
readChars</H3>
<PRE>
public final void <B>readChars</B>(char[] chars)
throws <A HREF="http://java.sun.com/j2se/1.3/docs/api/java/io/IOException.html">IOException</A></PRE>
<DL>
<DD>Reads the specified number of characters from the buffer, converting
each two byte unsigned value to a character of the resulting array.
Reads values that were written using <A HREF="../../../../../com/sleepycat/bdb/bind/tuple/TupleOutput.html#writeChars(java.lang.String)"><CODE>TupleOutput.writeChars(java.lang.String)</CODE></A>.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>chars</CODE> - is the array to receive the data and whose length is used
to determine the number of characters to be read.
<DT><B>Returns:</B><DD>the value read from the buffer.
<DT><B>Throws:</B>
<DD><CODE><A HREF="http://java.sun.com/j2se/1.3/docs/api/java/io/IOException.html">IOException</A></CODE> - if not enough bytes are available in the buffer.</DL>
</DD>
</DL>
<HR>
<A NAME="readString(int)"><!-- --></A><H3>
readString</H3>
<PRE>
public final <A HREF="http://java.sun.com/j2se/1.3/docs/api/java/lang/String.html">String</A> <B>readString</B>(int length)
throws <A HREF="http://java.sun.com/j2se/1.3/docs/api/java/io/IOException.html">IOException</A></PRE>
<DL>
<DD>Reads the specified number of UTF characters string from the data
buffer and converts the data from UTF to Unicode.
Reads values that were written using <A HREF="../../../../../com/sleepycat/bdb/bind/tuple/TupleOutput.html#writeString(char[])"><CODE>TupleOutput.writeString(char[])</CODE></A>.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>length</CODE> - is the number of characters to be read.
<DT><B>Returns:</B><DD>the converted string.
<DT><B>Throws:</B>
<DD><CODE><A HREF="http://java.sun.com/j2se/1.3/docs/api/java/io/IOException.html">IOException</A></CODE> - if not enough bytes are available in the buffer
or malformed UTF data is encountered.</DL>
</DD>
</DL>
<HR>
<A NAME="readString(char[])"><!-- --></A><H3>
readString</H3>
<PRE>
public final void <B>readString</B>(char[] chars)
throws <A HREF="http://java.sun.com/j2se/1.3/docs/api/java/io/IOException.html">IOException</A></PRE>
<DL>
<DD>Reads the specified number of UTF characters string from the data
buffer and converts the data from UTF to Unicode.
Reads values that were written using <A HREF="../../../../../com/sleepycat/bdb/bind/tuple/TupleOutput.html#writeString(char[])"><CODE>TupleOutput.writeString(char[])</CODE></A>.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>chars</CODE> - is the array to receive the data and whose length is used
to determine the number of characters to be read.
<DT><B>Returns:</B><DD>the converted string.
<DT><B>Throws:</B>
<DD><CODE><A HREF="http://java.sun.com/j2se/1.3/docs/api/java/io/IOException.html">IOException</A></CODE> - if not enough bytes are available in the buffer
or malformed UTF data is encountered.</DL>
</DD>
</DL>
<!-- ========= END OF CLASS DATA ========= -->
<HR>
<!-- ========== START OF NAVBAR ========== -->
<A NAME="navbar_bottom"><!-- --></A>
<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0">
<TR>
<TD COLSPAN=3 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
<A NAME="navbar_bottom_firstrow"><!-- --></A>
<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3">
<TR ALIGN="center" VALIGN="top">
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD>
<TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="class-use/TupleInput.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD>
</TR>
</TABLE>
</TD>
<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
<b>Berkeley DB</b><br><font size="-1"> version 4.2.52</font></EM>
</TD>
</TR>
<TR>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
<A HREF="../../../../../com/sleepycat/bdb/bind/tuple/TupleFormat.html"><B>PREV CLASS</B></A>
<A HREF="../../../../../com/sleepycat/bdb/bind/tuple/TupleInputBinding.html"><B>NEXT CLASS</B></A></FONT></TD>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
<A HREF="../../../../../index.html" TARGET="_top"><B>FRAMES</B></A>
<A HREF="TupleInput.html" TARGET="_top"><B>NO FRAMES</B></A>
<SCRIPT>
<!--
if(window==top) {
document.writeln('<A HREF="../../../../../allclasses-noframe.html" TARGET=""><B>All Classes</B></A>');
}
</SCRIPT>
<NOSCRIPT>
<A HREF="../../../../../allclasses-noframe.html" TARGET=""><B>All Classes</B></A>
</NOSCRIPT>
</FONT></TD>
</TR>
<TR>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
SUMMARY: NESTED | FIELD | <A HREF="#constructor_summary">CONSTR</A> | <A HREF="#method_summary">METHOD</A></FONT></TD>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
DETAIL: FIELD | <A HREF="#constructor_detail">CONSTR</A> | <A HREF="#method_detail">METHOD</A></FONT></TD>
</TR>
</TABLE>
<!-- =========== END OF NAVBAR =========== -->
<HR>
<font size=1><a href="../../../../../../sleepycat/legal.html">Copyright (c) 1996-2003</a> <a href="http://www.sleepycat.com">Sleepycat Software, Inc.</a> - All rights reserved.</font>
</BODY>
</HTML>