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