<!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:42 UTC 2010 -->
<TITLE>
SerialFormat
</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="SerialFormat";
}
}
</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/serial/SerialBinding.html" title="class in com.sleepycat.bdb.bind.serial"><B>PREV CLASS</B></A>
<A HREF="../../../../../com/sleepycat/bdb/bind/serial/SerialInput.html" title="class in com.sleepycat.bdb.bind.serial"><B>NEXT CLASS</B></A></FONT></TD>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
<A HREF="../../../../../index.html?com/sleepycat/bdb/bind/serial/SerialFormat.html" target="_top"><B>FRAMES</B></A>
<A HREF="SerialFormat.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 | <A HREF="#constructor_summary">CONSTR</A> | <A HREF="#method_summary">METHOD</A></FONT></TD>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
DETAIL: FIELD | <A HREF="#constructor_detail">CONSTR</A> | <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.serial</FONT>
<BR>
Class SerialFormat</H2>
<PRE>
java.lang.Object
<IMG SRC="../../../../../resources/inherit.gif" ALT="extended by "><B>com.sleepycat.bdb.bind.serial.SerialFormat</B>
</PRE>
<DL>
<DT><B>All Implemented Interfaces:</B> <DD><A HREF="../../../../../com/sleepycat/bdb/bind/DataFormat.html" title="interface in com.sleepycat.bdb.bind">DataFormat</A></DD>
</DL>
<HR>
<DL>
<DT><PRE>public class <B>SerialFormat</B><DT>extends java.lang.Object<DT>implements <A HREF="../../../../../com/sleepycat/bdb/bind/DataFormat.html" title="interface in com.sleepycat.bdb.bind">DataFormat</A></DL>
</PRE>
<P>
The format for serialized data. In addition to identifying a serial format
this class provides utility methods for use by bindings.
<P>
<P>
<HR>
<P>
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
<A NAME="constructor_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>Constructor Summary</B></FONT></TH>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD><CODE><B><A HREF="../../../../../com/sleepycat/bdb/bind/serial/SerialFormat.html#SerialFormat(com.sleepycat.bdb.bind.serial.ClassCatalog, java.lang.Class)">SerialFormat</A></B>(<A HREF="../../../../../com/sleepycat/bdb/bind/serial/ClassCatalog.html" title="interface in com.sleepycat.bdb.bind.serial">ClassCatalog</A> classCatalog,
java.lang.Class baseClass)</CODE>
<BR>
Creates a serial format.</TD>
</TR>
</TABLE>
<!-- ========== 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> java.lang.Object</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../../com/sleepycat/bdb/bind/serial/SerialFormat.html#dataToObject(com.sleepycat.bdb.bind.DataBuffer)">dataToObject</A></B>(<A HREF="../../../../../com/sleepycat/bdb/bind/DataBuffer.html" title="interface in com.sleepycat.bdb.bind">DataBuffer</A> data)</CODE>
<BR>
Utility method for use by bindings to deserialize an object.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> java.lang.Class</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../../com/sleepycat/bdb/bind/serial/SerialFormat.html#getBaseClass()">getBaseClass</A></B>()</CODE>
<BR>
Returns the base class for this format.</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/serial/SerialFormat.html#objectToData(java.lang.Object, com.sleepycat.bdb.bind.DataBuffer)">objectToData</A></B>(java.lang.Object object,
<A HREF="../../../../../com/sleepycat/bdb/bind/DataBuffer.html" title="interface in com.sleepycat.bdb.bind">DataBuffer</A> data)</CODE>
<BR>
Utility method for use by bindings to serialize an object.</TD>
</TR>
</TABLE>
<A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
<TH ALIGN="left"><B>Methods inherited from class java.lang.Object</B></TH>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD><CODE>clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</CODE></TD>
</TR>
</TABLE>
<P>
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<A NAME="constructor_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>Constructor Detail</B></FONT></TH>
</TR>
</TABLE>
<A NAME="SerialFormat(com.sleepycat.bdb.bind.serial.ClassCatalog, java.lang.Class)"><!-- --></A><H3>
SerialFormat</H3>
<PRE>
public <B>SerialFormat</B>(<A HREF="../../../../../com/sleepycat/bdb/bind/serial/ClassCatalog.html" title="interface in com.sleepycat.bdb.bind.serial">ClassCatalog</A> classCatalog,
java.lang.Class baseClass)</PRE>
<DL>
<DD>Creates a serial format.
<P>
<DL>
<DT><B>Parameters:</B><DD><CODE>classCatalog</CODE> - is the catalog to hold shared class information and
for a database should be a <A HREF="../../../../../com/sleepycat/bdb/StoredClassCatalog.html" title="class in com.sleepycat.bdb"><CODE>StoredClassCatalog</CODE></A>.<DD><CODE>baseClass</CODE> - is the base class for serialized objects stored using
this format -- all objects using this format must be an instance of
this class.</DL>
</DL>
<!-- ============ 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="getBaseClass()"><!-- --></A><H3>
getBaseClass</H3>
<PRE>
public final java.lang.Class <B>getBaseClass</B>()</PRE>
<DL>
<DD>Returns the base class for this format.
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>
<DT><B>Returns:</B><DD>the base class for this format.</DL>
</DD>
</DL>
<HR>
<A NAME="dataToObject(com.sleepycat.bdb.bind.DataBuffer)"><!-- --></A><H3>
dataToObject</H3>
<PRE>
public final java.lang.Object <B>dataToObject</B>(<A HREF="../../../../../com/sleepycat/bdb/bind/DataBuffer.html" title="interface in com.sleepycat.bdb.bind">DataBuffer</A> data)
throws java.io.IOException</PRE>
<DL>
<DD>Utility method for use by bindings to deserialize an object. May only
be called for data that was serialized using <A HREF="../../../../../com/sleepycat/bdb/bind/serial/SerialFormat.html#objectToData(java.lang.Object, com.sleepycat.bdb.bind.DataBuffer)"><CODE>objectToData(java.lang.Object, com.sleepycat.bdb.bind.DataBuffer)</CODE></A>,
since the fixed serialization header is assumed to not be included in
the input data. <A HREF="../../../../../com/sleepycat/bdb/bind/serial/SerialInput.html" title="class in com.sleepycat.bdb.bind.serial"><CODE>SerialInput</CODE></A> is used to deserialize the object.
If a deserialized object is cached in the buffer's data formation
property, it is returned directly.
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>data</CODE> - is the input serialized data.
<DT><B>Returns:</B><DD>the output deserialized object.
<DT><B>Throws:</B>
<DD><CODE>java.io.IOException</CODE></DL>
</DD>
</DL>
<HR>
<A NAME="objectToData(java.lang.Object, com.sleepycat.bdb.bind.DataBuffer)"><!-- --></A><H3>
objectToData</H3>
<PRE>
public final void <B>objectToData</B>(java.lang.Object object,
<A HREF="../../../../../com/sleepycat/bdb/bind/DataBuffer.html" title="interface in com.sleepycat.bdb.bind">DataBuffer</A> data)
throws java.io.IOException</PRE>
<DL>
<DD>Utility method for use by bindings to serialize an object. The fixed
serialization header is not included in the output data to save space,
and therefore to deserialize the data the complementary <A HREF="../../../../../com/sleepycat/bdb/bind/serial/SerialFormat.html#dataToObject(com.sleepycat.bdb.bind.DataBuffer)"><CODE>dataToObject(com.sleepycat.bdb.bind.DataBuffer)</CODE></A> method must be used. <A HREF="../../../../../com/sleepycat/bdb/bind/serial/SerialOutput.html" title="class in com.sleepycat.bdb.bind.serial"><CODE>SerialOutput</CODE></A> is used to
serialize the object. The deserialized object is cached in the buffer's
data formation property.
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>object</CODE> - is the input deserialized object.<DD><CODE>data</CODE> - is the output serialized data.
<DT><B>Throws:</B>
<DD><CODE>java.lang.IllegalArgumentException</CODE> - if the object is not an instance of the
base class for this format.
<DD><CODE>java.io.IOException</CODE></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/serial/SerialBinding.html" title="class in com.sleepycat.bdb.bind.serial"><B>PREV CLASS</B></A>
<A HREF="../../../../../com/sleepycat/bdb/bind/serial/SerialInput.html" title="class in com.sleepycat.bdb.bind.serial"><B>NEXT CLASS</B></A></FONT></TD>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
<A HREF="../../../../../index.html?com/sleepycat/bdb/bind/serial/SerialFormat.html" target="_top"><B>FRAMES</B></A>
<A HREF="SerialFormat.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 | <A HREF="#constructor_summary">CONSTR</A> | <A HREF="#method_summary">METHOD</A></FONT></TD>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
DETAIL: FIELD | <A HREF="#constructor_detail">CONSTR</A> | <A HREF="#method_detail">METHOD</A></FONT></TD>
</TR>
</TABLE>
<A NAME="skip-navbar_bottom"></A>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
<HR>
</BODY>
</HTML>
