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:34 EDT 2008 -->
6<TITLE>
7API Help (Oracle - Berkeley DB Java API)
8</TITLE>
9
10
11<LINK REL ="stylesheet" TYPE="text/css" HREF="style.css" TITLE="Style">
12
13<SCRIPT type="text/javascript">
14function windowTitle()
15{
16    parent.document.title="API Help (Oracle - Berkeley DB Java API)";
17}
18</SCRIPT>
19<NOSCRIPT>
20</NOSCRIPT>
21
22</HEAD>
23
24<BODY BGCOLOR="white" onload="windowTitle();">
25
26
27<!-- ========= START OF TOP NAVBAR ======= -->
28<A NAME="navbar_top"><!-- --></A>
29<A HREF="#skip-navbar_top" title="Skip navigation links"></A>
30<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
31<TR>
32<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
33<A NAME="navbar_top_firstrow"><!-- --></A>
34<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
35  <TR ALIGN="center" VALIGN="top">
36  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>
37  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <FONT CLASS="NavBarFont1">Package</FONT>&nbsp;</TD>
38  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <FONT CLASS="NavBarFont1">Class</FONT>&nbsp;</TD>
39  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <FONT CLASS="NavBarFont1">Use</FONT>&nbsp;</TD>
40  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="overview-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
41  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>
42  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
43  <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Help</B></FONT>&nbsp;</TD>
44  </TR>
45</TABLE>
46</TD>
47<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
48<b>Berkeley DB</b><br><font size="-1"> version 4.7.25</font></EM>
49</TD>
50</TR>
51
52<TR>
53<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
54&nbsp;PREV&nbsp;
55&nbsp;NEXT</FONT></TD>
56<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
57  <A HREF="index.html?help-doc.html" target="_top"><B>FRAMES</B></A>  &nbsp;
58&nbsp;<A HREF="help-doc.html" target="_top"><B>NO FRAMES</B></A>  &nbsp;
59&nbsp;<SCRIPT type="text/javascript">
60  <!--
61  if(window==top) {
62    document.writeln('<A HREF="allclasses-noframe.html"><B>All Classes</B></A>');
63  }
64  //-->
65</SCRIPT>
66<NOSCRIPT>
67  <A HREF="allclasses-noframe.html"><B>All Classes</B></A>
68</NOSCRIPT>
69
70
71</FONT></TD>
72</TR>
73</TABLE>
74<A NAME="skip-navbar_top"></A>
75<!-- ========= END OF TOP NAVBAR ========= -->
76
77<HR>
78<CENTER>
79<H1>
80How This API Document Is Organized</H1>
81</CENTER>
82This API (Application Programming Interface) document has pages corresponding to the items in the navigation bar, described as follows.<H3>
83Overview</H3>
84<BLOCKQUOTE>
85
86<P>
87The <A HREF="overview-summary.html">Overview</A> page is the front page of this API document and provides a list of all packages with a summary for each.  This page can also contain an overall description of the set of packages.</BLOCKQUOTE>
88<H3>
89Package</H3>
90<BLOCKQUOTE>
91
92<P>
93Each package has a page that contains a list of its classes and interfaces, with a summary for each. This page can contain four categories:<UL>
94<LI>Interfaces (italic)<LI>Classes<LI>Enums<LI>Exceptions<LI>Errors<LI>Annotation Types</UL>
95</BLOCKQUOTE>
96<H3>
97Class/Interface</H3>
98<BLOCKQUOTE>
99
100<P>
101Each class, interface, nested class and nested interface has its own separate page. Each of these pages has three sections consisting of a class/interface description, summary tables, and detailed member descriptions:<UL>
102<LI>Class inheritance diagram<LI>Direct Subclasses<LI>All Known Subinterfaces<LI>All Known Implementing Classes<LI>Class/interface declaration<LI>Class/interface description
103<P>
104<LI>Nested Class Summary<LI>Field Summary<LI>Constructor Summary<LI>Method Summary
105<P>
106<LI>Field Detail<LI>Constructor Detail<LI>Method Detail</UL>
107Each summary entry contains the first sentence from the detailed description for that item. The summary entries are alphabetical, while the detailed descriptions are in the order they appear in the source code. This preserves the logical groupings established by the programmer.</BLOCKQUOTE>
108</BLOCKQUOTE>
109<H3>
110Annotation Type</H3>
111<BLOCKQUOTE>
112
113<P>
114Each annotation type has its own separate page with the following sections:<UL>
115<LI>Annotation Type declaration<LI>Annotation Type description<LI>Required Element Summary<LI>Optional Element Summary<LI>Element Detail</UL>
116</BLOCKQUOTE>
117</BLOCKQUOTE>
118<H3>
119Enum</H3>
120<BLOCKQUOTE>
121
122<P>
123Each enum has its own separate page with the following sections:<UL>
124<LI>Enum declaration<LI>Enum description<LI>Enum Constant Summary<LI>Enum Constant Detail</UL>
125</BLOCKQUOTE>
126<H3>
127Use</H3>
128<BLOCKQUOTE>
129Each documented package, class and interface has its own Use page.  This page describes what packages, classes, methods, constructors and fields use any part of the given class or package. Given a class or interface A, its Use page includes subclasses of A, fields declared as A, methods that return A, and methods and constructors with parameters of type A.  You can access this page by first going to the package, class or interface, then clicking on the "Use" link in the navigation bar.</BLOCKQUOTE>
130<H3>
131Tree (Class Hierarchy)</H3>
132<BLOCKQUOTE>
133There is a <A HREF="overview-tree.html">Class Hierarchy</A> page for all packages, plus a hierarchy for each package. Each hierarchy page contains a list of classes and a list of interfaces. The classes are organized by inheritance structure starting with <code>java.lang.Object</code>. The interfaces do not inherit from <code>java.lang.Object</code>.<UL>
134<LI>When viewing the Overview page, clicking on "Tree" displays the hierarchy for all packages.<LI>When viewing a particular package, class or interface page, clicking "Tree" displays the hierarchy for only that package.</UL>
135</BLOCKQUOTE>
136<H3>
137Deprecated API</H3>
138<BLOCKQUOTE>
139The <A HREF="deprecated-list.html">Deprecated API</A> page lists all of the API that have been deprecated. A deprecated API is not recommended for use, generally due to improvements, and a replacement API is usually given. Deprecated APIs may be removed in future implementations.</BLOCKQUOTE>
140<H3>
141Index</H3>
142<BLOCKQUOTE>
143The <A HREF="index-all.html">Index</A> contains an alphabetic list of all classes, interfaces, constructors, methods, and fields.</BLOCKQUOTE>
144<H3>
145Prev/Next</H3>
146These links take you to the next or previous class, interface, package, or related page.<H3>
147Frames/No Frames</H3>
148These links show and hide the HTML frames.  All pages are available with or without frames.
149<P>
150<H3>
151Serialized Form</H3>
152Each serializable or externalizable class has a description of its serialization fields and methods. This information is of interest to re-implementors, not to developers using the API. While there is no link in the navigation bar, you can get to this information by going to any serialized class and clicking "Serialized Form" in the "See also" section of the class description.
153<P>
154<H3>
155Constant Field Values</H3>
156The <a href="constant-values.html">Constant Field Values</a> page lists the static final fields and their values.
157<P>
158<FONT SIZE="-1">
159<EM>
160This help file applies to API documentation generated using the standard doclet.</EM>
161</FONT>
162<BR>
163<HR>
164
165
166<!-- ======= START OF BOTTOM NAVBAR ====== -->
167<A NAME="navbar_bottom"><!-- --></A>
168<A HREF="#skip-navbar_bottom" title="Skip navigation links"></A>
169<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
170<TR>
171<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
172<A NAME="navbar_bottom_firstrow"><!-- --></A>
173<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
174  <TR ALIGN="center" VALIGN="top">
175  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>
176  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <FONT CLASS="NavBarFont1">Package</FONT>&nbsp;</TD>
177  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <FONT CLASS="NavBarFont1">Class</FONT>&nbsp;</TD>
178  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <FONT CLASS="NavBarFont1">Use</FONT>&nbsp;</TD>
179  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="overview-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
180  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>
181  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
182  <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Help</B></FONT>&nbsp;</TD>
183  </TR>
184</TABLE>
185</TD>
186<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
187<b>Berkeley DB</b><br><font size="-1"> version 4.7.25</font></EM>
188</TD>
189</TR>
190
191<TR>
192<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
193&nbsp;PREV&nbsp;
194&nbsp;NEXT</FONT></TD>
195<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
196  <A HREF="index.html?help-doc.html" target="_top"><B>FRAMES</B></A>  &nbsp;
197&nbsp;<A HREF="help-doc.html" target="_top"><B>NO FRAMES</B></A>  &nbsp;
198&nbsp;<SCRIPT type="text/javascript">
199  <!--
200  if(window==top) {
201    document.writeln('<A HREF="allclasses-noframe.html"><B>All Classes</B></A>');
202  }
203  //-->
204</SCRIPT>
205<NOSCRIPT>
206  <A HREF="allclasses-noframe.html"><B>All Classes</B></A>
207</NOSCRIPT>
208
209
210</FONT></TD>
211</TR>
212</TABLE>
213<A NAME="skip-navbar_bottom"></A>
214<!-- ======== END OF BOTTOM NAVBAR ======= -->
215
216<HR>
217<font size=1>Copyright (c) 1996,2008 Oracle.  All rights reserved.</font>
218</BODY>
219</HTML>
220