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