1<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
2<!--NewPage-->
3<HTML>
4<HEAD>
5<!-- Generated by javadoc (build 1.5.0) on Thu May 15 17:17:32 EDT 2008 -->
6<TITLE>
7TupleBase (Oracle - Berkeley DB Java API)
8</TITLE>
9
10<META NAME="keywords" CONTENT="com.sleepycat.bind.tuple.TupleBase class">
11
12<LINK REL ="stylesheet" TYPE="text/css" HREF="/style.css" TITLE="Style">
13
14<SCRIPT type="text/javascript">
15function windowTitle()
16{
17    parent.document.title="TupleBase (Oracle - Berkeley DB Java API)";
18}
19</SCRIPT>
20<NOSCRIPT>
21</NOSCRIPT>
22
23</HEAD>
24
25<BODY BGCOLOR="white" onload="windowTitle();">
26
27
28<!-- ========= START OF TOP NAVBAR ======= -->
29<A NAME="navbar_top"><!-- --></A>
30<A HREF="#skip-navbar_top" title="Skip navigation links"></A>
31<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
32<TR>
33<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
34<A NAME="navbar_top_firstrow"><!-- --></A>
35<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
36  <TR ALIGN="center" VALIGN="top">
37  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="/overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>
38  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
39  <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
40  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="class-use/TupleBase.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A>&nbsp;</TD>
41  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
42  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="/deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>
43  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="/index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
44  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="/help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
45  </TR>
46</TABLE>
47</TD>
48<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
49<b>Berkeley DB</b><br><font size="-1"> version 4.7.25</font></EM>
50</TD>
51</TR>
52
53<TR>
54<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
55&nbsp;<A HREF="/com/sleepycat/bind/tuple/StringBinding.html" title="class in com.sleepycat.bind.tuple"><B>PREV CLASS</B></A>&nbsp;
56&nbsp;<A HREF="/com/sleepycat/bind/tuple/TupleBinding.html" title="class in com.sleepycat.bind.tuple"><B>NEXT CLASS</B></A></FONT></TD>
57<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
58  <A HREF="/index.html?com/sleepycat/bind/tuple/TupleBase.html" target="_top"><B>FRAMES</B></A>  &nbsp;
59&nbsp;<A HREF="TupleBase.html" target="_top"><B>NO FRAMES</B></A>  &nbsp;
60&nbsp;<SCRIPT type="text/javascript">
61  <!--
62  if(window==top) {
63    document.writeln('<A HREF="/allclasses-noframe.html"><B>All Classes</B></A>');
64  }
65  //-->
66</SCRIPT>
67<NOSCRIPT>
68  <A HREF="/allclasses-noframe.html"><B>All Classes</B></A>
69</NOSCRIPT>
70
71
72</FONT></TD>
73</TR>
74<TR>
75<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
76  SUMMARY:&nbsp;NESTED&nbsp;|&nbsp;FIELD&nbsp;|&nbsp;<A HREF="#constructor_summary">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>
77<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
78DETAIL:&nbsp;FIELD&nbsp;|&nbsp;<A HREF="#constructor_detail">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></FONT></TD>
79</TR>
80</TABLE>
81<A NAME="skip-navbar_top"></A>
82<!-- ========= END OF TOP NAVBAR ========= -->
83
84<HR>
85<!-- ======== START OF CLASS DATA ======== -->
86<H2>
87<FONT SIZE="-1">
88com.sleepycat.bind.tuple</FONT>
89<BR>
90Class TupleBase</H2>
91<PRE>
92<A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Object.html" title="class or interface in java.lang">java.lang.Object</A>
93  <IMG SRC="/resources/inherit.gif" ALT="extended by "><B>com.sleepycat.bind.tuple.TupleBase</B>
94</PRE>
95<DL>
96<DT><B>Direct Known Subclasses:</B> <DD><A HREF="/com/sleepycat/bind/tuple/TupleBinding.html" title="class in com.sleepycat.bind.tuple">TupleBinding</A>, <A HREF="/com/sleepycat/bind/serial/TupleSerialBinding.html" title="class in com.sleepycat.bind.serial">TupleSerialBinding</A>, <A HREF="/com/sleepycat/bind/serial/TupleSerialKeyCreator.html" title="class in com.sleepycat.bind.serial">TupleSerialKeyCreator</A>, <A HREF="/com/sleepycat/bind/tuple/TupleTupleBinding.html" title="class in com.sleepycat.bind.tuple">TupleTupleBinding</A>, <A HREF="/com/sleepycat/bind/tuple/TupleTupleKeyCreator.html" title="class in com.sleepycat.bind.tuple">TupleTupleKeyCreator</A></DD>
97</DL>
98<HR>
99<DL>
100<DT><PRE>public class <B>TupleBase</B><DT>extends <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Object.html" title="class or interface in java.lang">Object</A></DL>
101</PRE>
102
103<P>
104A base class for tuple bindings and tuple key creators that provides control
105 over the allocation of the output buffer.
106
107 <p>Tuple bindings and key creators append data to a <A HREF="/com/sleepycat/bind/tuple/TupleOutput.html" title="class in com.sleepycat.bind.tuple"><CODE>TupleOutput</CODE></A>
108 instance, which is also a <A HREF="/com/sleepycat/util/FastOutputStream.html" title="class in com.sleepycat.util"><CODE>FastOutputStream</CODE></A>
109 instance.  This object has a byte array buffer that is resized when it is
110 full.  The reallocation of this buffer can be a performance factor for
111 some applications using large objects.  To manage this issue, the <A HREF="/com/sleepycat/bind/tuple/TupleBase.html#setTupleBufferSize(int)"><CODE>setTupleBufferSize(int)</CODE></A> method may be used to control the initial size of the
112 buffer, and the <A HREF="/com/sleepycat/bind/tuple/TupleBase.html#getTupleOutput(java.lang.Object)"><CODE>getTupleOutput(java.lang.Object)</CODE></A> method may be overridden by
113 subclasses to take over creation of the TupleOutput object.</p>
114<P>
115
116<P>
117<HR>
118
119<P>
120
121<!-- ======== CONSTRUCTOR SUMMARY ======== -->
122
123<A NAME="constructor_summary"><!-- --></A>
124<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
125<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
126<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
127<B>Constructor Summary</B></FONT></TH>
128</TR>
129<TR BGCOLOR="white" CLASS="TableRowColor">
130<TD><CODE><B><A HREF="/com/sleepycat/bind/tuple/TupleBase.html#TupleBase()">TupleBase</A></B>()</CODE>
131
132<BR>
133&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Initializes the initial output buffer size to zero.</TD>
134</TR>
135</TABLE>
136&nbsp;
137<!-- ========== METHOD SUMMARY =========== -->
138
139<A NAME="method_summary"><!-- --></A>
140<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
141<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
142<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
143<B>Method Summary</B></FONT></TH>
144</TR>
145<TR BGCOLOR="white" CLASS="TableRowColor">
146<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
147<CODE>static&nbsp;<A HREF="/com/sleepycat/bind/tuple/TupleInput.html" title="class in com.sleepycat.bind.tuple">TupleInput</A></CODE></FONT></TD>
148<TD><CODE><B><A HREF="/com/sleepycat/bind/tuple/TupleBase.html#entryToInput(com.sleepycat.db.DatabaseEntry)">entryToInput</A></B>(<A HREF="/com/sleepycat/db/DatabaseEntry.html" title="class in com.sleepycat.db">DatabaseEntry</A>&nbsp;entry)</CODE>
149
150<BR>
151&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Utility method to create a new tuple input object for reading the data
152 from a given buffer.</TD>
153</TR>
154<TR BGCOLOR="white" CLASS="TableRowColor">
155<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
156<CODE>&nbsp;int</CODE></FONT></TD>
157<TD><CODE><B><A HREF="/com/sleepycat/bind/tuple/TupleBase.html#getTupleBufferSize()">getTupleBufferSize</A></B>()</CODE>
158
159<BR>
160&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns the initial byte size of the output buffer.</TD>
161</TR>
162<TR BGCOLOR="white" CLASS="TableRowColor">
163<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
164<CODE>protected &nbsp;<A HREF="/com/sleepycat/bind/tuple/TupleOutput.html" title="class in com.sleepycat.bind.tuple">TupleOutput</A></CODE></FONT></TD>
165<TD><CODE><B><A HREF="/com/sleepycat/bind/tuple/TupleBase.html#getTupleOutput(java.lang.Object)">getTupleOutput</A></B>(<A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Object.html" title="class or interface in java.lang">Object</A>&nbsp;object)</CODE>
166
167<BR>
168&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns an empty TupleOutput instance that will be used by the tuple
169 binding or key creator.</TD>
170</TR>
171<TR BGCOLOR="white" CLASS="TableRowColor">
172<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
173<CODE>static&nbsp;void</CODE></FONT></TD>
174<TD><CODE><B><A HREF="/com/sleepycat/bind/tuple/TupleBase.html#inputToEntry(com.sleepycat.bind.tuple.TupleInput, com.sleepycat.db.DatabaseEntry)">inputToEntry</A></B>(<A HREF="/com/sleepycat/bind/tuple/TupleInput.html" title="class in com.sleepycat.bind.tuple">TupleInput</A>&nbsp;input,
175             <A HREF="/com/sleepycat/db/DatabaseEntry.html" title="class in com.sleepycat.db">DatabaseEntry</A>&nbsp;entry)</CODE>
176
177<BR>
178&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Utility method to set the data in a entry buffer to the data in a tuple
179 input object.</TD>
180</TR>
181<TR BGCOLOR="white" CLASS="TableRowColor">
182<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
183<CODE>static&nbsp;<A HREF="/com/sleepycat/bind/tuple/TupleOutput.html" title="class in com.sleepycat.bind.tuple">TupleOutput</A></CODE></FONT></TD>
184<TD><CODE><B><A HREF="/com/sleepycat/bind/tuple/TupleBase.html#newOutput()">newOutput</A></B>()</CODE>
185
186<BR>
187&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<B>Deprecated.</B>&nbsp;<I>replaced by <A HREF="/com/sleepycat/bind/tuple/TupleBase.html#getTupleOutput(java.lang.Object)"><CODE>getTupleOutput(java.lang.Object)</CODE></A></I></TD>
188</TR>
189<TR BGCOLOR="white" CLASS="TableRowColor">
190<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
191<CODE>static&nbsp;<A HREF="/com/sleepycat/bind/tuple/TupleOutput.html" title="class in com.sleepycat.bind.tuple">TupleOutput</A></CODE></FONT></TD>
192<TD><CODE><B><A HREF="/com/sleepycat/bind/tuple/TupleBase.html#newOutput(byte[])">newOutput</A></B>(byte[]&nbsp;buffer)</CODE>
193
194<BR>
195&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<B>Deprecated.</B>&nbsp;<I>replaced by <A HREF="/com/sleepycat/bind/tuple/TupleBase.html#getTupleOutput(java.lang.Object)"><CODE>getTupleOutput(java.lang.Object)</CODE></A></I></TD>
196</TR>
197<TR BGCOLOR="white" CLASS="TableRowColor">
198<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
199<CODE>static&nbsp;void</CODE></FONT></TD>
200<TD><CODE><B><A HREF="/com/sleepycat/bind/tuple/TupleBase.html#outputToEntry(com.sleepycat.bind.tuple.TupleOutput, com.sleepycat.db.DatabaseEntry)">outputToEntry</A></B>(<A HREF="/com/sleepycat/bind/tuple/TupleOutput.html" title="class in com.sleepycat.bind.tuple">TupleOutput</A>&nbsp;output,
201              <A HREF="/com/sleepycat/db/DatabaseEntry.html" title="class in com.sleepycat.db">DatabaseEntry</A>&nbsp;entry)</CODE>
202
203<BR>
204&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Utility method to set the data in a entry buffer to the data in a tuple
205 output object.</TD>
206</TR>
207<TR BGCOLOR="white" CLASS="TableRowColor">
208<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
209<CODE>&nbsp;void</CODE></FONT></TD>
210<TD><CODE><B><A HREF="/com/sleepycat/bind/tuple/TupleBase.html#setTupleBufferSize(int)">setTupleBufferSize</A></B>(int&nbsp;byteSize)</CODE>
211
212<BR>
213&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Sets the initial byte size of the output buffer that is allocated by the
214 default implementation of <A HREF="/com/sleepycat/bind/tuple/TupleBase.html#getTupleOutput(java.lang.Object)"><CODE>getTupleOutput(java.lang.Object)</CODE></A>.</TD>
215</TR>
216</TABLE>
217&nbsp;<A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A>
218<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
219<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
220<TH ALIGN="left"><B>Methods inherited from class java.lang.<A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Object.html" title="class or interface in java.lang">Object</A></B></TH>
221</TR>
222<TR BGCOLOR="white" CLASS="TableRowColor">
223<TD><CODE><A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Object.html#clone()" title="class or interface in java.lang">clone</A>, <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Object.html#equals(java.lang.Object)" title="class or interface in java.lang">equals</A>, <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Object.html#finalize()" title="class or interface in java.lang">finalize</A>, <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Object.html#getClass()" title="class or interface in java.lang">getClass</A>, <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Object.html#hashCode()" title="class or interface in java.lang">hashCode</A>, <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Object.html#notify()" title="class or interface in java.lang">notify</A>, <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Object.html#notifyAll()" title="class or interface in java.lang">notifyAll</A>, <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Object.html#toString()" title="class or interface in java.lang">toString</A>, <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Object.html#wait()" title="class or interface in java.lang">wait</A>, <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Object.html#wait(long)" title="class or interface in java.lang">wait</A>, <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Object.html#wait(long, int)" title="class or interface in java.lang">wait</A></CODE></TD>
224</TR>
225</TABLE>
226&nbsp;
227<P>
228
229<!-- ========= CONSTRUCTOR DETAIL ======== -->
230
231<A NAME="constructor_detail"><!-- --></A>
232<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
233<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
234<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
235<B>Constructor Detail</B></FONT></TH>
236</TR>
237</TABLE>
238
239<A NAME="TupleBase()"><!-- --></A><H3>
240TupleBase</H3>
241<PRE>
242public <B>TupleBase</B>()</PRE>
243<DL>
244<DD>Initializes the initial output buffer size to zero.
245
246 <p>Unless <A HREF="/com/sleepycat/bind/tuple/TupleBase.html#setTupleBufferSize(int)"><CODE>setTupleBufferSize(int)</CODE></A> is called, the default <A HREF="/com/sleepycat/util/FastOutputStream.html#DEFAULT_INIT_SIZE"><CODE>FastOutputStream.DEFAULT_INIT_SIZE</CODE></A> size will be
247 used.</p>
248<P>
249</DL>
250
251<!-- ============ METHOD DETAIL ========== -->
252
253<A NAME="method_detail"><!-- --></A>
254<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
255<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
256<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
257<B>Method Detail</B></FONT></TH>
258</TR>
259</TABLE>
260
261<A NAME="setTupleBufferSize(int)"><!-- --></A><H3>
262setTupleBufferSize</H3>
263<PRE>
264public void <B>setTupleBufferSize</B>(int&nbsp;byteSize)</PRE>
265<DL>
266<DD>Sets the initial byte size of the output buffer that is allocated by the
267 default implementation of <A HREF="/com/sleepycat/bind/tuple/TupleBase.html#getTupleOutput(java.lang.Object)"><CODE>getTupleOutput(java.lang.Object)</CODE></A>.
268
269 <p>If this property is zero (the default), the default <A HREF="/com/sleepycat/util/FastOutputStream.html#DEFAULT_INIT_SIZE"><CODE>FastOutputStream.DEFAULT_INIT_SIZE</CODE></A> size is used.</p>
270<P>
271<DD><DL>
272<DT><B>Parameters:</B><DD><CODE>byteSize</CODE> - the initial byte size of the output buffer, or zero to
273 use the default size.</DL>
274</DD>
275</DL>
276<HR>
277
278<A NAME="getTupleBufferSize()"><!-- --></A><H3>
279getTupleBufferSize</H3>
280<PRE>
281public int <B>getTupleBufferSize</B>()</PRE>
282<DL>
283<DD>Returns the initial byte size of the output buffer.
284<P>
285<DD><DL>
286
287<DT><B>Returns:</B><DD>the initial byte size of the output buffer.<DT><B>See Also:</B><DD><A HREF="/com/sleepycat/bind/tuple/TupleBase.html#setTupleBufferSize(int)"><CODE>setTupleBufferSize(int)</CODE></A></DL>
288</DD>
289</DL>
290<HR>
291
292<A NAME="getTupleOutput(java.lang.Object)"><!-- --></A><H3>
293getTupleOutput</H3>
294<PRE>
295protected <A HREF="/com/sleepycat/bind/tuple/TupleOutput.html" title="class in com.sleepycat.bind.tuple">TupleOutput</A> <B>getTupleOutput</B>(<A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Object.html" title="class or interface in java.lang">Object</A>&nbsp;object)</PRE>
296<DL>
297<DD>Returns an empty TupleOutput instance that will be used by the tuple
298 binding or key creator.
299
300 <p>The default implementation of this method creates a new TupleOutput
301 with an initial buffer size that can be changed using the <A HREF="/com/sleepycat/bind/tuple/TupleBase.html#setTupleBufferSize(int)"><CODE>setTupleBufferSize(int)</CODE></A> method.</p>
302
303 <p>This method may be overridden to return a TupleOutput instance.  For
304 example, an instance per thread could be created and returned by this
305 method.  If a TupleOutput instance is reused, be sure to call its
306 <A HREF="/com/sleepycat/util/FastOutputStream.html#reset()"><CODE>FastOutputStream.reset()</CODE></A> method before each
307 use.</p>
308<P>
309<DD><DL>
310<DT><B>Parameters:</B><DD><CODE>object</CODE> - is the object to be written to the tuple output, and may
311 be used by subclasses to determine the size of the output buffer.
312<DT><B>Returns:</B><DD>an empty TupleOutput instance.<DT><B>See Also:</B><DD><A HREF="/com/sleepycat/bind/tuple/TupleBase.html#setTupleBufferSize(int)"><CODE>setTupleBufferSize(int)</CODE></A></DL>
313</DD>
314</DL>
315<HR>
316
317<A NAME="outputToEntry(com.sleepycat.bind.tuple.TupleOutput, com.sleepycat.db.DatabaseEntry)"><!-- --></A><H3>
318outputToEntry</H3>
319<PRE>
320public static void <B>outputToEntry</B>(<A HREF="/com/sleepycat/bind/tuple/TupleOutput.html" title="class in com.sleepycat.bind.tuple">TupleOutput</A>&nbsp;output,
321                                 <A HREF="/com/sleepycat/db/DatabaseEntry.html" title="class in com.sleepycat.db">DatabaseEntry</A>&nbsp;entry)</PRE>
322<DL>
323<DD>Utility method to set the data in a entry buffer to the data in a tuple
324 output object.
325<P>
326<DD><DL>
327<DT><B>Parameters:</B><DD><CODE>output</CODE> - is the source tuple output object.<DD><CODE>entry</CODE> - is the destination entry buffer.</DL>
328</DD>
329</DL>
330<HR>
331
332<A NAME="inputToEntry(com.sleepycat.bind.tuple.TupleInput, com.sleepycat.db.DatabaseEntry)"><!-- --></A><H3>
333inputToEntry</H3>
334<PRE>
335public static void <B>inputToEntry</B>(<A HREF="/com/sleepycat/bind/tuple/TupleInput.html" title="class in com.sleepycat.bind.tuple">TupleInput</A>&nbsp;input,
336                                <A HREF="/com/sleepycat/db/DatabaseEntry.html" title="class in com.sleepycat.db">DatabaseEntry</A>&nbsp;entry)</PRE>
337<DL>
338<DD>Utility method to set the data in a entry buffer to the data in a tuple
339 input object.
340<P>
341<DD><DL>
342<DT><B>Parameters:</B><DD><CODE>input</CODE> - is the source tuple input object.<DD><CODE>entry</CODE> - is the destination entry buffer.</DL>
343</DD>
344</DL>
345<HR>
346
347<A NAME="entryToInput(com.sleepycat.db.DatabaseEntry)"><!-- --></A><H3>
348entryToInput</H3>
349<PRE>
350public static <A HREF="/com/sleepycat/bind/tuple/TupleInput.html" title="class in com.sleepycat.bind.tuple">TupleInput</A> <B>entryToInput</B>(<A HREF="/com/sleepycat/db/DatabaseEntry.html" title="class in com.sleepycat.db">DatabaseEntry</A>&nbsp;entry)</PRE>
351<DL>
352<DD>Utility method to create a new tuple input object for reading the data
353 from a given buffer.  If an existing input is reused, it is reset before
354 returning it.
355<P>
356<DD><DL>
357<DT><B>Parameters:</B><DD><CODE>entry</CODE> - is the source entry buffer.
358<DT><B>Returns:</B><DD>the new tuple input object.</DL>
359</DD>
360</DL>
361<HR>
362
363<A NAME="newOutput()"><!-- --></A><H3>
364newOutput</H3>
365<PRE>
366public static <A HREF="/com/sleepycat/bind/tuple/TupleOutput.html" title="class in com.sleepycat.bind.tuple">TupleOutput</A> <B>newOutput</B>()</PRE>
367<DL>
368<DD><B>Deprecated.</B>&nbsp;<I>replaced by <A HREF="/com/sleepycat/bind/tuple/TupleBase.html#getTupleOutput(java.lang.Object)"><CODE>getTupleOutput(java.lang.Object)</CODE></A></I>
369<P>
370<DD>Utility method for use by bindings to create a tuple output object.
371<P>
372<DD><DL>
373
374<DT><B>Returns:</B><DD>a new tuple output object.</DL>
375</DD>
376</DL>
377<HR>
378
379<A NAME="newOutput(byte[])"><!-- --></A><H3>
380newOutput</H3>
381<PRE>
382public static <A HREF="/com/sleepycat/bind/tuple/TupleOutput.html" title="class in com.sleepycat.bind.tuple">TupleOutput</A> <B>newOutput</B>(byte[]&nbsp;buffer)</PRE>
383<DL>
384<DD><B>Deprecated.</B>&nbsp;<I>replaced by <A HREF="/com/sleepycat/bind/tuple/TupleBase.html#getTupleOutput(java.lang.Object)"><CODE>getTupleOutput(java.lang.Object)</CODE></A></I>
385<P>
386<DD>Utility method for use by bindings to create a tuple output object
387 with a specific starting size.
388<P>
389<DD><DL>
390
391<DT><B>Returns:</B><DD>a new tuple output object.</DL>
392</DD>
393</DL>
394<!-- ========= END OF CLASS DATA ========= -->
395<HR>
396
397
398<!-- ======= START OF BOTTOM NAVBAR ====== -->
399<A NAME="navbar_bottom"><!-- --></A>
400<A HREF="#skip-navbar_bottom" title="Skip navigation links"></A>
401<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
402<TR>
403<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
404<A NAME="navbar_bottom_firstrow"><!-- --></A>
405<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
406  <TR ALIGN="center" VALIGN="top">
407  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="/overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>
408  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
409  <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
410  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="class-use/TupleBase.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A>&nbsp;</TD>
411  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
412  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="/deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>
413  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="/index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
414  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="/help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
415  </TR>
416</TABLE>
417</TD>
418<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
419<b>Berkeley DB</b><br><font size="-1"> version 4.7.25</font></EM>
420</TD>
421</TR>
422
423<TR>
424<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
425&nbsp;<A HREF="/com/sleepycat/bind/tuple/StringBinding.html" title="class in com.sleepycat.bind.tuple"><B>PREV CLASS</B></A>&nbsp;
426&nbsp;<A HREF="/com/sleepycat/bind/tuple/TupleBinding.html" title="class in com.sleepycat.bind.tuple"><B>NEXT CLASS</B></A></FONT></TD>
427<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
428  <A HREF="/index.html?com/sleepycat/bind/tuple/TupleBase.html" target="_top"><B>FRAMES</B></A>  &nbsp;
429&nbsp;<A HREF="TupleBase.html" target="_top"><B>NO FRAMES</B></A>  &nbsp;
430&nbsp;<SCRIPT type="text/javascript">
431  <!--
432  if(window==top) {
433    document.writeln('<A HREF="/allclasses-noframe.html"><B>All Classes</B></A>');
434  }
435  //-->
436</SCRIPT>
437<NOSCRIPT>
438  <A HREF="/allclasses-noframe.html"><B>All Classes</B></A>
439</NOSCRIPT>
440
441
442</FONT></TD>
443</TR>
444<TR>
445<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
446  SUMMARY:&nbsp;NESTED&nbsp;|&nbsp;FIELD&nbsp;|&nbsp;<A HREF="#constructor_summary">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>
447<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
448DETAIL:&nbsp;FIELD&nbsp;|&nbsp;<A HREF="#constructor_detail">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></FONT></TD>
449</TR>
450</TABLE>
451<A NAME="skip-navbar_bottom"></A>
452<!-- ======== END OF BOTTOM NAVBAR ======= -->
453
454<HR>
455<font size=1>Copyright (c) 1996,2008 Oracle.  All rights reserved.</font>
456</BODY>
457</HTML>
458