mirror of
https://github.com/berkeleydb/je.git
synced 2024-11-15 09:46:25 +00:00
1303 lines
55 KiB
HTML
1303 lines
55 KiB
HTML
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
|
|
<!-- NewPage -->
|
|
<html lang="en">
|
|
<head>
|
|
<!-- Generated by javadoc (1.8.0_151) on Tue Oct 31 17:36:44 EDT 2017 -->
|
|
<title>TupleInput (Oracle - Berkeley DB Java Edition API)</title>
|
|
<meta name="date" content="2017-10-31">
|
|
<link rel="stylesheet" type="text/css" href="../../../../style.css" title="Style">
|
|
<script type="text/javascript" src="../../../../script.js"></script>
|
|
</head>
|
|
<body>
|
|
<script type="text/javascript"><!--
|
|
try {
|
|
if (location.href.indexOf('is-external=true') == -1) {
|
|
parent.document.title="TupleInput (Oracle - Berkeley DB Java Edition API)";
|
|
}
|
|
}
|
|
catch(err) {
|
|
}
|
|
//-->
|
|
var methods = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":10,"i5":10,"i6":10,"i7":10,"i8":10,"i9":10,"i10":10,"i11":10,"i12":10,"i13":10,"i14":10,"i15":10,"i16":10,"i17":10,"i18":10,"i19":10,"i20":10,"i21":10,"i22":10,"i23":10,"i24":10,"i25":10,"i26":10,"i27":10,"i28":10,"i29":10,"i30":10,"i31":10,"i32":10,"i33":10,"i34":10};
|
|
var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],8:["t4","Concrete Methods"]};
|
|
var altColor = "altColor";
|
|
var rowColor = "rowColor";
|
|
var tableTab = "tableTab";
|
|
var activeTableTab = "activeTableTab";
|
|
</script>
|
|
<noscript>
|
|
<div>JavaScript is disabled on your browser.</div>
|
|
</noscript>
|
|
<!-- ========= START OF TOP NAVBAR ======= -->
|
|
<div class="topNav"><a name="navbar.top">
|
|
<!-- -->
|
|
</a>
|
|
<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div>
|
|
<a name="navbar.top.firstrow">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="navList" title="Navigation">
|
|
<li><a href="../../../../overview-summary.html">Overview</a></li>
|
|
<li><a href="package-summary.html">Package</a></li>
|
|
<li class="navBarCell1Rev">Class</li>
|
|
<li><a href="class-use/TupleInput.html">Use</a></li>
|
|
<li><a href="package-tree.html">Tree</a></li>
|
|
<li><a href="../../../../deprecated-list.html">Deprecated</a></li>
|
|
<li><a href="../../../../index-all.html">Index</a></li>
|
|
<li><a href="../../../../help-doc.html">Help</a></li>
|
|
</ul>
|
|
<div class="aboutLanguage"><b>Berkeley DB Java Edition</b><br><font size=\"-1\"> version 7.5.11</font>
|
|
</div>
|
|
</div>
|
|
<div class="subNav">
|
|
<ul class="navList">
|
|
<li><a href="../../../../com/sleepycat/bind/tuple/TupleBinding.html" title="class in com.sleepycat.bind.tuple"><span class="typeNameLink">Prev Class</span></a></li>
|
|
<li><a href="../../../../com/sleepycat/bind/tuple/TupleInputBinding.html" title="class in com.sleepycat.bind.tuple"><span class="typeNameLink">Next Class</span></a></li>
|
|
</ul>
|
|
<ul class="navList">
|
|
<li><a href="../../../../index.html?com/sleepycat/bind/tuple/TupleInput.html" target="_top">Frames</a></li>
|
|
<li><a href="TupleInput.html" target="_top">No Frames</a></li>
|
|
</ul>
|
|
<ul class="navList" id="allclasses_navbar_top">
|
|
<li><a href="../../../../allclasses-noframe.html">All Classes</a></li>
|
|
</ul>
|
|
<div>
|
|
<script type="text/javascript"><!--
|
|
allClassesLink = document.getElementById("allclasses_navbar_top");
|
|
if(window==top) {
|
|
allClassesLink.style.display = "block";
|
|
}
|
|
else {
|
|
allClassesLink.style.display = "none";
|
|
}
|
|
//-->
|
|
</script>
|
|
</div>
|
|
<div>
|
|
<ul class="subNavList">
|
|
<li>Summary: </li>
|
|
<li>Nested | </li>
|
|
<li><a href="#fields.inherited.from.class.com.sleepycat.util.FastInputStream">Field</a> | </li>
|
|
<li><a href="#constructor.summary">Constr</a> | </li>
|
|
<li><a href="#method.summary">Method</a></li>
|
|
</ul>
|
|
<ul class="subNavList">
|
|
<li>Detail: </li>
|
|
<li>Field | </li>
|
|
<li><a href="#constructor.detail">Constr</a> | </li>
|
|
<li><a href="#method.detail">Method</a></li>
|
|
</ul>
|
|
</div>
|
|
<a name="skip.navbar.top">
|
|
<!-- -->
|
|
</a></div>
|
|
<!-- ========= END OF TOP NAVBAR ========= -->
|
|
<!-- ======== START OF CLASS DATA ======== -->
|
|
<div class="header">
|
|
<div class="subTitle">com.sleepycat.bind.tuple</div>
|
|
<h2 title="Class TupleInput" class="title">Class TupleInput</h2>
|
|
</div>
|
|
<div class="contentContainer">
|
|
<ul class="inheritance">
|
|
<li>java.lang.Object</li>
|
|
<li>
|
|
<ul class="inheritance">
|
|
<li>java.io.InputStream</li>
|
|
<li>
|
|
<ul class="inheritance">
|
|
<li><a href="../../../../com/sleepycat/util/FastInputStream.html" title="class in com.sleepycat.util">com.sleepycat.util.FastInputStream</a></li>
|
|
<li>
|
|
<ul class="inheritance">
|
|
<li>com.sleepycat.bind.tuple.TupleInput</li>
|
|
</ul>
|
|
</li>
|
|
</ul>
|
|
</li>
|
|
</ul>
|
|
</li>
|
|
</ul>
|
|
<div class="description">
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<dl>
|
|
<dt>All Implemented Interfaces:</dt>
|
|
<dd>java.io.Closeable, java.lang.AutoCloseable</dd>
|
|
</dl>
|
|
<hr>
|
|
<br>
|
|
<pre>public class <span class="typeNameLabel">TupleInput</span>
|
|
extends <a href="../../../../com/sleepycat/util/FastInputStream.html" title="class in com.sleepycat.util">FastInputStream</a></pre>
|
|
<div class="block">An <code>InputStream</code> with <code>DataInput</code>-like methods for
|
|
reading tuple fields. It is used by <code>TupleBinding</code>.
|
|
|
|
<p>This class has many methods that have the same signatures as methods in
|
|
the <code>DataInput</code> interface. The reason this class does not
|
|
implement <code>DataInput</code> is because it would break the interface
|
|
contract for those methods because of data format differences.</p></div>
|
|
<dl>
|
|
<dt><span class="simpleTagLabel">Author:</span></dt>
|
|
<dd>Mark Hayes</dd>
|
|
<dt><span class="seeLabel">See Also:</span></dt>
|
|
<dd><a href="package-summary.html#formats">Tuple Formats</a></dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
<div class="summary">
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<!-- =========== FIELD SUMMARY =========== -->
|
|
<ul class="blockList">
|
|
<li class="blockList"><a name="field.summary">
|
|
<!-- -->
|
|
</a>
|
|
<h3>Field Summary</h3>
|
|
<ul class="blockList">
|
|
<li class="blockList"><a name="fields.inherited.from.class.com.sleepycat.util.FastInputStream">
|
|
<!-- -->
|
|
</a>
|
|
<h3>Fields inherited from class com.sleepycat.util.<a href="../../../../com/sleepycat/util/FastInputStream.html" title="class in com.sleepycat.util">FastInputStream</a></h3>
|
|
<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></li>
|
|
</ul>
|
|
</li>
|
|
</ul>
|
|
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
|
|
<ul class="blockList">
|
|
<li class="blockList"><a name="constructor.summary">
|
|
<!-- -->
|
|
</a>
|
|
<h3>Constructor Summary</h3>
|
|
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation">
|
|
<caption><span>Constructors</span><span class="tabEnd"> </span></caption>
|
|
<tr>
|
|
<th class="colOne" scope="col">Constructor and Description</th>
|
|
</tr>
|
|
<tr class="altColor">
|
|
<td class="colOne"><code><span class="memberNameLink"><a href="../../../../com/sleepycat/bind/tuple/TupleInput.html#TupleInput-byte:A-">TupleInput</a></span>(byte[] buffer)</code>
|
|
<div class="block">Creates a tuple input object for reading a byte array of tuple data.</div>
|
|
</td>
|
|
</tr>
|
|
<tr class="rowColor">
|
|
<td class="colOne"><code><span class="memberNameLink"><a href="../../../../com/sleepycat/bind/tuple/TupleInput.html#TupleInput-byte:A-int-int-">TupleInput</a></span>(byte[] buffer,
|
|
int offset,
|
|
int length)</code>
|
|
<div class="block">Creates a tuple input object for reading a byte array of tuple data at
|
|
a given offset for a given length.</div>
|
|
</td>
|
|
</tr>
|
|
<tr class="altColor">
|
|
<td class="colOne"><code><span class="memberNameLink"><a href="../../../../com/sleepycat/bind/tuple/TupleInput.html#TupleInput-com.sleepycat.bind.tuple.TupleOutput-">TupleInput</a></span>(<a href="../../../../com/sleepycat/bind/tuple/TupleOutput.html" title="class in com.sleepycat.bind.tuple">TupleOutput</a> output)</code>
|
|
<div class="block">Creates a tuple input object from the data contained in a tuple output
|
|
object.</div>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
</li>
|
|
</ul>
|
|
<!-- ========== METHOD SUMMARY =========== -->
|
|
<ul class="blockList">
|
|
<li class="blockList"><a name="method.summary">
|
|
<!-- -->
|
|
</a>
|
|
<h3>Method Summary</h3>
|
|
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
|
|
<caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd"> </span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd"> </span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd"> </span></span></caption>
|
|
<tr>
|
|
<th class="colFirst" scope="col">Modifier and Type</th>
|
|
<th class="colLast" scope="col">Method and Description</th>
|
|
</tr>
|
|
<tr id="i0" class="altColor">
|
|
<td class="colFirst"><code>int</code></td>
|
|
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/sleepycat/bind/tuple/TupleInput.html#getBigDecimalByteLength--">getBigDecimalByteLength</a></span>()</code>
|
|
<div class="block">Returns the byte length of an unsorted <code>BigDecimal</code>.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i1" class="rowColor">
|
|
<td class="colFirst"><code>int</code></td>
|
|
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/sleepycat/bind/tuple/TupleInput.html#getBigIntegerByteLength--">getBigIntegerByteLength</a></span>()</code>
|
|
<div class="block">Returns the byte length of a <code>BigInteger</code>.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i2" class="altColor">
|
|
<td class="colFirst"><code>int</code></td>
|
|
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/sleepycat/bind/tuple/TupleInput.html#getPackedIntByteLength--">getPackedIntByteLength</a></span>()</code>
|
|
<div class="block">Returns the byte length of a packed integer.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i3" class="rowColor">
|
|
<td class="colFirst"><code>int</code></td>
|
|
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/sleepycat/bind/tuple/TupleInput.html#getPackedLongByteLength--">getPackedLongByteLength</a></span>()</code>
|
|
<div class="block">Returns the byte length of a packed long integer.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i4" class="altColor">
|
|
<td class="colFirst"><code>int</code></td>
|
|
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/sleepycat/bind/tuple/TupleInput.html#getSortedBigDecimalByteLength--">getSortedBigDecimalByteLength</a></span>()</code>
|
|
<div class="block">Returns the byte length of a sorted <code>BigDecimal</code>.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i5" class="rowColor">
|
|
<td class="colFirst"><code>int</code></td>
|
|
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/sleepycat/bind/tuple/TupleInput.html#getSortedPackedIntByteLength--">getSortedPackedIntByteLength</a></span>()</code>
|
|
<div class="block">Returns the byte length of a sorted packed integer.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i6" class="altColor">
|
|
<td class="colFirst"><code>int</code></td>
|
|
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/sleepycat/bind/tuple/TupleInput.html#getSortedPackedLongByteLength--">getSortedPackedLongByteLength</a></span>()</code>
|
|
<div class="block">Returns the byte length of a sorted packed long integer.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i7" class="rowColor">
|
|
<td class="colFirst"><code>int</code></td>
|
|
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/sleepycat/bind/tuple/TupleInput.html#getStringByteLength--">getStringByteLength</a></span>()</code>
|
|
<div class="block">Returns the byte length of a null-terminated UTF string in the data
|
|
buffer, including the terminator.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i8" class="altColor">
|
|
<td class="colFirst"><code>java.math.BigDecimal</code></td>
|
|
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/sleepycat/bind/tuple/TupleInput.html#readBigDecimal--">readBigDecimal</a></span>()</code>
|
|
<div class="block">Reads an unsorted <code>BigDecimal</code>.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i9" class="rowColor">
|
|
<td class="colFirst"><code>java.math.BigInteger</code></td>
|
|
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/sleepycat/bind/tuple/TupleInput.html#readBigInteger--">readBigInteger</a></span>()</code>
|
|
<div class="block">Reads a <code>BigInteger</code>.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i10" class="altColor">
|
|
<td class="colFirst"><code>boolean</code></td>
|
|
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/sleepycat/bind/tuple/TupleInput.html#readBoolean--">readBoolean</a></span>()</code>
|
|
<div class="block">Reads a boolean (one byte) unsigned value from the buffer and returns
|
|
true if it is non-zero and false if it is zero.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i11" class="rowColor">
|
|
<td class="colFirst"><code>byte</code></td>
|
|
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/sleepycat/bind/tuple/TupleInput.html#readByte--">readByte</a></span>()</code>
|
|
<div class="block">Reads a signed byte (one byte) value from the buffer.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i12" class="altColor">
|
|
<td class="colFirst"><code>void</code></td>
|
|
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/sleepycat/bind/tuple/TupleInput.html#readBytes-char:A-">readBytes</a></span>(char[] chars)</code>
|
|
<div class="block">Reads the specified number of bytes from the buffer, converting each
|
|
unsigned byte value to a character of the resulting array.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i13" class="rowColor">
|
|
<td class="colFirst"><code>java.lang.String</code></td>
|
|
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/sleepycat/bind/tuple/TupleInput.html#readBytes-int-">readBytes</a></span>(int length)</code>
|
|
<div class="block">Reads the specified number of bytes from the buffer, converting each
|
|
unsigned byte value to a character of the resulting string.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i14" class="altColor">
|
|
<td class="colFirst"><code>char</code></td>
|
|
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/sleepycat/bind/tuple/TupleInput.html#readChar--">readChar</a></span>()</code>
|
|
<div class="block">Reads a char (two byte) unsigned value from the buffer.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i15" class="rowColor">
|
|
<td class="colFirst"><code>void</code></td>
|
|
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/sleepycat/bind/tuple/TupleInput.html#readChars-char:A-">readChars</a></span>(char[] chars)</code>
|
|
<div class="block">Reads the specified number of characters from the buffer, converting
|
|
each two byte unsigned value to a character of the resulting array.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i16" class="altColor">
|
|
<td class="colFirst"><code>java.lang.String</code></td>
|
|
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/sleepycat/bind/tuple/TupleInput.html#readChars-int-">readChars</a></span>(int length)</code>
|
|
<div class="block">Reads the specified number of characters from the buffer, converting
|
|
each two byte unsigned value to a character of the resulting string.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i17" class="rowColor">
|
|
<td class="colFirst"><code>double</code></td>
|
|
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/sleepycat/bind/tuple/TupleInput.html#readDouble--">readDouble</a></span>()</code>
|
|
<div class="block">Reads an unsorted double (eight byte) value from the buffer.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i18" class="altColor">
|
|
<td class="colFirst"><code>float</code></td>
|
|
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/sleepycat/bind/tuple/TupleInput.html#readFloat--">readFloat</a></span>()</code>
|
|
<div class="block">Reads an unsorted float (four byte) value from the buffer.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i19" class="rowColor">
|
|
<td class="colFirst"><code>int</code></td>
|
|
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/sleepycat/bind/tuple/TupleInput.html#readInt--">readInt</a></span>()</code>
|
|
<div class="block">Reads a signed int (four byte) value from the buffer.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i20" class="altColor">
|
|
<td class="colFirst"><code>long</code></td>
|
|
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/sleepycat/bind/tuple/TupleInput.html#readLong--">readLong</a></span>()</code>
|
|
<div class="block">Reads a signed long (eight byte) value from the buffer.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i21" class="rowColor">
|
|
<td class="colFirst"><code>int</code></td>
|
|
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/sleepycat/bind/tuple/TupleInput.html#readPackedInt--">readPackedInt</a></span>()</code>
|
|
<div class="block">Reads an unsorted packed integer.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i22" class="altColor">
|
|
<td class="colFirst"><code>long</code></td>
|
|
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/sleepycat/bind/tuple/TupleInput.html#readPackedLong--">readPackedLong</a></span>()</code>
|
|
<div class="block">Reads an unsorted packed long integer.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i23" class="rowColor">
|
|
<td class="colFirst"><code>short</code></td>
|
|
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/sleepycat/bind/tuple/TupleInput.html#readShort--">readShort</a></span>()</code>
|
|
<div class="block">Reads a signed short (two byte) value from the buffer.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i24" class="altColor">
|
|
<td class="colFirst"><code>java.math.BigDecimal</code></td>
|
|
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/sleepycat/bind/tuple/TupleInput.html#readSortedBigDecimal--">readSortedBigDecimal</a></span>()</code>
|
|
<div class="block">Reads a sorted <code>BigDecimal</code>, with support for correct default
|
|
sorting.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i25" class="rowColor">
|
|
<td class="colFirst"><code>double</code></td>
|
|
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/sleepycat/bind/tuple/TupleInput.html#readSortedDouble--">readSortedDouble</a></span>()</code>
|
|
<div class="block">Reads a sorted double (eight byte) value from the buffer.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i26" class="altColor">
|
|
<td class="colFirst"><code>float</code></td>
|
|
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/sleepycat/bind/tuple/TupleInput.html#readSortedFloat--">readSortedFloat</a></span>()</code>
|
|
<div class="block">Reads a sorted float (four byte) value from the buffer.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i27" class="rowColor">
|
|
<td class="colFirst"><code>int</code></td>
|
|
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/sleepycat/bind/tuple/TupleInput.html#readSortedPackedInt--">readSortedPackedInt</a></span>()</code>
|
|
<div class="block">Reads a sorted packed integer.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i28" class="altColor">
|
|
<td class="colFirst"><code>long</code></td>
|
|
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/sleepycat/bind/tuple/TupleInput.html#readSortedPackedLong--">readSortedPackedLong</a></span>()</code>
|
|
<div class="block">Reads a sorted packed long integer.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i29" class="rowColor">
|
|
<td class="colFirst"><code>java.lang.String</code></td>
|
|
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/sleepycat/bind/tuple/TupleInput.html#readString--">readString</a></span>()</code>
|
|
<div class="block">Reads a null-terminated UTF string from the data buffer and converts
|
|
the data from UTF to Unicode.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i30" class="altColor">
|
|
<td class="colFirst"><code>void</code></td>
|
|
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/sleepycat/bind/tuple/TupleInput.html#readString-char:A-">readString</a></span>(char[] chars)</code>
|
|
<div class="block">Reads the specified number of UTF characters string from the data
|
|
buffer and converts the data from UTF to Unicode.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i31" class="rowColor">
|
|
<td class="colFirst"><code>java.lang.String</code></td>
|
|
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/sleepycat/bind/tuple/TupleInput.html#readString-int-">readString</a></span>(int length)</code>
|
|
<div class="block">Reads the specified number of UTF characters string from the data
|
|
buffer and converts the data from UTF to Unicode.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i32" class="altColor">
|
|
<td class="colFirst"><code>int</code></td>
|
|
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/sleepycat/bind/tuple/TupleInput.html#readUnsignedByte--">readUnsignedByte</a></span>()</code>
|
|
<div class="block">Reads an unsigned byte (one byte) value from the buffer.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i33" class="rowColor">
|
|
<td class="colFirst"><code>long</code></td>
|
|
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/sleepycat/bind/tuple/TupleInput.html#readUnsignedInt--">readUnsignedInt</a></span>()</code>
|
|
<div class="block">Reads an unsigned int (four byte) value from the buffer.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i34" class="altColor">
|
|
<td class="colFirst"><code>int</code></td>
|
|
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/sleepycat/bind/tuple/TupleInput.html#readUnsignedShort--">readUnsignedShort</a></span>()</code>
|
|
<div class="block">Reads an unsigned short (two byte) value from the buffer.</div>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
<ul class="blockList">
|
|
<li class="blockList"><a name="methods.inherited.from.class.com.sleepycat.util.FastInputStream">
|
|
<!-- -->
|
|
</a>
|
|
<h3>Methods inherited from class com.sleepycat.util.<a href="../../../../com/sleepycat/util/FastInputStream.html" title="class in com.sleepycat.util">FastInputStream</a></h3>
|
|
<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:A-">read</a>, <a href="../../../../com/sleepycat/util/FastInputStream.html#read-byte:A-int-int-">read</a>, <a href="../../../../com/sleepycat/util/FastInputStream.html#readFast--">readFast</a>, <a href="../../../../com/sleepycat/util/FastInputStream.html#readFast-byte:A-">readFast</a>, <a href="../../../../com/sleepycat/util/FastInputStream.html#readFast-byte:A-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></li>
|
|
</ul>
|
|
<ul class="blockList">
|
|
<li class="blockList"><a name="methods.inherited.from.class.java.io.InputStream">
|
|
<!-- -->
|
|
</a>
|
|
<h3>Methods inherited from class java.io.InputStream</h3>
|
|
<code>close</code></li>
|
|
</ul>
|
|
<ul class="blockList">
|
|
<li class="blockList"><a name="methods.inherited.from.class.java.lang.Object">
|
|
<!-- -->
|
|
</a>
|
|
<h3>Methods inherited from class java.lang.Object</h3>
|
|
<code>clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</code></li>
|
|
</ul>
|
|
</li>
|
|
</ul>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
<div class="details">
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<!-- ========= CONSTRUCTOR DETAIL ======== -->
|
|
<ul class="blockList">
|
|
<li class="blockList"><a name="constructor.detail">
|
|
<!-- -->
|
|
</a>
|
|
<h3>Constructor Detail</h3>
|
|
<a name="TupleInput-byte:A-">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>TupleInput</h4>
|
|
<pre>public TupleInput(byte[] buffer)</pre>
|
|
<div class="block">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.</div>
|
|
<dl>
|
|
<dt><span class="paramLabel">Parameters:</span></dt>
|
|
<dd><code>buffer</code> - is the byte array to be read and should contain data in
|
|
tuple format.</dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a name="TupleInput-byte:A-int-int-">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>TupleInput</h4>
|
|
<pre>public TupleInput(byte[] buffer,
|
|
int offset,
|
|
int length)</pre>
|
|
<div class="block">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.</div>
|
|
<dl>
|
|
<dt><span class="paramLabel">Parameters:</span></dt>
|
|
<dd><code>buffer</code> - is the byte array to be read and should contain data in
|
|
tuple format.</dd>
|
|
<dd><code>offset</code> - is the byte offset at which to begin reading.</dd>
|
|
<dd><code>length</code> - is the number of bytes to be read.</dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a name="TupleInput-com.sleepycat.bind.tuple.TupleOutput-">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockListLast">
|
|
<li class="blockList">
|
|
<h4>TupleInput</h4>
|
|
<pre>public TupleInput(<a href="../../../../com/sleepycat/bind/tuple/TupleOutput.html" title="class in com.sleepycat.bind.tuple">TupleOutput</a> output)</pre>
|
|
<div class="block">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.</div>
|
|
<dl>
|
|
<dt><span class="paramLabel">Parameters:</span></dt>
|
|
<dd><code>output</code> - is the tuple output object containing the data to be read.</dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
</li>
|
|
</ul>
|
|
<!-- ============ METHOD DETAIL ========== -->
|
|
<ul class="blockList">
|
|
<li class="blockList"><a name="method.detail">
|
|
<!-- -->
|
|
</a>
|
|
<h3>Method Detail</h3>
|
|
<a name="readString--">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>readString</h4>
|
|
<pre>public final java.lang.String readString()
|
|
throws java.lang.IndexOutOfBoundsException,
|
|
java.lang.IllegalArgumentException</pre>
|
|
<div class="block">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/bind/tuple/TupleOutput.html#writeString-java.lang.String-"><code>TupleOutput.writeString(String)</code></a>.</div>
|
|
<dl>
|
|
<dt><span class="returnLabel">Returns:</span></dt>
|
|
<dd>the converted string.</dd>
|
|
<dt><span class="throwsLabel">Throws:</span></dt>
|
|
<dd><code>java.lang.IndexOutOfBoundsException</code> - if no null terminating byte is found
|
|
in the buffer.</dd>
|
|
<dd><code>java.lang.IllegalArgumentException</code> - malformed UTF data is encountered.</dd>
|
|
<dt><span class="seeLabel">See Also:</span></dt>
|
|
<dd><a href="package-summary.html#stringFormats">String Formats</a></dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a name="readChar--">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>readChar</h4>
|
|
<pre>public final char readChar()
|
|
throws java.lang.IndexOutOfBoundsException</pre>
|
|
<div class="block">Reads a char (two byte) unsigned value from the buffer.
|
|
Reads values that were written using <a href="../../../../com/sleepycat/bind/tuple/TupleOutput.html#writeChar-int-"><code>TupleOutput.writeChar(int)</code></a>.</div>
|
|
<dl>
|
|
<dt><span class="returnLabel">Returns:</span></dt>
|
|
<dd>the value read from the buffer.</dd>
|
|
<dt><span class="throwsLabel">Throws:</span></dt>
|
|
<dd><code>java.lang.IndexOutOfBoundsException</code> - if not enough bytes are available in
|
|
the buffer.</dd>
|
|
<dt><span class="seeLabel">See Also:</span></dt>
|
|
<dd><a href="package-summary.html#integerFormats">Integer Formats</a></dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a name="readBoolean--">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>readBoolean</h4>
|
|
<pre>public final boolean readBoolean()
|
|
throws java.lang.IndexOutOfBoundsException</pre>
|
|
<div class="block">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/bind/tuple/TupleOutput.html#writeBoolean-boolean-"><code>TupleOutput.writeBoolean(boolean)</code></a>.</div>
|
|
<dl>
|
|
<dt><span class="returnLabel">Returns:</span></dt>
|
|
<dd>the value read from the buffer.</dd>
|
|
<dt><span class="throwsLabel">Throws:</span></dt>
|
|
<dd><code>java.lang.IndexOutOfBoundsException</code> - if not enough bytes are available in
|
|
the buffer.</dd>
|
|
<dt><span class="seeLabel">See Also:</span></dt>
|
|
<dd><a href="package-summary.html#integerFormats">Integer Formats</a></dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a name="readByte--">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>readByte</h4>
|
|
<pre>public final byte readByte()
|
|
throws java.lang.IndexOutOfBoundsException</pre>
|
|
<div class="block">Reads a signed byte (one byte) value from the buffer.
|
|
Reads values that were written using <a href="../../../../com/sleepycat/bind/tuple/TupleOutput.html#writeByte-int-"><code>TupleOutput.writeByte(int)</code></a>.</div>
|
|
<dl>
|
|
<dt><span class="returnLabel">Returns:</span></dt>
|
|
<dd>the value read from the buffer.</dd>
|
|
<dt><span class="throwsLabel">Throws:</span></dt>
|
|
<dd><code>java.lang.IndexOutOfBoundsException</code> - if not enough bytes are available in
|
|
the buffer.</dd>
|
|
<dt><span class="seeLabel">See Also:</span></dt>
|
|
<dd><a href="package-summary.html#integerFormats">Integer Formats</a></dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a name="readShort--">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>readShort</h4>
|
|
<pre>public final short readShort()
|
|
throws java.lang.IndexOutOfBoundsException</pre>
|
|
<div class="block">Reads a signed short (two byte) value from the buffer.
|
|
Reads values that were written using <a href="../../../../com/sleepycat/bind/tuple/TupleOutput.html#writeShort-int-"><code>TupleOutput.writeShort(int)</code></a>.</div>
|
|
<dl>
|
|
<dt><span class="returnLabel">Returns:</span></dt>
|
|
<dd>the value read from the buffer.</dd>
|
|
<dt><span class="throwsLabel">Throws:</span></dt>
|
|
<dd><code>java.lang.IndexOutOfBoundsException</code> - if not enough bytes are available in
|
|
the buffer.</dd>
|
|
<dt><span class="seeLabel">See Also:</span></dt>
|
|
<dd><a href="package-summary.html#integerFormats">Integer Formats</a></dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a name="readInt--">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>readInt</h4>
|
|
<pre>public final int readInt()
|
|
throws java.lang.IndexOutOfBoundsException</pre>
|
|
<div class="block">Reads a signed int (four byte) value from the buffer.
|
|
Reads values that were written using <a href="../../../../com/sleepycat/bind/tuple/TupleOutput.html#writeInt-int-"><code>TupleOutput.writeInt(int)</code></a>.</div>
|
|
<dl>
|
|
<dt><span class="returnLabel">Returns:</span></dt>
|
|
<dd>the value read from the buffer.</dd>
|
|
<dt><span class="throwsLabel">Throws:</span></dt>
|
|
<dd><code>java.lang.IndexOutOfBoundsException</code> - if not enough bytes are available in
|
|
the buffer.</dd>
|
|
<dt><span class="seeLabel">See Also:</span></dt>
|
|
<dd><a href="package-summary.html#integerFormats">Integer Formats</a></dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a name="readLong--">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>readLong</h4>
|
|
<pre>public final long readLong()
|
|
throws java.lang.IndexOutOfBoundsException</pre>
|
|
<div class="block">Reads a signed long (eight byte) value from the buffer.
|
|
Reads values that were written using <a href="../../../../com/sleepycat/bind/tuple/TupleOutput.html#writeLong-long-"><code>TupleOutput.writeLong(long)</code></a>.</div>
|
|
<dl>
|
|
<dt><span class="returnLabel">Returns:</span></dt>
|
|
<dd>the value read from the buffer.</dd>
|
|
<dt><span class="throwsLabel">Throws:</span></dt>
|
|
<dd><code>java.lang.IndexOutOfBoundsException</code> - if not enough bytes are available in
|
|
the buffer.</dd>
|
|
<dt><span class="seeLabel">See Also:</span></dt>
|
|
<dd><a href="package-summary.html#integerFormats">Integer Formats</a></dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a name="readFloat--">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>readFloat</h4>
|
|
<pre>public final float readFloat()
|
|
throws java.lang.IndexOutOfBoundsException</pre>
|
|
<div class="block">Reads an unsorted float (four byte) value from the buffer.
|
|
Reads values that were written using <a href="../../../../com/sleepycat/bind/tuple/TupleOutput.html#writeFloat-float-"><code>TupleOutput.writeFloat(float)</code></a>.</div>
|
|
<dl>
|
|
<dt><span class="returnLabel">Returns:</span></dt>
|
|
<dd>the value read from the buffer.</dd>
|
|
<dt><span class="throwsLabel">Throws:</span></dt>
|
|
<dd><code>java.lang.IndexOutOfBoundsException</code> - if not enough bytes are available in
|
|
the buffer.</dd>
|
|
<dt><span class="seeLabel">See Also:</span></dt>
|
|
<dd><a href="package-summary.html#floatFormats">Floating Point
|
|
Formats</a></dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a name="readDouble--">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>readDouble</h4>
|
|
<pre>public final double readDouble()
|
|
throws java.lang.IndexOutOfBoundsException</pre>
|
|
<div class="block">Reads an unsorted double (eight byte) value from the buffer.
|
|
Reads values that were written using <a href="../../../../com/sleepycat/bind/tuple/TupleOutput.html#writeDouble-double-"><code>TupleOutput.writeDouble(double)</code></a>.</div>
|
|
<dl>
|
|
<dt><span class="returnLabel">Returns:</span></dt>
|
|
<dd>the value read from the buffer.</dd>
|
|
<dt><span class="throwsLabel">Throws:</span></dt>
|
|
<dd><code>java.lang.IndexOutOfBoundsException</code> - if not enough bytes are available in
|
|
the buffer.</dd>
|
|
<dt><span class="seeLabel">See Also:</span></dt>
|
|
<dd><a href="package-summary.html#floatFormats">Floating Point
|
|
Formats</a></dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a name="readSortedFloat--">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>readSortedFloat</h4>
|
|
<pre>public final float readSortedFloat()
|
|
throws java.lang.IndexOutOfBoundsException</pre>
|
|
<div class="block">Reads a sorted float (four byte) value from the buffer.
|
|
Reads values that were written using <a href="../../../../com/sleepycat/bind/tuple/TupleOutput.html#writeSortedFloat-float-"><code>TupleOutput.writeSortedFloat(float)</code></a>.</div>
|
|
<dl>
|
|
<dt><span class="returnLabel">Returns:</span></dt>
|
|
<dd>the value read from the buffer.</dd>
|
|
<dt><span class="throwsLabel">Throws:</span></dt>
|
|
<dd><code>java.lang.IndexOutOfBoundsException</code> - if not enough bytes are available in
|
|
the buffer.</dd>
|
|
<dt><span class="seeLabel">See Also:</span></dt>
|
|
<dd><a href="package-summary.html#floatFormats">Floating Point
|
|
Formats</a></dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a name="readSortedDouble--">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>readSortedDouble</h4>
|
|
<pre>public final double readSortedDouble()
|
|
throws java.lang.IndexOutOfBoundsException</pre>
|
|
<div class="block">Reads a sorted double (eight byte) value from the buffer.
|
|
Reads values that were written using <a href="../../../../com/sleepycat/bind/tuple/TupleOutput.html#writeSortedDouble-double-"><code>TupleOutput.writeSortedDouble(double)</code></a>.</div>
|
|
<dl>
|
|
<dt><span class="returnLabel">Returns:</span></dt>
|
|
<dd>the value read from the buffer.</dd>
|
|
<dt><span class="throwsLabel">Throws:</span></dt>
|
|
<dd><code>java.lang.IndexOutOfBoundsException</code> - if not enough bytes are available in
|
|
the buffer.</dd>
|
|
<dt><span class="seeLabel">See Also:</span></dt>
|
|
<dd><a href="package-summary.html#floatFormats">Floating Point
|
|
Formats</a></dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a name="readUnsignedByte--">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>readUnsignedByte</h4>
|
|
<pre>public final int readUnsignedByte()
|
|
throws java.lang.IndexOutOfBoundsException</pre>
|
|
<div class="block">Reads an unsigned byte (one byte) value from the buffer.
|
|
Reads values that were written using <a href="../../../../com/sleepycat/bind/tuple/TupleOutput.html#writeUnsignedByte-int-"><code>TupleOutput.writeUnsignedByte(int)</code></a>.</div>
|
|
<dl>
|
|
<dt><span class="returnLabel">Returns:</span></dt>
|
|
<dd>the value read from the buffer.</dd>
|
|
<dt><span class="throwsLabel">Throws:</span></dt>
|
|
<dd><code>java.lang.IndexOutOfBoundsException</code> - if not enough bytes are available in
|
|
the buffer.</dd>
|
|
<dt><span class="seeLabel">See Also:</span></dt>
|
|
<dd><a href="package-summary.html#integerFormats">Integer Formats</a></dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a name="readUnsignedShort--">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>readUnsignedShort</h4>
|
|
<pre>public final int readUnsignedShort()
|
|
throws java.lang.IndexOutOfBoundsException</pre>
|
|
<div class="block">Reads an unsigned short (two byte) value from the buffer.
|
|
Reads values that were written using <a href="../../../../com/sleepycat/bind/tuple/TupleOutput.html#writeUnsignedShort-int-"><code>TupleOutput.writeUnsignedShort(int)</code></a>.</div>
|
|
<dl>
|
|
<dt><span class="returnLabel">Returns:</span></dt>
|
|
<dd>the value read from the buffer.</dd>
|
|
<dt><span class="throwsLabel">Throws:</span></dt>
|
|
<dd><code>java.lang.IndexOutOfBoundsException</code> - if not enough bytes are available in
|
|
the buffer.</dd>
|
|
<dt><span class="seeLabel">See Also:</span></dt>
|
|
<dd><a href="package-summary.html#integerFormats">Integer Formats</a></dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a name="readUnsignedInt--">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>readUnsignedInt</h4>
|
|
<pre>public final long readUnsignedInt()
|
|
throws java.lang.IndexOutOfBoundsException</pre>
|
|
<div class="block">Reads an unsigned int (four byte) value from the buffer.
|
|
Reads values that were written using <a href="../../../../com/sleepycat/bind/tuple/TupleOutput.html#writeUnsignedInt-long-"><code>TupleOutput.writeUnsignedInt(long)</code></a>.</div>
|
|
<dl>
|
|
<dt><span class="returnLabel">Returns:</span></dt>
|
|
<dd>the value read from the buffer.</dd>
|
|
<dt><span class="throwsLabel">Throws:</span></dt>
|
|
<dd><code>java.lang.IndexOutOfBoundsException</code> - if not enough bytes are available in
|
|
the buffer.</dd>
|
|
<dt><span class="seeLabel">See Also:</span></dt>
|
|
<dd><a href="package-summary.html#integerFormats">Integer Formats</a></dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a name="readBytes-int-">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>readBytes</h4>
|
|
<pre>public final java.lang.String readBytes(int length)
|
|
throws java.lang.IndexOutOfBoundsException</pre>
|
|
<div class="block">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/bind/tuple/TupleOutput.html#writeBytes-java.lang.String-"><code>TupleOutput.writeBytes(java.lang.String)</code></a>.</div>
|
|
<dl>
|
|
<dt><span class="paramLabel">Parameters:</span></dt>
|
|
<dd><code>length</code> - is the number of bytes to be read.</dd>
|
|
<dt><span class="returnLabel">Returns:</span></dt>
|
|
<dd>the value read from the buffer.</dd>
|
|
<dt><span class="throwsLabel">Throws:</span></dt>
|
|
<dd><code>java.lang.IndexOutOfBoundsException</code> - if not enough bytes are available in
|
|
the buffer.</dd>
|
|
<dt><span class="seeLabel">See Also:</span></dt>
|
|
<dd><a href="package-summary.html#integerFormats">Integer Formats</a></dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a name="readChars-int-">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>readChars</h4>
|
|
<pre>public final java.lang.String readChars(int length)
|
|
throws java.lang.IndexOutOfBoundsException</pre>
|
|
<div class="block">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/bind/tuple/TupleOutput.html#writeChars-java.lang.String-"><code>TupleOutput.writeChars(java.lang.String)</code></a>.</div>
|
|
<dl>
|
|
<dt><span class="paramLabel">Parameters:</span></dt>
|
|
<dd><code>length</code> - is the number of characters to be read.</dd>
|
|
<dt><span class="returnLabel">Returns:</span></dt>
|
|
<dd>the value read from the buffer.</dd>
|
|
<dt><span class="throwsLabel">Throws:</span></dt>
|
|
<dd><code>java.lang.IndexOutOfBoundsException</code> - if not enough bytes are available in
|
|
the buffer.</dd>
|
|
<dt><span class="seeLabel">See Also:</span></dt>
|
|
<dd><a href="package-summary.html#integerFormats">Integer Formats</a></dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a name="readBytes-char:A-">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>readBytes</h4>
|
|
<pre>public final void readBytes(char[] chars)
|
|
throws java.lang.IndexOutOfBoundsException</pre>
|
|
<div class="block">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/bind/tuple/TupleOutput.html#writeBytes-java.lang.String-"><code>TupleOutput.writeBytes(java.lang.String)</code></a>.</div>
|
|
<dl>
|
|
<dt><span class="paramLabel">Parameters:</span></dt>
|
|
<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.</dd>
|
|
<dt><span class="throwsLabel">Throws:</span></dt>
|
|
<dd><code>java.lang.IndexOutOfBoundsException</code> - if not enough bytes are available in
|
|
the buffer.</dd>
|
|
<dt><span class="seeLabel">See Also:</span></dt>
|
|
<dd><a href="package-summary.html#integerFormats">Integer Formats</a></dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a name="readChars-char:A-">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>readChars</h4>
|
|
<pre>public final void readChars(char[] chars)
|
|
throws java.lang.IndexOutOfBoundsException</pre>
|
|
<div class="block">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/bind/tuple/TupleOutput.html#writeChars-java.lang.String-"><code>TupleOutput.writeChars(java.lang.String)</code></a>.</div>
|
|
<dl>
|
|
<dt><span class="paramLabel">Parameters:</span></dt>
|
|
<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.</dd>
|
|
<dt><span class="throwsLabel">Throws:</span></dt>
|
|
<dd><code>java.lang.IndexOutOfBoundsException</code> - if not enough bytes are available in
|
|
the buffer.</dd>
|
|
<dt><span class="seeLabel">See Also:</span></dt>
|
|
<dd><a href="package-summary.html#integerFormats">Integer Formats</a></dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a name="readString-int-">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>readString</h4>
|
|
<pre>public final java.lang.String readString(int length)
|
|
throws java.lang.IndexOutOfBoundsException,
|
|
java.lang.IllegalArgumentException</pre>
|
|
<div class="block">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/bind/tuple/TupleOutput.html#writeString-char:A-"><code>TupleOutput.writeString(char[])</code></a>.</div>
|
|
<dl>
|
|
<dt><span class="paramLabel">Parameters:</span></dt>
|
|
<dd><code>length</code> - is the number of characters to be read.</dd>
|
|
<dt><span class="returnLabel">Returns:</span></dt>
|
|
<dd>the converted string.</dd>
|
|
<dt><span class="throwsLabel">Throws:</span></dt>
|
|
<dd><code>java.lang.IndexOutOfBoundsException</code> - if no null terminating byte is found
|
|
in the buffer.</dd>
|
|
<dd><code>java.lang.IllegalArgumentException</code> - malformed UTF data is encountered.</dd>
|
|
<dt><span class="seeLabel">See Also:</span></dt>
|
|
<dd><a href="package-summary.html#stringFormats">String Formats</a></dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a name="readString-char:A-">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>readString</h4>
|
|
<pre>public final void readString(char[] chars)
|
|
throws java.lang.IndexOutOfBoundsException,
|
|
java.lang.IllegalArgumentException</pre>
|
|
<div class="block">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/bind/tuple/TupleOutput.html#writeString-char:A-"><code>TupleOutput.writeString(char[])</code></a>.</div>
|
|
<dl>
|
|
<dt><span class="paramLabel">Parameters:</span></dt>
|
|
<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.</dd>
|
|
<dt><span class="throwsLabel">Throws:</span></dt>
|
|
<dd><code>java.lang.IndexOutOfBoundsException</code> - if no null terminating byte is found
|
|
in the buffer.</dd>
|
|
<dd><code>java.lang.IllegalArgumentException</code> - malformed UTF data is encountered.</dd>
|
|
<dt><span class="seeLabel">See Also:</span></dt>
|
|
<dd><a href="package-summary.html#stringFormats">String Formats</a></dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a name="getStringByteLength--">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>getStringByteLength</h4>
|
|
<pre>public final int getStringByteLength()
|
|
throws java.lang.IndexOutOfBoundsException,
|
|
java.lang.IllegalArgumentException</pre>
|
|
<div class="block">Returns the byte length of a null-terminated UTF string in the data
|
|
buffer, including the terminator. Used with string values that were
|
|
written using <a href="../../../../com/sleepycat/bind/tuple/TupleOutput.html#writeString-java.lang.String-"><code>TupleOutput.writeString(String)</code></a>.</div>
|
|
<dl>
|
|
<dt><span class="returnLabel">Returns:</span></dt>
|
|
<dd>the byte length.</dd>
|
|
<dt><span class="throwsLabel">Throws:</span></dt>
|
|
<dd><code>java.lang.IndexOutOfBoundsException</code> - if no null terminating byte is found
|
|
in the buffer.</dd>
|
|
<dd><code>java.lang.IllegalArgumentException</code> - malformed UTF data is encountered.</dd>
|
|
<dt><span class="seeLabel">See Also:</span></dt>
|
|
<dd><a href="package-summary.html#stringFormats">String Formats</a></dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a name="readPackedInt--">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>readPackedInt</h4>
|
|
<pre>public final int readPackedInt()</pre>
|
|
<div class="block">Reads an unsorted packed integer.</div>
|
|
<dl>
|
|
<dt><span class="returnLabel">Returns:</span></dt>
|
|
<dd>the int value.</dd>
|
|
<dt><span class="seeLabel">See Also:</span></dt>
|
|
<dd><a href="package-summary.html#integerFormats">Integer Formats</a></dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a name="getPackedIntByteLength--">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>getPackedIntByteLength</h4>
|
|
<pre>public final int getPackedIntByteLength()</pre>
|
|
<div class="block">Returns the byte length of a packed integer.</div>
|
|
<dl>
|
|
<dt><span class="returnLabel">Returns:</span></dt>
|
|
<dd>the byte length.</dd>
|
|
<dt><span class="seeLabel">See Also:</span></dt>
|
|
<dd><a href="package-summary.html#integerFormats">Integer Formats</a></dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a name="readPackedLong--">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>readPackedLong</h4>
|
|
<pre>public final long readPackedLong()</pre>
|
|
<div class="block">Reads an unsorted packed long integer.</div>
|
|
<dl>
|
|
<dt><span class="returnLabel">Returns:</span></dt>
|
|
<dd>the long value.</dd>
|
|
<dt><span class="seeLabel">See Also:</span></dt>
|
|
<dd><a href="package-summary.html#integerFormats">Integer Formats</a></dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a name="getPackedLongByteLength--">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>getPackedLongByteLength</h4>
|
|
<pre>public final int getPackedLongByteLength()</pre>
|
|
<div class="block">Returns the byte length of a packed long integer.</div>
|
|
<dl>
|
|
<dt><span class="returnLabel">Returns:</span></dt>
|
|
<dd>the byte length.</dd>
|
|
<dt><span class="seeLabel">See Also:</span></dt>
|
|
<dd><a href="package-summary.html#integerFormats">Integer Formats</a></dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a name="readSortedPackedInt--">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>readSortedPackedInt</h4>
|
|
<pre>public final int readSortedPackedInt()</pre>
|
|
<div class="block">Reads a sorted packed integer.</div>
|
|
<dl>
|
|
<dt><span class="returnLabel">Returns:</span></dt>
|
|
<dd>the int value.</dd>
|
|
<dt><span class="seeLabel">See Also:</span></dt>
|
|
<dd><a href="package-summary.html#integerFormats">Integer Formats</a></dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a name="getSortedPackedIntByteLength--">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>getSortedPackedIntByteLength</h4>
|
|
<pre>public final int getSortedPackedIntByteLength()</pre>
|
|
<div class="block">Returns the byte length of a sorted packed integer.</div>
|
|
<dl>
|
|
<dt><span class="returnLabel">Returns:</span></dt>
|
|
<dd>the byte length.</dd>
|
|
<dt><span class="seeLabel">See Also:</span></dt>
|
|
<dd><a href="package-summary.html#integerFormats">Integer Formats</a></dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a name="readSortedPackedLong--">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>readSortedPackedLong</h4>
|
|
<pre>public final long readSortedPackedLong()</pre>
|
|
<div class="block">Reads a sorted packed long integer.</div>
|
|
<dl>
|
|
<dt><span class="returnLabel">Returns:</span></dt>
|
|
<dd>the long value.</dd>
|
|
<dt><span class="seeLabel">See Also:</span></dt>
|
|
<dd><a href="package-summary.html#integerFormats">Integer Formats</a></dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a name="getSortedPackedLongByteLength--">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>getSortedPackedLongByteLength</h4>
|
|
<pre>public final int getSortedPackedLongByteLength()</pre>
|
|
<div class="block">Returns the byte length of a sorted packed long integer.</div>
|
|
<dl>
|
|
<dt><span class="returnLabel">Returns:</span></dt>
|
|
<dd>the byte length.</dd>
|
|
<dt><span class="seeLabel">See Also:</span></dt>
|
|
<dd><a href="package-summary.html#integerFormats">Integer Formats</a></dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a name="readBigInteger--">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>readBigInteger</h4>
|
|
<pre>public final java.math.BigInteger readBigInteger()</pre>
|
|
<div class="block">Reads a <code>BigInteger</code>.</div>
|
|
<dl>
|
|
<dt><span class="returnLabel">Returns:</span></dt>
|
|
<dd>the non-null BigInteger value.</dd>
|
|
<dt><span class="seeLabel">See Also:</span></dt>
|
|
<dd><a href="package-summary.html#integerFormats">Integer Formats</a></dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a name="getBigIntegerByteLength--">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>getBigIntegerByteLength</h4>
|
|
<pre>public final int getBigIntegerByteLength()</pre>
|
|
<div class="block">Returns the byte length of a <code>BigInteger</code>.</div>
|
|
<dl>
|
|
<dt><span class="returnLabel">Returns:</span></dt>
|
|
<dd>the byte length.</dd>
|
|
<dt><span class="seeLabel">See Also:</span></dt>
|
|
<dd><a href="package-summary.html#integerFormats">Integer Formats</a></dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a name="readBigDecimal--">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>readBigDecimal</h4>
|
|
<pre>public final java.math.BigDecimal readBigDecimal()</pre>
|
|
<div class="block">Reads an unsorted <code>BigDecimal</code>.</div>
|
|
<dl>
|
|
<dt><span class="returnLabel">Returns:</span></dt>
|
|
<dd>the non-null BigDecimal value.</dd>
|
|
<dt><span class="seeLabel">See Also:</span></dt>
|
|
<dd><a href="package-summary.html#bigDecimalFormats">BigDecimal
|
|
Formats</a></dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a name="getBigDecimalByteLength--">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>getBigDecimalByteLength</h4>
|
|
<pre>public final int getBigDecimalByteLength()</pre>
|
|
<div class="block">Returns the byte length of an unsorted <code>BigDecimal</code>.</div>
|
|
<dl>
|
|
<dt><span class="returnLabel">Returns:</span></dt>
|
|
<dd>the byte length.</dd>
|
|
<dt><span class="seeLabel">See Also:</span></dt>
|
|
<dd><a href="package-summary.html#bigDecimalFormats">BigDecimal
|
|
Formats</a></dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a name="readSortedBigDecimal--">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>readSortedBigDecimal</h4>
|
|
<pre>public final java.math.BigDecimal readSortedBigDecimal()</pre>
|
|
<div class="block">Reads a sorted <code>BigDecimal</code>, with support for correct default
|
|
sorting.</div>
|
|
<dl>
|
|
<dt><span class="returnLabel">Returns:</span></dt>
|
|
<dd>the non-null BigDecimal value.</dd>
|
|
<dt><span class="seeLabel">See Also:</span></dt>
|
|
<dd><a href="package-summary.html#bigDecimalFormats">BigDecimal
|
|
Formats</a></dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a name="getSortedBigDecimalByteLength--">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockListLast">
|
|
<li class="blockList">
|
|
<h4>getSortedBigDecimalByteLength</h4>
|
|
<pre>public final int getSortedBigDecimalByteLength()</pre>
|
|
<div class="block">Returns the byte length of a sorted <code>BigDecimal</code>.</div>
|
|
<dl>
|
|
<dt><span class="returnLabel">Returns:</span></dt>
|
|
<dd>the byte length.</dd>
|
|
<dt><span class="seeLabel">See Also:</span></dt>
|
|
<dd><a href="package-summary.html#bigDecimalFormats">BigDecimal
|
|
Formats</a></dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
</li>
|
|
</ul>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
<!-- ========= END OF CLASS DATA ========= -->
|
|
<!-- ======= START OF BOTTOM NAVBAR ====== -->
|
|
<div class="bottomNav"><a name="navbar.bottom">
|
|
<!-- -->
|
|
</a>
|
|
<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
|
|
<a name="navbar.bottom.firstrow">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="navList" title="Navigation">
|
|
<li><a href="../../../../overview-summary.html">Overview</a></li>
|
|
<li><a href="package-summary.html">Package</a></li>
|
|
<li class="navBarCell1Rev">Class</li>
|
|
<li><a href="class-use/TupleInput.html">Use</a></li>
|
|
<li><a href="package-tree.html">Tree</a></li>
|
|
<li><a href="../../../../deprecated-list.html">Deprecated</a></li>
|
|
<li><a href="../../../../index-all.html">Index</a></li>
|
|
<li><a href="../../../../help-doc.html">Help</a></li>
|
|
</ul>
|
|
<div class="aboutLanguage"><b>Berkeley DB Java Edition</b><br><font size=\"-1\"> version 7.5.11</font>
|
|
</div>
|
|
</div>
|
|
<div class="subNav">
|
|
<ul class="navList">
|
|
<li><a href="../../../../com/sleepycat/bind/tuple/TupleBinding.html" title="class in com.sleepycat.bind.tuple"><span class="typeNameLink">Prev Class</span></a></li>
|
|
<li><a href="../../../../com/sleepycat/bind/tuple/TupleInputBinding.html" title="class in com.sleepycat.bind.tuple"><span class="typeNameLink">Next Class</span></a></li>
|
|
</ul>
|
|
<ul class="navList">
|
|
<li><a href="../../../../index.html?com/sleepycat/bind/tuple/TupleInput.html" target="_top">Frames</a></li>
|
|
<li><a href="TupleInput.html" target="_top">No Frames</a></li>
|
|
</ul>
|
|
<ul class="navList" id="allclasses_navbar_bottom">
|
|
<li><a href="../../../../allclasses-noframe.html">All Classes</a></li>
|
|
</ul>
|
|
<div>
|
|
<script type="text/javascript"><!--
|
|
allClassesLink = document.getElementById("allclasses_navbar_bottom");
|
|
if(window==top) {
|
|
allClassesLink.style.display = "block";
|
|
}
|
|
else {
|
|
allClassesLink.style.display = "none";
|
|
}
|
|
//-->
|
|
</script>
|
|
</div>
|
|
<div>
|
|
<ul class="subNavList">
|
|
<li>Summary: </li>
|
|
<li>Nested | </li>
|
|
<li><a href="#fields.inherited.from.class.com.sleepycat.util.FastInputStream">Field</a> | </li>
|
|
<li><a href="#constructor.summary">Constr</a> | </li>
|
|
<li><a href="#method.summary">Method</a></li>
|
|
</ul>
|
|
<ul class="subNavList">
|
|
<li>Detail: </li>
|
|
<li>Field | </li>
|
|
<li><a href="#constructor.detail">Constr</a> | </li>
|
|
<li><a href="#method.detail">Method</a></li>
|
|
</ul>
|
|
</div>
|
|
<a name="skip.navbar.bottom">
|
|
<!-- -->
|
|
</a></div>
|
|
<!-- ======== END OF BOTTOM NAVBAR ======= -->
|
|
<p class="legalCopy"><small><font size=1>Copyright (c) 2002, 2017 Oracle and/or its affiliates. All rights reserved.</font> </small></p>
|
|
</body>
|
|
</html>
|