<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> <!-- NewPage --> <html lang="en"> <head> <!-- Generated by javadoc (version 1.7.0_45) on Thu Jan 09 22:45:26 GMT 2014 --> <title>FloatBinding</title> <meta name="date" content="2014-01-09"> <link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style"> </head> <body> <script type="text/javascript"><!-- if (location.href.indexOf('is-external=true') == -1) { parent.document.title="FloatBinding"; } //--> </script> <noscript> <div>JavaScript is disabled on your browser.</div> </noscript> <!-- ========= START OF TOP NAVBAR ======= --> <div class="topNav"><a name="navbar_top"> <!-- --> </a><a href="#skip-navbar_top" title="Skip navigation links"></a><a name="navbar_top_firstrow"> <!-- --> </a> <ul class="navList" title="Navigation"> <li><a href="../../../../overview-summary.html">Overview</a></li> <li><a href="package-summary.html">Package</a></li> <li class="navBarCell1Rev">Class</li> <li><a href="package-tree.html">Tree</a></li> <li><a href="../../../../deprecated-list.html">Deprecated</a></li> <li><a href="../../../../index-all.html">Index</a></li> <li><a href="../../../../help-doc.html">Help</a></li> </ul> </div> <div class="subNav"> <ul class="navList"> <li><a href="../../../../com/sleepycat/bind/tuple/DoubleBinding.html" title="class in com.sleepycat.bind.tuple"><span class="strong">Prev Class</span></a></li> <li><a href="../../../../com/sleepycat/bind/tuple/IntegerBinding.html" title="class in com.sleepycat.bind.tuple"><span class="strong">Next Class</span></a></li> </ul> <ul class="navList"> <li><a href="../../../../index.html?com/sleepycat/bind/tuple/FloatBinding.html" target="_top">Frames</a></li> <li><a href="FloatBinding.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>Field | </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 FloatBinding" class="title">Class FloatBinding</h2> </div> <div class="contentContainer"> <ul class="inheritance"> <li>java.lang.Object</li> <li> <ul class="inheritance"> <li><a href="../../../../com/sleepycat/bind/tuple/TupleBase.html" title="class in com.sleepycat.bind.tuple">com.sleepycat.bind.tuple.TupleBase</a><E></li> <li> <ul class="inheritance"> <li><a href="../../../../com/sleepycat/bind/tuple/TupleBinding.html" title="class in com.sleepycat.bind.tuple">com.sleepycat.bind.tuple.TupleBinding</a><java.lang.Float></li> <li> <ul class="inheritance"> <li>com.sleepycat.bind.tuple.FloatBinding</li> </ul> </li> </ul> </li> </ul> </li> </ul> <div class="description"> <ul class="blockList"> <li class="blockList"> <dl> <dt>All Implemented Interfaces:</dt> <dd><a href="../../../../com/sleepycat/bind/EntryBinding.html" title="interface in com.sleepycat.bind">EntryBinding</a><java.lang.Float></dd> </dl> <hr> <br> <pre>public class <span class="strong">FloatBinding</span> extends <a href="../../../../com/sleepycat/bind/tuple/TupleBinding.html" title="class in com.sleepycat.bind.tuple">TupleBinding</a><java.lang.Float></pre> <div class="block">A concrete <code>TupleBinding</code> for a <code>Float</code> primitive wrapper or a <code>float</code> primitive. <p><em>Note:</em> This class produces byte array values that by default (without a custom comparator) do <em>not</em> sort correctly for negative values. Only non-negative values are sorted correctly by default. To sort all values correctly by default, use <a href="../../../../com/sleepycat/bind/tuple/SortedFloatBinding.html" title="class in com.sleepycat.bind.tuple"><code>SortedFloatBinding</code></a>.</p> <p>There are two ways to use this class:</p> <ol> <li>When using the <code>com.sleepycat.db</code> package directly, the static methods in this class can be used to convert between primitive values and <a href="../../../../com/sleepycat/db/DatabaseEntry.html" title="class in com.sleepycat.db"><code>DatabaseEntry</code></a> objects.</li> <li>When using the <code>com.sleepycat.collections</code> 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="../../../../com/sleepycat/bind/tuple/TupleBinding.html#getPrimitiveBinding(java.lang.Class)"><code>TupleBinding.getPrimitiveBinding(java.lang.Class<T>)</code></a> method.</li> </ol></div> </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="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation"> <caption><span>Constructors</span><span class="tabEnd"> </span></caption> <tr> <th class="colOne" scope="col">Constructor and Description</th> </tr> <tr class="altColor"> <td class="colOne"><code><strong><a href="../../../../com/sleepycat/bind/tuple/FloatBinding.html#FloatBinding()">FloatBinding</a></strong>()</code> </td> </tr> </table> </li> </ul> <!-- ========== METHOD SUMMARY =========== --> <ul class="blockList"> <li class="blockList"><a name="method_summary"> <!-- --> </a> <h3>Method Summary</h3> <table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation"> <caption><span>Methods</span><span class="tabEnd"> </span></caption> <tr> <th class="colFirst" scope="col">Modifier and Type</th> <th class="colLast" scope="col">Method and Description</th> </tr> <tr class="altColor"> <td class="colFirst"><code>static float</code></td> <td class="colLast"><code><strong><a href="../../../../com/sleepycat/bind/tuple/FloatBinding.html#entryToFloat(com.sleepycat.db.DatabaseEntry)">entryToFloat</a></strong>(<a href="../../../../com/sleepycat/db/DatabaseEntry.html" title="class in com.sleepycat.db">DatabaseEntry</a> entry)</code> <div class="block">Converts an entry buffer into a simple <code>float</code> value.</div> </td> </tr> <tr class="rowColor"> <td class="colFirst"><code>java.lang.Float</code></td> <td class="colLast"><code><strong><a href="../../../../com/sleepycat/bind/tuple/FloatBinding.html#entryToObject(com.sleepycat.bind.tuple.TupleInput)">entryToObject</a></strong>(<a href="../../../../com/sleepycat/bind/tuple/TupleInput.html" title="class in com.sleepycat.bind.tuple">TupleInput</a> input)</code> <div class="block">Constructs a key or data object from a <a href="../../../../com/sleepycat/bind/tuple/TupleInput.html" title="class in com.sleepycat.bind.tuple"><code>TupleInput</code></a> entry.</div> </td> </tr> <tr class="altColor"> <td class="colFirst"><code>static void</code></td> <td class="colLast"><code><strong><a href="../../../../com/sleepycat/bind/tuple/FloatBinding.html#floatToEntry(float, com.sleepycat.db.DatabaseEntry)">floatToEntry</a></strong>(float val, <a href="../../../../com/sleepycat/db/DatabaseEntry.html" title="class in com.sleepycat.db">DatabaseEntry</a> entry)</code> <div class="block">Converts a simple <code>float</code> value into an entry buffer.</div> </td> </tr> <tr class="rowColor"> <td class="colFirst"><code>protected <a href="../../../../com/sleepycat/bind/tuple/TupleOutput.html" title="class in com.sleepycat.bind.tuple">TupleOutput</a></code></td> <td class="colLast"><code><strong><a href="../../../../com/sleepycat/bind/tuple/FloatBinding.html#getTupleOutput(java.lang.Float)">getTupleOutput</a></strong>(java.lang.Float object)</code> <div class="block">Returns an empty TupleOutput instance that will be used by the tuple binding or key creator.</div> </td> </tr> <tr class="altColor"> <td class="colFirst"><code>void</code></td> <td class="colLast"><code><strong><a href="../../../../com/sleepycat/bind/tuple/FloatBinding.html#objectToEntry(java.lang.Float, com.sleepycat.bind.tuple.TupleOutput)">objectToEntry</a></strong>(java.lang.Float object, <a href="../../../../com/sleepycat/bind/tuple/TupleOutput.html" title="class in com.sleepycat.bind.tuple">TupleOutput</a> output)</code> <div class="block">Converts a key or data object to a tuple entry.</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 com.sleepycat.bind.tuple.<a href="../../../../com/sleepycat/bind/tuple/TupleBinding.html" title="class in com.sleepycat.bind.tuple">TupleBinding</a></h3> <code><a href="../../../../com/sleepycat/bind/tuple/TupleBinding.html#entryToObject(com.sleepycat.db.DatabaseEntry)">entryToObject</a>, <a href="../../../../com/sleepycat/bind/tuple/TupleBinding.html#getPrimitiveBinding(java.lang.Class)">getPrimitiveBinding</a>, <a href="../../../../com/sleepycat/bind/tuple/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 com.sleepycat.bind.tuple.<a href="../../../../com/sleepycat/bind/tuple/TupleBase.html" title="class in com.sleepycat.bind.tuple">TupleBase</a></h3> <code><a href="../../../../com/sleepycat/bind/tuple/TupleBase.html#entryToInput(com.sleepycat.db.DatabaseEntry)">entryToInput</a>, <a href="../../../../com/sleepycat/bind/tuple/TupleBase.html#getTupleBufferSize()">getTupleBufferSize</a>, <a href="../../../../com/sleepycat/bind/tuple/TupleBase.html#inputToEntry(com.sleepycat.bind.tuple.TupleInput, com.sleepycat.db.DatabaseEntry)">inputToEntry</a>, <a href="../../../../com/sleepycat/bind/tuple/TupleBase.html#newOutput()">newOutput</a>, <a href="../../../../com/sleepycat/bind/tuple/TupleBase.html#newOutput(byte[])">newOutput</a>, <a href="../../../../com/sleepycat/bind/tuple/TupleBase.html#outputToEntry(com.sleepycat.bind.tuple.TupleOutput, com.sleepycat.db.DatabaseEntry)">outputToEntry</a>, <a href="../../../../com/sleepycat/bind/tuple/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 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="FloatBinding()"> <!-- --> </a> <ul class="blockListLast"> <li class="blockList"> <h4>FloatBinding</h4> <pre>public FloatBinding()</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>public java.lang.Float entryToObject(<a href="../../../../com/sleepycat/bind/tuple/TupleInput.html" title="class in com.sleepycat.bind.tuple">TupleInput</a> input)</pre> <div class="block"><strong>Description copied from class: <code><a href="../../../../com/sleepycat/bind/tuple/TupleBinding.html#entryToObject(com.sleepycat.bind.tuple.TupleInput)">TupleBinding</a></code></strong></div> <div class="block">Constructs a key or data object from a <a href="../../../../com/sleepycat/bind/tuple/TupleInput.html" title="class in com.sleepycat.bind.tuple"><code>TupleInput</code></a> entry.</div> <dl> <dt><strong>Specified by:</strong></dt> <dd><code><a href="../../../../com/sleepycat/bind/tuple/TupleBinding.html#entryToObject(com.sleepycat.bind.tuple.TupleInput)">entryToObject</a></code> in class <code><a href="../../../../com/sleepycat/bind/tuple/TupleBinding.html" title="class in com.sleepycat.bind.tuple">TupleBinding</a><java.lang.Float></code></dd> <dt><span class="strong">Parameters:</span></dt><dd><code>input</code> - is the tuple key or data entry.</dd> <dt><span class="strong">Returns:</span></dt><dd>the key or data object constructed from the entry.</dd></dl> </li> </ul> <a name="objectToEntry(java.lang.Float, com.sleepycat.bind.tuple.TupleOutput)"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>objectToEntry</h4> <pre>public void objectToEntry(java.lang.Float object, <a href="../../../../com/sleepycat/bind/tuple/TupleOutput.html" title="class in com.sleepycat.bind.tuple">TupleOutput</a> output)</pre> <div class="block"><strong>Description copied from class: <code><a href="../../../../com/sleepycat/bind/tuple/TupleBinding.html#objectToEntry(E, com.sleepycat.bind.tuple.TupleOutput)">TupleBinding</a></code></strong></div> <div class="block">Converts a key or data object to a tuple entry.</div> <dl> <dt><strong>Specified by:</strong></dt> <dd><code><a href="../../../../com/sleepycat/bind/tuple/TupleBinding.html#objectToEntry(E, com.sleepycat.bind.tuple.TupleOutput)">objectToEntry</a></code> in class <code><a href="../../../../com/sleepycat/bind/tuple/TupleBinding.html" title="class in com.sleepycat.bind.tuple">TupleBinding</a><java.lang.Float></code></dd> <dt><span class="strong">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.Float)"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>getTupleOutput</h4> <pre>protected <a href="../../../../com/sleepycat/bind/tuple/TupleOutput.html" title="class in com.sleepycat.bind.tuple">TupleOutput</a> getTupleOutput(java.lang.Float object)</pre> <div class="block"><strong>Description copied from class: <code><a href="../../../../com/sleepycat/bind/tuple/TupleBase.html#getTupleOutput(E)">TupleBase</a></code></strong></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="../../../../com/sleepycat/bind/tuple/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="../../../../com/sleepycat/util/FastOutputStream.html#reset()"><code>FastOutputStream.reset()</code></a> method before each use.</p></div> <dl> <dt><strong>Overrides:</strong></dt> <dd><code><a href="../../../../com/sleepycat/bind/tuple/TupleBase.html#getTupleOutput(E)">getTupleOutput</a></code> in class <code><a href="../../../../com/sleepycat/bind/tuple/TupleBase.html" title="class in com.sleepycat.bind.tuple">TupleBase</a><java.lang.Float></code></dd> <dt><span class="strong">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="strong">Returns:</span></dt><dd>an empty TupleOutput instance.</dd><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../com/sleepycat/bind/tuple/TupleBase.html#setTupleBufferSize(int)"><code>TupleBase.setTupleBufferSize(int)</code></a></dd></dl> </li> </ul> <a name="entryToFloat(com.sleepycat.db.DatabaseEntry)"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>entryToFloat</h4> <pre>public static float entryToFloat(<a href="../../../../com/sleepycat/db/DatabaseEntry.html" title="class in com.sleepycat.db">DatabaseEntry</a> entry)</pre> <div class="block">Converts an entry buffer into a simple <code>float</code> value.</div> <dl><dt><span class="strong">Parameters:</span></dt><dd><code>entry</code> - is the source entry buffer.</dd> <dt><span class="strong">Returns:</span></dt><dd>the resulting value.</dd></dl> </li> </ul> <a name="floatToEntry(float, com.sleepycat.db.DatabaseEntry)"> <!-- --> </a> <ul class="blockListLast"> <li class="blockList"> <h4>floatToEntry</h4> <pre>public static void floatToEntry(float val, <a href="../../../../com/sleepycat/db/DatabaseEntry.html" title="class in com.sleepycat.db">DatabaseEntry</a> entry)</pre> <div class="block">Converts a simple <code>float</code> value into an entry buffer.</div> <dl><dt><span class="strong">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><a href="#skip-navbar_bottom" title="Skip navigation links"></a><a name="navbar_bottom_firstrow"> <!-- --> </a> <ul class="navList" title="Navigation"> <li><a href="../../../../overview-summary.html">Overview</a></li> <li><a href="package-summary.html">Package</a></li> <li class="navBarCell1Rev">Class</li> <li><a href="package-tree.html">Tree</a></li> <li><a href="../../../../deprecated-list.html">Deprecated</a></li> <li><a href="../../../../index-all.html">Index</a></li> <li><a href="../../../../help-doc.html">Help</a></li> </ul> </div> <div class="subNav"> <ul class="navList"> <li><a href="../../../../com/sleepycat/bind/tuple/DoubleBinding.html" title="class in com.sleepycat.bind.tuple"><span class="strong">Prev Class</span></a></li> <li><a href="../../../../com/sleepycat/bind/tuple/IntegerBinding.html" title="class in com.sleepycat.bind.tuple"><span class="strong">Next Class</span></a></li> </ul> <ul class="navList"> <li><a href="../../../../index.html?com/sleepycat/bind/tuple/FloatBinding.html" target="_top">Frames</a></li> <li><a href="FloatBinding.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>Field | </li> <li><a href="#constructor_summary">Constr</a> | </li> <li><a href="#method_summary">Method</a></li> </ul> <ul class="subNavList"> <li>Detail: </li> <li>Field | </li> <li><a href="#constructor_detail">Constr</a> | </li> <li><a href="#method_detail">Method</a></li> </ul> </div> <a name="skip-navbar_bottom"> <!-- --> </a></div> <!-- ======== END OF BOTTOM NAVBAR ======= --> </body> </html>