Files
Yasuhiro KIMURA 9678929700 Update to 18.1.40
2020-07-24 01:10:28 +09:00

463 lines
20 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 (11.0.7) on Mon Jun 01 06:40:53 PDT 2020 -->
<title>ShortBinding (Oracle - Berkeley DB Java API)</title>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
<meta name="date" content="2020-06-01">
<link rel="stylesheet" type="text/css" href="../../../../style.css" title="Style">
<link rel="stylesheet" type="text/css" href="../../../../jquery/jquery-ui.css" title="Style">
<script type="text/javascript" src="../../../../script.js"></script>
<script type="text/javascript" src="../../../../jquery/jszip/dist/jszip.min.js"></script>
<script type="text/javascript" src="../../../../jquery/jszip-utils/dist/jszip-utils.min.js"></script>
<!--[if IE]>
<script type="text/javascript" src="../../../../jquery/jszip-utils/dist/jszip-utils-ie.min.js"></script>
<![endif]-->
<script type="text/javascript" src="../../../../jquery/jquery-3.4.1.js"></script>
<script type="text/javascript" src="../../../../jquery/jquery-ui.js"></script>
</head>
<body>
<script type="text/javascript"><!--
try {
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="ShortBinding (Oracle - Berkeley DB Java API)";
}
}
catch(err) {
}
//-->
var data = {"i0":10,"i1":9,"i2":10,"i3":10,"i4":9};
var tabs = {65535:["t0","All Methods"],1:["t1","Static Methods"],2:["t2","Instance Methods"],8:["t4","Concrete Methods"]};
var altColor = "altColor";
var rowColor = "rowColor";
var tableTab = "tableTab";
var activeTableTab = "activeTableTab";
var pathtoroot = "../../../../";
var useModuleDirectories = true;
loadScripts(document, 'script');</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<div class="fixedNav">
<!-- ========= 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="../../../../index.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="class-use/ShortBinding.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</b><br><font size="-1"> version 18.1.40</font></div>
</div>
<div class="subNav">
<ul class="navList" id="allclasses_navbar_top">
<li><a href="../../../../allclasses.html">All&nbsp;Classes</a></li>
</ul>
<ul class="navListSearch">
<li><label for="search">SEARCH:</label>
<input type="text" id="search" value="search" disabled="disabled">
<input type="reset" id="reset" value="reset" disabled="disabled">
</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>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li><a href="#constructor.summary">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li><a href="#constructor.detail">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.detail">Method</a></li>
</ul>
</div>
<a name="skip.navbar.top">
<!-- -->
</a></div>
<!-- ========= END OF TOP NAVBAR ========= -->
</div>
<div class="navPadding">&nbsp;</div>
<script type="text/javascript"><!--
$('.navPadding').css('padding-top', $('.fixedNav').css("height"));
//-->
</script>
<!-- ======== START OF CLASS DATA ======== -->
<div class="header">
<div class="subTitle"><span class="packageLabelInType">Package</span>&nbsp;<a href="package-summary.html">com.sleepycat.bind.tuple</a></div>
<h2 title="Class ShortBinding" class="title">Class ShortBinding</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li>java.lang.Object</li>
<li>
<ul class="inheritance">
<li><a href="TupleBase.html" title="class in com.sleepycat.bind.tuple">com.sleepycat.bind.tuple.TupleBase</a>&lt;E&gt;</li>
<li>
<ul class="inheritance">
<li><a href="TupleBinding.html" title="class in com.sleepycat.bind.tuple">com.sleepycat.bind.tuple.TupleBinding</a>&lt;java.lang.Short&gt;</li>
<li>
<ul class="inheritance">
<li>com.sleepycat.bind.tuple.ShortBinding</li>
</ul>
</li>
</ul>
</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>All Implemented Interfaces:</dt>
<dd><code><a href="../EntryBinding.html" title="interface in com.sleepycat.bind">EntryBinding</a>&lt;java.lang.Short&gt;</code></dd>
</dl>
<hr>
<pre>public class <span class="typeNameLabel">ShortBinding</span>
extends <a href="TupleBinding.html" title="class in com.sleepycat.bind.tuple">TupleBinding</a>&lt;java.lang.Short&gt;</pre>
<div class="block">A concrete <code>TupleBinding</code> for a <code>Short</code> primitive
wrapper or a <code>short</code> primitive.
<p>There are two ways to use this class:</p>
<ol>
<li>When using the <a href="../../db/package-summary.html"><code>com.sleepycat.db</code></a> package directly, the static
methods in this class can be used to convert between primitive values and
<a href="../../db/DatabaseEntry.html" title="class in com.sleepycat.db"><code>DatabaseEntry</code></a> objects.</li>
<li>When using the <a href="../../collections/package-summary.html"><code>com.sleepycat.collections</code></a> package, an instance of
this class can be used with any stored collection. The easiest way to
obtain a binding instance is with the <a href="TupleBinding.html#getPrimitiveBinding-java.lang.Class-"><code>TupleBinding.getPrimitiveBinding(java.lang.Class&lt;T&gt;)</code></a> method.</li>
</ol></div>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="package-summary.html#integerFormats">Integer Formats</a></dd>
</dl>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor.summary">
<!-- -->
</a>
<h3>Constructor Summary</h3>
<table class="memberSummary" summary="Constructor Summary table, listing constructors, and an explanation">
<caption><span>Constructors</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Constructor</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tr class="altColor">
<th class="colConstructorName" scope="row"><code><span class="memberNameLink"><a href="#ShortBinding--">ShortBinding</a></span>()</code></th>
<td class="colLast">&nbsp;</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" summary="Method Summary table, listing methods, and an explanation">
<caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd">&nbsp;</span></span><span id="t1" class="tableTab"><span><a href="javascript:show(1);">Static Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd">&nbsp;</span></span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colSecond" scope="col">Method</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tr id="i0" class="altColor">
<td class="colFirst"><code>java.lang.Short</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#entryToObject-com.sleepycat.bind.tuple.TupleInput-">entryToObject</a></span>&#8203;(<a href="TupleInput.html" title="class in com.sleepycat.bind.tuple">TupleInput</a>&nbsp;input)</code></th>
<td class="colLast">
<div class="block">Constructs a key or data object from a <a href="TupleInput.html" title="class in com.sleepycat.bind.tuple"><code>TupleInput</code></a> entry.</div>
</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code>static short</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#entryToShort-com.sleepycat.db.DatabaseEntry-">entryToShort</a></span>&#8203;(<a href="../../db/DatabaseEntry.html" title="class in com.sleepycat.db">DatabaseEntry</a>&nbsp;entry)</code></th>
<td class="colLast">
<div class="block">Converts an entry buffer into a simple <code>short</code> value.</div>
</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code>protected <a href="TupleOutput.html" title="class in com.sleepycat.bind.tuple">TupleOutput</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getTupleOutput-java.lang.Short-">getTupleOutput</a></span>&#8203;(java.lang.Short&nbsp;object)</code></th>
<td class="colLast">
<div class="block">Returns an empty TupleOutput instance that will be used by the tuple
binding or key creator.</div>
</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code>void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#objectToEntry-java.lang.Short-com.sleepycat.bind.tuple.TupleOutput-">objectToEntry</a></span>&#8203;(java.lang.Short&nbsp;object,
<a href="TupleOutput.html" title="class in com.sleepycat.bind.tuple">TupleOutput</a>&nbsp;output)</code></th>
<td class="colLast">
<div class="block">Converts a key or data object to a tuple entry.</div>
</td>
</tr>
<tr id="i4" class="altColor">
<td class="colFirst"><code>static void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#shortToEntry-short-com.sleepycat.db.DatabaseEntry-">shortToEntry</a></span>&#8203;(short&nbsp;val,
<a href="../../db/DatabaseEntry.html" title="class in com.sleepycat.db">DatabaseEntry</a>&nbsp;entry)</code></th>
<td class="colLast">
<div class="block">Converts a simple <code>short</code> value into an entry buffer.</div>
</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.com.sleepycat.bind.tuple.TupleBinding">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;com.sleepycat.bind.tuple.<a href="TupleBinding.html" title="class in com.sleepycat.bind.tuple">TupleBinding</a></h3>
<code><a href="TupleBinding.html#entryToObject-com.sleepycat.db.DatabaseEntry-">entryToObject</a>, <a href="TupleBinding.html#getPrimitiveBinding-java.lang.Class-">getPrimitiveBinding</a>, <a href="TupleBinding.html#objectToEntry-E-com.sleepycat.db.DatabaseEntry-">objectToEntry</a></code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.com.sleepycat.bind.tuple.TupleBase">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;com.sleepycat.bind.tuple.<a href="TupleBase.html" title="class in com.sleepycat.bind.tuple">TupleBase</a></h3>
<code><a href="TupleBase.html#entryToInput-com.sleepycat.db.DatabaseEntry-">entryToInput</a>, <a href="TupleBase.html#getTupleBufferSize--">getTupleBufferSize</a>, <a href="TupleBase.html#inputToEntry-com.sleepycat.bind.tuple.TupleInput-com.sleepycat.db.DatabaseEntry-">inputToEntry</a>, <a href="TupleBase.html#newOutput--">newOutput</a>, <a href="TupleBase.html#newOutput-byte:A-">newOutput</a>, <a href="TupleBase.html#outputToEntry-com.sleepycat.bind.tuple.TupleOutput-com.sleepycat.db.DatabaseEntry-">outputToEntry</a>, <a href="TupleBase.html#setTupleBufferSize-int-">setTupleBufferSize</a></code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.java.lang.Object">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;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="ShortBinding--">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>ShortBinding</h4>
<pre>public&nbsp;ShortBinding()</pre>
</li>
</ul>
</li>
</ul>
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method.detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="entryToObject-com.sleepycat.bind.tuple.TupleInput-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>entryToObject</h4>
<pre class="methodSignature">public&nbsp;java.lang.Short&nbsp;entryToObject&#8203;(<a href="TupleInput.html" title="class in com.sleepycat.bind.tuple">TupleInput</a>&nbsp;input)</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from class:&nbsp;<code><a href="TupleBinding.html#entryToObject-com.sleepycat.bind.tuple.TupleInput-">TupleBinding</a></code></span></div>
<div class="block">Constructs a key or data object from a <a href="TupleInput.html" title="class in com.sleepycat.bind.tuple"><code>TupleInput</code></a> entry.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="TupleBinding.html#entryToObject-com.sleepycat.bind.tuple.TupleInput-">entryToObject</a></code>&nbsp;in class&nbsp;<code><a href="TupleBinding.html" title="class in com.sleepycat.bind.tuple">TupleBinding</a>&lt;java.lang.Short&gt;</code></dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>input</code> - is the tuple key or data entry.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the key or data object constructed from the entry.</dd>
</dl>
</li>
</ul>
<a name="objectToEntry-java.lang.Short-com.sleepycat.bind.tuple.TupleOutput-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>objectToEntry</h4>
<pre class="methodSignature">public&nbsp;void&nbsp;objectToEntry&#8203;(java.lang.Short&nbsp;object,
<a href="TupleOutput.html" title="class in com.sleepycat.bind.tuple">TupleOutput</a>&nbsp;output)</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from class:&nbsp;<code><a href="TupleBinding.html#objectToEntry-E-com.sleepycat.bind.tuple.TupleOutput-">TupleBinding</a></code></span></div>
<div class="block">Converts a key or data object to a tuple entry.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="TupleBinding.html#objectToEntry-E-com.sleepycat.bind.tuple.TupleOutput-">objectToEntry</a></code>&nbsp;in class&nbsp;<code><a href="TupleBinding.html" title="class in com.sleepycat.bind.tuple">TupleBinding</a>&lt;java.lang.Short&gt;</code></dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>object</code> - is the key or data object.</dd>
<dd><code>output</code> - is the tuple entry to which the key or data should be
written.</dd>
</dl>
</li>
</ul>
<a name="getTupleOutput-java.lang.Short-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getTupleOutput</h4>
<pre class="methodSignature">protected&nbsp;<a href="TupleOutput.html" title="class in com.sleepycat.bind.tuple">TupleOutput</a>&nbsp;getTupleOutput&#8203;(java.lang.Short&nbsp;object)</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from class:&nbsp;<code><a href="TupleBase.html#getTupleOutput-E-">TupleBase</a></code></span></div>
<div class="block">Returns an empty TupleOutput instance that will be used by the tuple
binding or key creator.
<p>The default implementation of this method creates a new TupleOutput
with an initial buffer size that can be changed using the <a href="TupleBase.html#setTupleBufferSize-int-"><code>TupleBase.setTupleBufferSize(int)</code></a> method.</p>
<p>This method may be overridden to return a TupleOutput instance. For
example, an instance per thread could be created and returned by this
method. If a TupleOutput instance is reused, be sure to call its
<a href="../../util/FastOutputStream.html#reset--"><code>FastOutputStream.reset()</code></a> method before each
use.</p></div>
<dl>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code><a href="TupleBase.html#getTupleOutput-E-">getTupleOutput</a></code>&nbsp;in class&nbsp;<code><a href="TupleBase.html" title="class in com.sleepycat.bind.tuple">TupleBase</a>&lt;java.lang.Short&gt;</code></dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>object</code> - is the object to be written to the tuple output, and may
be used by subclasses to determine the size of the output buffer.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>an empty TupleOutput instance.</dd>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="TupleBase.html#setTupleBufferSize-int-"><code>TupleBase.setTupleBufferSize(int)</code></a></dd>
</dl>
</li>
</ul>
<a name="entryToShort-com.sleepycat.db.DatabaseEntry-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>entryToShort</h4>
<pre class="methodSignature">public static&nbsp;short&nbsp;entryToShort&#8203;(<a href="../../db/DatabaseEntry.html" title="class in com.sleepycat.db">DatabaseEntry</a>&nbsp;entry)</pre>
<div class="block">Converts an entry buffer into a simple <code>short</code> value.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>entry</code> - is the source entry buffer.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the resulting value.</dd>
</dl>
</li>
</ul>
<a name="shortToEntry-short-com.sleepycat.db.DatabaseEntry-">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>shortToEntry</h4>
<pre class="methodSignature">public static&nbsp;void&nbsp;shortToEntry&#8203;(short&nbsp;val,
<a href="../../db/DatabaseEntry.html" title="class in com.sleepycat.db">DatabaseEntry</a>&nbsp;entry)</pre>
<div class="block">Converts a simple <code>short</code> value into an entry buffer.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>val</code> - is the source value.</dd>
<dd><code>entry</code> - is the destination entry buffer.</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="../../../../index.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="class-use/ShortBinding.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</b><br><font size="-1"> version 18.1.40</font></div>
</div>
<div class="subNav">
<ul class="navList" id="allclasses_navbar_bottom">
<li><a href="../../../../allclasses.html">All&nbsp;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>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li><a href="#constructor.summary">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li><a href="#constructor.detail">Constr</a>&nbsp;|&nbsp;</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) 1996, 2020 Oracle and/or its affiliates. All rights reserved.</font></small></p>
</body>
</html>