<!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:24 GMT 2014 --> <title>EntityOutput</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="EntityOutput"; } //--> </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/persist/impl/EntityInput.html" title="interface in com.sleepycat.persist.impl"><span class="strong">Prev Class</span></a></li> <li><a href="../../../../com/sleepycat/persist/impl/EnumFormat.html" title="class in com.sleepycat.persist.impl"><span class="strong">Next Class</span></a></li> </ul> <ul class="navList"> <li><a href="../../../../index.html?com/sleepycat/persist/impl/EntityOutput.html" target="_top">Frames</a></li> <li><a href="EntityOutput.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>Constr | </li> <li><a href="#method_summary">Method</a></li> </ul> <ul class="subNavList"> <li>Detail: </li> <li>Field | </li> <li>Constr | </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.persist.impl</div> <h2 title="Interface EntityOutput" class="title">Interface EntityOutput</h2> </div> <div class="contentContainer"> <div class="description"> <ul class="blockList"> <li class="blockList"> <hr> <br> <pre>public interface <span class="strong">EntityOutput</span></pre> <div class="block">Used for writing object fields. <p>Unlike TupleOutput, Strings should be passed to <a href="../../../../com/sleepycat/persist/impl/EntityOutput.html#writeObject(java.lang.Object, com.sleepycat.persist.impl.Format)"><code>writeObject(java.lang.Object, com.sleepycat.persist.impl.Format)</code></a> when using this class.</p> <p>Note that currently there is only one implementation of EntityOutput: RecordOutput. There is no RawObjectOutput implemention because we currently have no need to convert from persistent objects to RawObject instances. The EntityOutput interface is only for symmetry with EntityInput and in case we need RawObjectOutput in the future.</p></div> </li> </ul> </div> <div class="summary"> <ul class="blockList"> <li class="blockList"> <!-- ========== 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>void</code></td> <td class="colLast"><code><strong><a href="../../../../com/sleepycat/persist/impl/EntityOutput.html#registerPriKeyObject(java.lang.Object)">registerPriKeyObject</a></strong>(java.lang.Object o)</code> <div class="block">Called via Accessor.writeSecKeyFields for a primary key field with a reference type.</div> </td> </tr> <tr class="rowColor"> <td class="colFirst"><code>void</code></td> <td class="colLast"><code><strong><a href="../../../../com/sleepycat/persist/impl/EntityOutput.html#writeArrayLength(int)">writeArrayLength</a></strong>(int length)</code> <div class="block">Called by ObjectArrayFormat and PrimitiveArrayFormat to write the array length.</div> </td> </tr> <tr class="altColor"> <td class="colFirst"><code><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/persist/impl/EntityOutput.html#writeBigInteger(java.math.BigInteger)">writeBigInteger</a></strong>(java.math.BigInteger val)</code> </td> </tr> <tr class="rowColor"> <td class="colFirst"><code><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/persist/impl/EntityOutput.html#writeBoolean(boolean)">writeBoolean</a></strong>(boolean val)</code> </td> </tr> <tr class="altColor"> <td class="colFirst"><code><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/persist/impl/EntityOutput.html#writeByte(int)">writeByte</a></strong>(int val)</code> </td> </tr> <tr class="rowColor"> <td class="colFirst"><code><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/persist/impl/EntityOutput.html#writeChar(int)">writeChar</a></strong>(int val)</code> </td> </tr> <tr class="altColor"> <td class="colFirst"><code>void</code></td> <td class="colLast"><code><strong><a href="../../../../com/sleepycat/persist/impl/EntityOutput.html#writeEnumConstant(java.lang.String[], int)">writeEnumConstant</a></strong>(java.lang.String[] names, int index)</code> <div class="block">Called by EnumFormat to write the given index of the enum constant.</div> </td> </tr> <tr class="rowColor"> <td class="colFirst"><code><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/persist/impl/EntityOutput.html#writeInt(int)">writeInt</a></strong>(int val)</code> </td> </tr> <tr class="altColor"> <td class="colFirst"><code>void</code></td> <td class="colLast"><code><strong><a href="../../../../com/sleepycat/persist/impl/EntityOutput.html#writeKeyObject(java.lang.Object, com.sleepycat.persist.impl.Format)">writeKeyObject</a></strong>(java.lang.Object o, <a href="../../../../com/sleepycat/persist/impl/Format.html" title="class in com.sleepycat.persist.impl">Format</a> fieldFormat)</code> <div class="block">Called for a primary key field or composite key field with a reference type.</div> </td> </tr> <tr class="rowColor"> <td class="colFirst"><code><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/persist/impl/EntityOutput.html#writeLong(long)">writeLong</a></strong>(long val)</code> </td> </tr> <tr class="altColor"> <td class="colFirst"><code>void</code></td> <td class="colLast"><code><strong><a href="../../../../com/sleepycat/persist/impl/EntityOutput.html#writeObject(java.lang.Object, com.sleepycat.persist.impl.Format)">writeObject</a></strong>(java.lang.Object o, <a href="../../../../com/sleepycat/persist/impl/Format.html" title="class in com.sleepycat.persist.impl">Format</a> fieldFormat)</code> <div class="block">Called via Accessor to write all fields with reference types, except for the primary key field and composite key fields (see writeKeyObject below).</div> </td> </tr> <tr class="rowColor"> <td class="colFirst"><code><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/persist/impl/EntityOutput.html#writeShort(int)">writeShort</a></strong>(int val)</code> </td> </tr> <tr class="altColor"> <td class="colFirst"><code><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/persist/impl/EntityOutput.html#writeSortedDouble(double)">writeSortedDouble</a></strong>(double val)</code> </td> </tr> <tr class="rowColor"> <td class="colFirst"><code><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/persist/impl/EntityOutput.html#writeSortedFloat(float)">writeSortedFloat</a></strong>(float val)</code> </td> </tr> <tr class="altColor"> <td class="colFirst"><code><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/persist/impl/EntityOutput.html#writeString(java.lang.String)">writeString</a></strong>(java.lang.String val)</code> </td> </tr> </table> </li> </ul> </li> </ul> </div> <div class="details"> <ul class="blockList"> <li class="blockList"> <!-- ============ METHOD DETAIL ========== --> <ul class="blockList"> <li class="blockList"><a name="method_detail"> <!-- --> </a> <h3>Method Detail</h3> <a name="writeObject(java.lang.Object, com.sleepycat.persist.impl.Format)"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>writeObject</h4> <pre>void writeObject(java.lang.Object o, <a href="../../../../com/sleepycat/persist/impl/Format.html" title="class in com.sleepycat.persist.impl">Format</a> fieldFormat)</pre> <div class="block">Called via Accessor to write all fields with reference types, except for the primary key field and composite key fields (see writeKeyObject below).</div> </li> </ul> <a name="writeKeyObject(java.lang.Object, com.sleepycat.persist.impl.Format)"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>writeKeyObject</h4> <pre>void writeKeyObject(java.lang.Object o, <a href="../../../../com/sleepycat/persist/impl/Format.html" title="class in com.sleepycat.persist.impl">Format</a> fieldFormat)</pre> <div class="block">Called for a primary key field or composite key field with a reference type.</div> </li> </ul> <a name="registerPriKeyObject(java.lang.Object)"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>registerPriKeyObject</h4> <pre>void registerPriKeyObject(java.lang.Object o)</pre> <div class="block">Called via Accessor.writeSecKeyFields for a primary key field with a reference type. This method must be called before writing any other fields.</div> </li> </ul> <a name="writeArrayLength(int)"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>writeArrayLength</h4> <pre>void writeArrayLength(int length)</pre> <div class="block">Called by ObjectArrayFormat and PrimitiveArrayFormat to write the array length.</div> </li> </ul> <a name="writeEnumConstant(java.lang.String[], int)"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>writeEnumConstant</h4> <pre>void writeEnumConstant(java.lang.String[] names, int index)</pre> <div class="block">Called by EnumFormat to write the given index of the enum constant.</div> </li> </ul> <a name="writeString(java.lang.String)"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>writeString</h4> <pre><a href="../../../../com/sleepycat/bind/tuple/TupleOutput.html" title="class in com.sleepycat.bind.tuple">TupleOutput</a> writeString(java.lang.String val)</pre> </li> </ul> <a name="writeChar(int)"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>writeChar</h4> <pre><a href="../../../../com/sleepycat/bind/tuple/TupleOutput.html" title="class in com.sleepycat.bind.tuple">TupleOutput</a> writeChar(int val)</pre> </li> </ul> <a name="writeBoolean(boolean)"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>writeBoolean</h4> <pre><a href="../../../../com/sleepycat/bind/tuple/TupleOutput.html" title="class in com.sleepycat.bind.tuple">TupleOutput</a> writeBoolean(boolean val)</pre> </li> </ul> <a name="writeByte(int)"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>writeByte</h4> <pre><a href="../../../../com/sleepycat/bind/tuple/TupleOutput.html" title="class in com.sleepycat.bind.tuple">TupleOutput</a> writeByte(int val)</pre> </li> </ul> <a name="writeShort(int)"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>writeShort</h4> <pre><a href="../../../../com/sleepycat/bind/tuple/TupleOutput.html" title="class in com.sleepycat.bind.tuple">TupleOutput</a> writeShort(int val)</pre> </li> </ul> <a name="writeInt(int)"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>writeInt</h4> <pre><a href="../../../../com/sleepycat/bind/tuple/TupleOutput.html" title="class in com.sleepycat.bind.tuple">TupleOutput</a> writeInt(int val)</pre> </li> </ul> <a name="writeLong(long)"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>writeLong</h4> <pre><a href="../../../../com/sleepycat/bind/tuple/TupleOutput.html" title="class in com.sleepycat.bind.tuple">TupleOutput</a> writeLong(long val)</pre> </li> </ul> <a name="writeSortedFloat(float)"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>writeSortedFloat</h4> <pre><a href="../../../../com/sleepycat/bind/tuple/TupleOutput.html" title="class in com.sleepycat.bind.tuple">TupleOutput</a> writeSortedFloat(float val)</pre> </li> </ul> <a name="writeSortedDouble(double)"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>writeSortedDouble</h4> <pre><a href="../../../../com/sleepycat/bind/tuple/TupleOutput.html" title="class in com.sleepycat.bind.tuple">TupleOutput</a> writeSortedDouble(double val)</pre> </li> </ul> <a name="writeBigInteger(java.math.BigInteger)"> <!-- --> </a> <ul class="blockListLast"> <li class="blockList"> <h4>writeBigInteger</h4> <pre><a href="../../../../com/sleepycat/bind/tuple/TupleOutput.html" title="class in com.sleepycat.bind.tuple">TupleOutput</a> writeBigInteger(java.math.BigInteger val)</pre> </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/persist/impl/EntityInput.html" title="interface in com.sleepycat.persist.impl"><span class="strong">Prev Class</span></a></li> <li><a href="../../../../com/sleepycat/persist/impl/EnumFormat.html" title="class in com.sleepycat.persist.impl"><span class="strong">Next Class</span></a></li> </ul> <ul class="navList"> <li><a href="../../../../index.html?com/sleepycat/persist/impl/EntityOutput.html" target="_top">Frames</a></li> <li><a href="EntityOutput.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>Constr | </li> <li><a href="#method_summary">Method</a></li> </ul> <ul class="subNavList"> <li>Detail: </li> <li>Field | </li> <li>Constr | </li> <li><a href="#method_detail">Method</a></li> </ul> </div> <a name="skip-navbar_bottom"> <!-- --> </a></div> <!-- ======== END OF BOTTOM NAVBAR ======= --> </body> </html>