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> 7ClassCatalog (Oracle - Berkeley DB Java API) 8</TITLE> 9 10<META NAME="keywords" CONTENT="com.sleepycat.bind.serial.ClassCatalog interface"> 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="ClassCatalog (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> </TD> 38 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD> 39 <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD> 40 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="class-use/ClassCatalog.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A> </TD> 41 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD> 42 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD> 43 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD> 44 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </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 PREV CLASS 56 <A HREF="../../../../com/sleepycat/bind/serial/SerialBase.html" title="class in com.sleepycat.bind.serial"><B>NEXT CLASS</B></A></FONT></TD> 57<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> 58 <A HREF="../../../../index.html?com/sleepycat/bind/serial/ClassCatalog.html" target="_top"><B>FRAMES</B></A> 59 <A HREF="ClassCatalog.html" target="_top"><B>NO FRAMES</B></A> 60 <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: NESTED | FIELD | CONSTR | <A HREF="#method_summary">METHOD</A></FONT></TD> 77<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> 78DETAIL: FIELD | CONSTR | <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.serial</FONT> 89<BR> 90Interface ClassCatalog</H2> 91<DL> 92<DT><B>All Known Implementing Classes:</B> <DD><A HREF="../../../../com/sleepycat/bind/serial/StoredClassCatalog.html" title="class in com.sleepycat.bind.serial">StoredClassCatalog</A></DD> 93</DL> 94<HR> 95<DL> 96<DT><PRE>public interface <B>ClassCatalog</B></DL> 97</PRE> 98 99<P> 100A catalog of class description information for use during object 101 serialization. 102 103 <p>A catalog is used to store class descriptions separately from serialized 104 objects, to avoid redundantly stored information with each object. 105 When serialized objects are stored in a database, a <A HREF="../../../../com/sleepycat/bind/serial/StoredClassCatalog.html" title="class in com.sleepycat.bind.serial"><CODE>StoredClassCatalog</CODE></A> should be used.</p> 106 107 <p>This information is used for serialization of class descriptors or 108 java.io.ObjectStreamClass objects, each of which represents a unique class 109 format. For each unique format, a unique class ID is assigned by the 110 catalog. The class ID can then be used in the serialization stream in place 111 of the full class information. When used with <A HREF="../../../../com/sleepycat/bind/serial/SerialInput.html" title="class in com.sleepycat.bind.serial"><CODE>SerialInput</CODE></A> and 112 <A HREF="../../../../com/sleepycat/bind/serial/SerialOutput.html" title="class in com.sleepycat.bind.serial"><CODE>SerialOutput</CODE></A> or any of the serial bindings, the use of the catalog 113 is transparent to the application.</p> 114<P> 115 116<P> 117<HR> 118 119<P> 120 121<!-- ========== METHOD SUMMARY =========== --> 122 123<A NAME="method_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>Method Summary</B></FONT></TH> 128</TR> 129<TR BGCOLOR="white" CLASS="TableRowColor"> 130<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> 131<CODE> void</CODE></FONT></TD> 132<TD><CODE><B><A HREF="../../../../com/sleepycat/bind/serial/ClassCatalog.html#close()">close</A></B>()</CODE> 133 134<BR> 135 Close a catalog database and release any cached resources.</TD> 136</TR> 137<TR BGCOLOR="white" CLASS="TableRowColor"> 138<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> 139<CODE> <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/io/ObjectStreamClass.html" title="class or interface in java.io">ObjectStreamClass</A></CODE></FONT></TD> 140<TD><CODE><B><A HREF="../../../../com/sleepycat/bind/serial/ClassCatalog.html#getClassFormat(byte[])">getClassFormat</A></B>(byte[] classID)</CODE> 141 142<BR> 143 Return the ObjectStreamClass for the given class ID.</TD> 144</TR> 145<TR BGCOLOR="white" CLASS="TableRowColor"> 146<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> 147<CODE> byte[]</CODE></FONT></TD> 148<TD><CODE><B><A HREF="../../../../com/sleepycat/bind/serial/ClassCatalog.html#getClassID(java.io.ObjectStreamClass)">getClassID</A></B>(<A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/io/ObjectStreamClass.html" title="class or interface in java.io">ObjectStreamClass</A> classDesc)</CODE> 149 150<BR> 151 Return the class ID for the current version of the given class 152 description.</TD> 153</TR> 154</TABLE> 155 156<P> 157 158<!-- ============ METHOD DETAIL ========== --> 159 160<A NAME="method_detail"><!-- --></A> 161<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> 162<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> 163<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2"> 164<B>Method Detail</B></FONT></TH> 165</TR> 166</TABLE> 167 168<A NAME="close()"><!-- --></A><H3> 169close</H3> 170<PRE> 171void <B>close</B>() 172 throws <A HREF="../../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</A></PRE> 173<DL> 174<DD>Close a catalog database and release any cached resources. 175<P> 176<DD><DL> 177 178<DT><B>Throws:</B> 179<DD><CODE><A HREF="../../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</A></CODE></DL> 180</DD> 181</DL> 182<HR> 183 184<A NAME="getClassID(java.io.ObjectStreamClass)"><!-- --></A><H3> 185getClassID</H3> 186<PRE> 187byte[] <B>getClassID</B>(<A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/io/ObjectStreamClass.html" title="class or interface in java.io">ObjectStreamClass</A> classDesc) 188 throws <A HREF="../../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</A>, 189 <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/ClassNotFoundException.html" title="class or interface in java.lang">ClassNotFoundException</A></PRE> 190<DL> 191<DD>Return the class ID for the current version of the given class 192 description. 193 This is used for storing in serialization streams in place of a full 194 class descriptor, since it is much more compact. To get back the 195 ObjectStreamClass for a class ID, call <A HREF="../../../../com/sleepycat/bind/serial/ClassCatalog.html#getClassFormat(byte[])"><CODE>getClassFormat(byte[])</CODE></A>. 196 This function causes a new class ID to be assigned if the class 197 description has changed. 198<P> 199<DD><DL> 200<DT><B>Parameters:</B><DD><CODE>classDesc</CODE> - The class description for which to return the 201 class ID. 202<DT><B>Returns:</B><DD>The class ID for the current version of the class. 203<DT><B>Throws:</B> 204<DD><CODE><A HREF="../../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</A></CODE> 205<DD><CODE><A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/ClassNotFoundException.html" title="class or interface in java.lang">ClassNotFoundException</A></CODE></DL> 206</DD> 207</DL> 208<HR> 209 210<A NAME="getClassFormat(byte[])"><!-- --></A><H3> 211getClassFormat</H3> 212<PRE> 213<A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/io/ObjectStreamClass.html" title="class or interface in java.io">ObjectStreamClass</A> <B>getClassFormat</B>(byte[] classID) 214 throws <A HREF="../../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</A>, 215 <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/ClassNotFoundException.html" title="class or interface in java.lang">ClassNotFoundException</A></PRE> 216<DL> 217<DD>Return the ObjectStreamClass for the given class ID. This may or may 218 not be the current class format, depending on whether the class has 219 changed since the class ID was generated. 220<P> 221<DD><DL> 222<DT><B>Parameters:</B><DD><CODE>classID</CODE> - The class ID for which to return the class format. 223<DT><B>Returns:</B><DD>The class format for the given class ID, which may or may not 224 represent the current version of the class. 225<DT><B>Throws:</B> 226<DD><CODE><A HREF="../../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</A></CODE> 227<DD><CODE><A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/ClassNotFoundException.html" title="class or interface in java.lang">ClassNotFoundException</A></CODE></DL> 228</DD> 229</DL> 230<!-- ========= END OF CLASS DATA ========= --> 231<HR> 232 233 234<!-- ======= START OF BOTTOM NAVBAR ====== --> 235<A NAME="navbar_bottom"><!-- --></A> 236<A HREF="#skip-navbar_bottom" title="Skip navigation links"></A> 237<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY=""> 238<TR> 239<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> 240<A NAME="navbar_bottom_firstrow"><!-- --></A> 241<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY=""> 242 <TR ALIGN="center" VALIGN="top"> 243 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD> 244 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD> 245 <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD> 246 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="class-use/ClassCatalog.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A> </TD> 247 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD> 248 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD> 249 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD> 250 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD> 251 </TR> 252</TABLE> 253</TD> 254<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM> 255<b>Berkeley DB</b><br><font size="-1"> version 4.7.25</font></EM> 256</TD> 257</TR> 258 259<TR> 260<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> 261 PREV CLASS 262 <A HREF="../../../../com/sleepycat/bind/serial/SerialBase.html" title="class in com.sleepycat.bind.serial"><B>NEXT CLASS</B></A></FONT></TD> 263<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> 264 <A HREF="../../../../index.html?com/sleepycat/bind/serial/ClassCatalog.html" target="_top"><B>FRAMES</B></A> 265 <A HREF="ClassCatalog.html" target="_top"><B>NO FRAMES</B></A> 266 <SCRIPT type="text/javascript"> 267 <!-- 268 if(window==top) { 269 document.writeln('<A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>'); 270 } 271 //--> 272</SCRIPT> 273<NOSCRIPT> 274 <A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A> 275</NOSCRIPT> 276 277 278</FONT></TD> 279</TR> 280<TR> 281<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> 282 SUMMARY: NESTED | FIELD | CONSTR | <A HREF="#method_summary">METHOD</A></FONT></TD> 283<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> 284DETAIL: FIELD | CONSTR | <A HREF="#method_detail">METHOD</A></FONT></TD> 285</TR> 286</TABLE> 287<A NAME="skip-navbar_bottom"></A> 288<!-- ======== END OF BOTTOM NAVBAR ======= --> 289 290<HR> 291<font size=1>Copyright (c) 1996,2008 Oracle. All rights reserved.</font> 292</BODY> 293</HTML> 294