<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> <!--NewPage--> <HTML> <HEAD> <!-- Generated by javadoc (build 1.6.0_18) on Thu Dec 02 16:59:38 UTC 2010 --> <TITLE> DataBuffer </TITLE> <META NAME="date" CONTENT="2010-12-02"> <LINK REL ="stylesheet" TYPE="text/css" HREF="../../../../stylesheet.css" TITLE="Style"> <SCRIPT type="text/javascript"> function windowTitle() { if (location.href.indexOf('is-external=true') == -1) { parent.document.title="DataBuffer"; } } </SCRIPT> <NOSCRIPT> </NOSCRIPT> </HEAD> <BODY BGCOLOR="white" onload="windowTitle();"> <HR> <!-- ========= START OF TOP NAVBAR ======= --> <A NAME="navbar_top"><!-- --></A> <A HREF="#skip-navbar_top" title="Skip navigation links"></A> <TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY=""> <TR> <TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A NAME="navbar_top_firstrow"><!-- --></A> <TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY=""> <TR ALIGN="center" VALIGN="top"> <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD> <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD> <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD> <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD> <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD> <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD> <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD> </TR> </TABLE> </TD> <TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM> </EM> </TD> </TR> <TR> <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> <A HREF="../../../../com/sleepycat/bdb/bind/DataBinding.html" title="interface in com.sleepycat.bdb.bind"><B>PREV CLASS</B></A> <A HREF="../../../../com/sleepycat/bdb/bind/DataFormat.html" title="interface in com.sleepycat.bdb.bind"><B>NEXT CLASS</B></A></FONT></TD> <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> <A HREF="../../../../index.html?com/sleepycat/bdb/bind/DataBuffer.html" target="_top"><B>FRAMES</B></A> <A HREF="DataBuffer.html" target="_top"><B>NO FRAMES</B></A> <SCRIPT type="text/javascript"> <!-- if(window==top) { document.writeln('<A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>'); } //--> </SCRIPT> <NOSCRIPT> <A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A> </NOSCRIPT> </FONT></TD> </TR> <TR> <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> SUMMARY: NESTED | FIELD | CONSTR | <A HREF="#method_summary">METHOD</A></FONT></TD> <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> DETAIL: FIELD | CONSTR | <A HREF="#method_detail">METHOD</A></FONT></TD> </TR> </TABLE> <A NAME="skip-navbar_top"></A> <!-- ========= END OF TOP NAVBAR ========= --> <HR> <!-- ======== START OF CLASS DATA ======== --> <H2> <FONT SIZE="-1"> com.sleepycat.bdb.bind</FONT> <BR> Interface DataBuffer</H2> <DL> <DT><B>All Known Implementing Classes:</B> <DD><A HREF="../../../../com/sleepycat/bdb/DataThang.html" title="class in com.sleepycat.bdb">DataThang</A>, <A HREF="../../../../com/sleepycat/bdb/bind/SimpleBuffer.html" title="class in com.sleepycat.bdb.bind">SimpleBuffer</A></DD> </DL> <HR> <DL> <DT><PRE>public interface <B>DataBuffer</B></DL> </PRE> <P> The interface used in bindings to access the data as a byte array. <p>Each data buffer may contain a formation Object that is associated with the data. The formation may be used by bindings to cache an internal representation of the data that is specific to the format but can be used by all bindings. The formation must be cleared whenever the data in the buffer is changed.</p> <P> <P> <HR> <P> <!-- ========== METHOD SUMMARY =========== --> <A NAME="method_summary"><!-- --></A> <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> <TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2"> <B>Method Summary</B></FONT></TH> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> <CODE> void</CODE></FONT></TD> <TD><CODE><B><A HREF="../../../../com/sleepycat/bdb/bind/DataBuffer.html#clearDataFormation()">clearDataFormation</A></B>()</CODE> <BR> Sets the formation associated with the data in this buffer to null.</TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> <CODE> byte[]</CODE></FONT></TD> <TD><CODE><B><A HREF="../../../../com/sleepycat/bdb/bind/DataBuffer.html#getDataBytes()">getDataBytes</A></B>()</CODE> <BR> Returns the byte array of the data buffer.</TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> <CODE> java.lang.Object</CODE></FONT></TD> <TD><CODE><B><A HREF="../../../../com/sleepycat/bdb/bind/DataBuffer.html#getDataFormation()">getDataFormation</A></B>()</CODE> <BR> Returns the formation associated with the data in this buffer.</TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> <CODE> int</CODE></FONT></TD> <TD><CODE><B><A HREF="../../../../com/sleepycat/bdb/bind/DataBuffer.html#getDataLength()">getDataLength</A></B>()</CODE> <BR> Returns the byte length of the data in the array.</TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> <CODE> int</CODE></FONT></TD> <TD><CODE><B><A HREF="../../../../com/sleepycat/bdb/bind/DataBuffer.html#getDataOffset()">getDataOffset</A></B>()</CODE> <BR> Returns the byte offset of the data in the array.</TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> <CODE> void</CODE></FONT></TD> <TD><CODE><B><A HREF="../../../../com/sleepycat/bdb/bind/DataBuffer.html#setData(byte[], int, int)">setData</A></B>(byte[] data, int offset, int length)</CODE> <BR> Sets the data in this buffer to the given value.</TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> <CODE> void</CODE></FONT></TD> <TD><CODE><B><A HREF="../../../../com/sleepycat/bdb/bind/DataBuffer.html#setDataFormation(java.lang.Object)">setDataFormation</A></B>(java.lang.Object formation)</CODE> <BR> Sets the formation associated with the data in this buffer.</TD> </TR> </TABLE> <P> <!-- ============ METHOD DETAIL ========== --> <A NAME="method_detail"><!-- --></A> <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> <TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2"> <B>Method Detail</B></FONT></TH> </TR> </TABLE> <A NAME="setData(byte[], int, int)"><!-- --></A><H3> setData</H3> <PRE> void <B>setData</B>(byte[] data, int offset, int length)</PRE> <DL> <DD>Sets the data in this buffer to the given value. The byte array given will be owned by this buffer object after this method is called and must not be modified thereafter. This method must clear the data formation for this buffer. <P> <DD><DL> <DT><B>Parameters:</B><DD><CODE>data</CODE> - is the data array and must not be modified after this method is called.<DD><CODE>offset</CODE> - is the byte offset of the data in the array.<DD><CODE>length</CODE> - is the byte length of the data in the array.</DL> </DD> </DL> <HR> <A NAME="getDataBytes()"><!-- --></A><H3> getDataBytes</H3> <PRE> byte[] <B>getDataBytes</B>()</PRE> <DL> <DD>Returns the byte array of the data buffer. This array is owned by the buffer object and should not be modified. <P> <DD><DL> <DT><B>Returns:</B><DD>the byte array of the data buffer.</DL> </DD> </DL> <HR> <A NAME="getDataOffset()"><!-- --></A><H3> getDataOffset</H3> <PRE> int <B>getDataOffset</B>()</PRE> <DL> <DD>Returns the byte offset of the data in the array. <P> <DD><DL> <DT><B>Returns:</B><DD>the byte offset of the data in the array.</DL> </DD> </DL> <HR> <A NAME="getDataLength()"><!-- --></A><H3> getDataLength</H3> <PRE> int <B>getDataLength</B>()</PRE> <DL> <DD>Returns the byte length of the data in the array. <P> <DD><DL> <DT><B>Returns:</B><DD>the byte length of the data in the array.</DL> </DD> </DL> <HR> <A NAME="setDataFormation(java.lang.Object)"><!-- --></A><H3> setDataFormation</H3> <PRE> void <B>setDataFormation</B>(java.lang.Object formation)</PRE> <DL> <DD>Sets the formation associated with the data in this buffer. <P> <DD><DL> <DT><B>Parameters:</B><DD><CODE>formation</CODE> - is Object to set.</DL> </DD> </DL> <HR> <A NAME="getDataFormation()"><!-- --></A><H3> getDataFormation</H3> <PRE> java.lang.Object <B>getDataFormation</B>()</PRE> <DL> <DD>Returns the formation associated with the data in this buffer. <P> <DD><DL> <DT><B>Returns:</B><DD>formation Object.</DL> </DD> </DL> <HR> <A NAME="clearDataFormation()"><!-- --></A><H3> clearDataFormation</H3> <PRE> void <B>clearDataFormation</B>()</PRE> <DL> <DD>Sets the formation associated with the data in this buffer to null. <P> <DD><DL> </DL> </DD> </DL> <!-- ========= END OF CLASS DATA ========= --> <HR> <!-- ======= START OF BOTTOM NAVBAR ====== --> <A NAME="navbar_bottom"><!-- --></A> <A HREF="#skip-navbar_bottom" title="Skip navigation links"></A> <TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY=""> <TR> <TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A NAME="navbar_bottom_firstrow"><!-- --></A> <TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY=""> <TR ALIGN="center" VALIGN="top"> <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD> <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD> <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD> <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD> <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD> <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD> <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD> </TR> </TABLE> </TD> <TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM> </EM> </TD> </TR> <TR> <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> <A HREF="../../../../com/sleepycat/bdb/bind/DataBinding.html" title="interface in com.sleepycat.bdb.bind"><B>PREV CLASS</B></A> <A HREF="../../../../com/sleepycat/bdb/bind/DataFormat.html" title="interface in com.sleepycat.bdb.bind"><B>NEXT CLASS</B></A></FONT></TD> <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> <A HREF="../../../../index.html?com/sleepycat/bdb/bind/DataBuffer.html" target="_top"><B>FRAMES</B></A> <A HREF="DataBuffer.html" target="_top"><B>NO FRAMES</B></A> <SCRIPT type="text/javascript"> <!-- if(window==top) { document.writeln('<A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>'); } //--> </SCRIPT> <NOSCRIPT> <A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A> </NOSCRIPT> </FONT></TD> </TR> <TR> <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> SUMMARY: NESTED | FIELD | CONSTR | <A HREF="#method_summary">METHOD</A></FONT></TD> <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> DETAIL: FIELD | CONSTR | <A HREF="#method_detail">METHOD</A></FONT></TD> </TR> </TABLE> <A NAME="skip-navbar_bottom"></A> <!-- ======== END OF BOTTOM NAVBAR ======= --> <HR> </BODY> </HTML>