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:33 EDT 2008 -->
6<TITLE>
7StoredValueSet (Oracle - Berkeley DB Java API)
8</TITLE>
9
10<META NAME="keywords" CONTENT="com.sleepycat.collections.StoredValueSet class">
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="StoredValueSet (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>&nbsp;</TD>
38  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
39  <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
40  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="class-use/StoredValueSet.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A>&nbsp;</TD>
41  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
42  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="/deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>
43  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="/index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
44  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="/help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</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&nbsp;<A HREF="/com/sleepycat/collections/StoredSortedValueSet.html" title="class in com.sleepycat.collections"><B>PREV CLASS</B></A>&nbsp;
56&nbsp;<A HREF="/com/sleepycat/collections/TransactionRunner.html" title="class in com.sleepycat.collections"><B>NEXT CLASS</B></A></FONT></TD>
57<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
58  <A HREF="/index.html?com/sleepycat/collections/StoredValueSet.html" target="_top"><B>FRAMES</B></A>  &nbsp;
59&nbsp;<A HREF="StoredValueSet.html" target="_top"><B>NO FRAMES</B></A>  &nbsp;
60&nbsp;<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:&nbsp;NESTED&nbsp;|&nbsp;<A HREF="#fields_inherited_from_class_com.sleepycat.collections.StoredCollection">FIELD</A>&nbsp;|&nbsp;<A HREF="#constructor_summary">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>
77<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
78DETAIL:&nbsp;FIELD&nbsp;|&nbsp;<A HREF="#constructor_detail">CONSTR</A>&nbsp;|&nbsp;<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.collections</FONT>
89<BR>
90Class StoredValueSet</H2>
91<PRE>
92<A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Object.html" title="class or interface in java.lang">java.lang.Object</A>
93  <IMG SRC="/resources/inherit.gif" ALT="extended by "><A HREF="/com/sleepycat/collections/StoredContainer.html" title="class in com.sleepycat.collections">com.sleepycat.collections.StoredContainer</A>
94      <IMG SRC="/resources/inherit.gif" ALT="extended by "><A HREF="/com/sleepycat/collections/StoredCollection.html" title="class in com.sleepycat.collections">com.sleepycat.collections.StoredCollection</A>
95          <IMG SRC="/resources/inherit.gif" ALT="extended by "><B>com.sleepycat.collections.StoredValueSet</B>
96</PRE>
97<DL>
98<DT><B>All Implemented Interfaces:</B> <DD><A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Cloneable.html" title="class or interface in java.lang">Cloneable</A>, <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Iterable.html" title="class or interface in java.lang">Iterable</A>, <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/util/Collection.html" title="class or interface in java.util">Collection</A>, <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/util/Set.html" title="class or interface in java.util">Set</A></DD>
99</DL>
100<DL>
101<DT><B>Direct Known Subclasses:</B> <DD><A HREF="/com/sleepycat/collections/StoredSortedValueSet.html" title="class in com.sleepycat.collections">StoredSortedValueSet</A></DD>
102</DL>
103<HR>
104<DL>
105<DT><PRE>public class <B>StoredValueSet</B><DT>extends <A HREF="/com/sleepycat/collections/StoredCollection.html" title="class in com.sleepycat.collections">StoredCollection</A><DT>implements <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/util/Set.html" title="class or interface in java.util">Set</A></DL>
106</PRE>
107
108<P>
109The Set returned by Map.values() and Map.duplicates(), and which can also be
110 constructed directly if a Map is not needed.
111 Although this collection is a set it may contain duplicate values.  Only if
112 an entity value binding is used are all elements guaranteed to be unique.
113<P>
114
115<P>
116<HR>
117
118<P>
119<!-- =========== FIELD SUMMARY =========== -->
120
121<A NAME="field_summary"><!-- --></A>
122<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
123<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
124<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
125<B>Field Summary</B></FONT></TH>
126</TR>
127</TABLE>
128&nbsp;<A NAME="fields_inherited_from_class_com.sleepycat.collections.StoredCollection"><!-- --></A>
129<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
130<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
131<TH ALIGN="left"><B>Fields inherited from class com.sleepycat.collections.<A HREF="/com/sleepycat/collections/StoredCollection.html" title="class in com.sleepycat.collections">StoredCollection</A></B></TH>
132</TR>
133<TR BGCOLOR="white" CLASS="TableRowColor">
134<TD><CODE><A HREF="/com/sleepycat/collections/StoredCollection.html#DEFAULT_ITERATOR_BLOCK_SIZE">DEFAULT_ITERATOR_BLOCK_SIZE</A></CODE></TD>
135</TR>
136</TABLE>
137&nbsp;
138<!-- ======== CONSTRUCTOR SUMMARY ======== -->
139
140<A NAME="constructor_summary"><!-- --></A>
141<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
142<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
143<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
144<B>Constructor Summary</B></FONT></TH>
145</TR>
146<TR BGCOLOR="white" CLASS="TableRowColor">
147<TD><CODE><B><A HREF="/com/sleepycat/collections/StoredValueSet.html#StoredValueSet(com.sleepycat.db.Database, com.sleepycat.bind.EntityBinding, boolean)">StoredValueSet</A></B>(<A HREF="/com/sleepycat/db/Database.html" title="class in com.sleepycat.db">Database</A>&nbsp;database,
148               <A HREF="/com/sleepycat/bind/EntityBinding.html" title="interface in com.sleepycat.bind">EntityBinding</A>&nbsp;valueEntityBinding,
149               boolean&nbsp;writeAllowed)</CODE>
150
151<BR>
152&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Creates a value set entity view of a <A HREF="/com/sleepycat/db/Database.html" title="class in com.sleepycat.db"><CODE>Database</CODE></A>.</TD>
153</TR>
154<TR BGCOLOR="white" CLASS="TableRowColor">
155<TD><CODE><B><A HREF="/com/sleepycat/collections/StoredValueSet.html#StoredValueSet(com.sleepycat.db.Database, com.sleepycat.bind.EntryBinding, boolean)">StoredValueSet</A></B>(<A HREF="/com/sleepycat/db/Database.html" title="class in com.sleepycat.db">Database</A>&nbsp;database,
156               <A HREF="/com/sleepycat/bind/EntryBinding.html" title="interface in com.sleepycat.bind">EntryBinding</A>&nbsp;valueBinding,
157               boolean&nbsp;writeAllowed)</CODE>
158
159<BR>
160&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Creates a value set view of a <A HREF="/com/sleepycat/db/Database.html" title="class in com.sleepycat.db"><CODE>Database</CODE></A>.</TD>
161</TR>
162</TABLE>
163&nbsp;
164<!-- ========== METHOD SUMMARY =========== -->
165
166<A NAME="method_summary"><!-- --></A>
167<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
168<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
169<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
170<B>Method Summary</B></FONT></TH>
171</TR>
172<TR BGCOLOR="white" CLASS="TableRowColor">
173<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
174<CODE>&nbsp;boolean</CODE></FONT></TD>
175<TD><CODE><B><A HREF="/com/sleepycat/collections/StoredValueSet.html#add(java.lang.Object)">add</A></B>(<A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Object.html" title="class or interface in java.lang">Object</A>&nbsp;entity)</CODE>
176
177<BR>
178&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Adds the specified entity to this set if it is not already present
179 (optional operation).</TD>
180</TR>
181<TR BGCOLOR="white" CLASS="TableRowColor">
182<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
183<CODE>&nbsp;boolean</CODE></FONT></TD>
184<TD><CODE><B><A HREF="/com/sleepycat/collections/StoredValueSet.html#contains(java.lang.Object)">contains</A></B>(<A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Object.html" title="class or interface in java.lang">Object</A>&nbsp;value)</CODE>
185
186<BR>
187&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns true if this set contains the specified element.</TD>
188</TR>
189<TR BGCOLOR="white" CLASS="TableRowColor">
190<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
191<CODE>&nbsp;boolean</CODE></FONT></TD>
192<TD><CODE><B><A HREF="/com/sleepycat/collections/StoredValueSet.html#remove(java.lang.Object)">remove</A></B>(<A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Object.html" title="class or interface in java.lang">Object</A>&nbsp;value)</CODE>
193
194<BR>
195&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Removes the specified value from this set if it is present (optional
196 operation).</TD>
197</TR>
198</TABLE>
199&nbsp;<A NAME="methods_inherited_from_class_com.sleepycat.collections.StoredCollection"><!-- --></A>
200<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
201<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
202<TH ALIGN="left"><B>Methods inherited from class com.sleepycat.collections.<A HREF="/com/sleepycat/collections/StoredCollection.html" title="class in com.sleepycat.collections">StoredCollection</A></B></TH>
203</TR>
204<TR BGCOLOR="white" CLASS="TableRowColor">
205<TD><CODE><A HREF="/com/sleepycat/collections/StoredCollection.html#addAll(java.util.Collection)">addAll</A>, <A HREF="/com/sleepycat/collections/StoredCollection.html#containsAll(java.util.Collection)">containsAll</A>, <A HREF="/com/sleepycat/collections/StoredCollection.html#equals(java.lang.Object)">equals</A>, <A HREF="/com/sleepycat/collections/StoredCollection.html#getIteratorBlockSize()">getIteratorBlockSize</A>, <A HREF="/com/sleepycat/collections/StoredCollection.html#hashCode()">hashCode</A>, <A HREF="/com/sleepycat/collections/StoredCollection.html#iterator()">iterator</A>, <A HREF="/com/sleepycat/collections/StoredCollection.html#iterator(boolean)">iterator</A>, <A HREF="/com/sleepycat/collections/StoredCollection.html#join(com.sleepycat.collections.StoredContainer[], java.lang.Object[], com.sleepycat.db.JoinConfig)">join</A>, <A HREF="/com/sleepycat/collections/StoredCollection.html#removeAll(java.util.Collection)">removeAll</A>, <A HREF="/com/sleepycat/collections/StoredCollection.html#retainAll(java.util.Collection)">retainAll</A>, <A HREF="/com/sleepycat/collections/StoredCollection.html#setIteratorBlockSize(int)">setIteratorBlockSize</A>, <A HREF="/com/sleepycat/collections/StoredCollection.html#size()">size</A>, <A HREF="/com/sleepycat/collections/StoredCollection.html#storedIterator()">storedIterator</A>, <A HREF="/com/sleepycat/collections/StoredCollection.html#storedIterator(boolean)">storedIterator</A>, <A HREF="/com/sleepycat/collections/StoredCollection.html#toArray()">toArray</A>, <A HREF="/com/sleepycat/collections/StoredCollection.html#toArray(java.lang.Object[])">toArray</A>, <A HREF="/com/sleepycat/collections/StoredCollection.html#toList()">toList</A>, <A HREF="/com/sleepycat/collections/StoredCollection.html#toString()">toString</A></CODE></TD>
206</TR>
207</TABLE>
208&nbsp;<A NAME="methods_inherited_from_class_com.sleepycat.collections.StoredContainer"><!-- --></A>
209<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
210<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
211<TH ALIGN="left"><B>Methods inherited from class com.sleepycat.collections.<A HREF="/com/sleepycat/collections/StoredContainer.html" title="class in com.sleepycat.collections">StoredContainer</A></B></TH>
212</TR>
213<TR BGCOLOR="white" CLASS="TableRowColor">
214<TD><CODE><A HREF="/com/sleepycat/collections/StoredContainer.html#areDuplicatesAllowed()">areDuplicatesAllowed</A>, <A HREF="/com/sleepycat/collections/StoredContainer.html#areDuplicatesOrdered()">areDuplicatesOrdered</A>, <A HREF="/com/sleepycat/collections/StoredContainer.html#areKeyRangesAllowed()">areKeyRangesAllowed</A>, <A HREF="/com/sleepycat/collections/StoredContainer.html#areKeysRenumbered()">areKeysRenumbered</A>, <A HREF="/com/sleepycat/collections/StoredContainer.html#clear()">clear</A>, <A HREF="/com/sleepycat/collections/StoredContainer.html#getCursorConfig()">getCursorConfig</A>, <A HREF="/com/sleepycat/collections/StoredContainer.html#isDirtyRead()">isDirtyRead</A>, <A HREF="/com/sleepycat/collections/StoredContainer.html#isDirtyReadAllowed()">isDirtyReadAllowed</A>, <A HREF="/com/sleepycat/collections/StoredContainer.html#isEmpty()">isEmpty</A>, <A HREF="/com/sleepycat/collections/StoredContainer.html#isOrdered()">isOrdered</A>, <A HREF="/com/sleepycat/collections/StoredContainer.html#isSecondary()">isSecondary</A>, <A HREF="/com/sleepycat/collections/StoredContainer.html#isTransactional()">isTransactional</A>, <A HREF="/com/sleepycat/collections/StoredContainer.html#isWriteAllowed()">isWriteAllowed</A></CODE></TD>
215</TR>
216</TABLE>
217&nbsp;<A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A>
218<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
219<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
220<TH ALIGN="left"><B>Methods inherited from class java.lang.<A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Object.html" title="class or interface in java.lang">Object</A></B></TH>
221</TR>
222<TR BGCOLOR="white" CLASS="TableRowColor">
223<TD><CODE><A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Object.html#clone()" title="class or interface in java.lang">clone</A>, <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Object.html#finalize()" title="class or interface in java.lang">finalize</A>, <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Object.html#getClass()" title="class or interface in java.lang">getClass</A>, <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Object.html#notify()" title="class or interface in java.lang">notify</A>, <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Object.html#notifyAll()" title="class or interface in java.lang">notifyAll</A>, <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Object.html#wait()" title="class or interface in java.lang">wait</A>, <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Object.html#wait(long)" title="class or interface in java.lang">wait</A>, <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Object.html#wait(long, int)" title="class or interface in java.lang">wait</A></CODE></TD>
224</TR>
225</TABLE>
226&nbsp;<A NAME="methods_inherited_from_class_java.util.Set"><!-- --></A>
227<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
228<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
229<TH ALIGN="left"><B>Methods inherited from interface java.util.<A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/util/Set.html" title="class or interface in java.util">Set</A></B></TH>
230</TR>
231<TR BGCOLOR="white" CLASS="TableRowColor">
232<TD><CODE><A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/util/Set.html#addAll(java.util.Collection)" title="class or interface in java.util">addAll</A>, <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/util/Set.html#clear()" title="class or interface in java.util">clear</A>, <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/util/Set.html#containsAll(java.util.Collection)" title="class or interface in java.util">containsAll</A>, <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/util/Set.html#equals(java.lang.Object)" title="class or interface in java.util">equals</A>, <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/util/Set.html#hashCode()" title="class or interface in java.util">hashCode</A>, <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/util/Set.html#isEmpty()" title="class or interface in java.util">isEmpty</A>, <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/util/Set.html#iterator()" title="class or interface in java.util">iterator</A>, <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/util/Set.html#removeAll(java.util.Collection)" title="class or interface in java.util">removeAll</A>, <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/util/Set.html#retainAll(java.util.Collection)" title="class or interface in java.util">retainAll</A>, <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/util/Set.html#size()" title="class or interface in java.util">size</A>, <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/util/Set.html#toArray()" title="class or interface in java.util">toArray</A>, <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/util/Set.html#toArray(T[])" title="class or interface in java.util">toArray</A></CODE></TD>
233</TR>
234</TABLE>
235&nbsp;
236<P>
237
238<!-- ========= CONSTRUCTOR DETAIL ======== -->
239
240<A NAME="constructor_detail"><!-- --></A>
241<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
242<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
243<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
244<B>Constructor Detail</B></FONT></TH>
245</TR>
246</TABLE>
247
248<A NAME="StoredValueSet(com.sleepycat.db.Database, com.sleepycat.bind.EntryBinding, boolean)"><!-- --></A><H3>
249StoredValueSet</H3>
250<PRE>
251public <B>StoredValueSet</B>(<A HREF="/com/sleepycat/db/Database.html" title="class in com.sleepycat.db">Database</A>&nbsp;database,
252                      <A HREF="/com/sleepycat/bind/EntryBinding.html" title="interface in com.sleepycat.bind">EntryBinding</A>&nbsp;valueBinding,
253                      boolean&nbsp;writeAllowed)</PRE>
254<DL>
255<DD>Creates a value set view of a <A HREF="/com/sleepycat/db/Database.html" title="class in com.sleepycat.db"><CODE>Database</CODE></A>.
256<P>
257<DL>
258<DT><B>Parameters:</B><DD><CODE>database</CODE> - is the Database underlying the new collection.<DD><CODE>valueBinding</CODE> - is the binding used to translate between value
259 buffers and value objects.<DD><CODE>writeAllowed</CODE> - is true to create a read-write collection or false
260 to create a read-only collection.
261<DT><B>Throws:</B>
262<DD><CODE><A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/IllegalArgumentException.html" title="class or interface in java.lang">IllegalArgumentException</A></CODE> - if formats are not consistently
263 defined or a parameter is invalid.
264<DD><CODE>RuntimeExceptionWrapper</CODE> - if a <A HREF="/com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db"><CODE>DatabaseException</CODE></A> is
265 thrown.</DL>
266</DL>
267<HR>
268
269<A NAME="StoredValueSet(com.sleepycat.db.Database, com.sleepycat.bind.EntityBinding, boolean)"><!-- --></A><H3>
270StoredValueSet</H3>
271<PRE>
272public <B>StoredValueSet</B>(<A HREF="/com/sleepycat/db/Database.html" title="class in com.sleepycat.db">Database</A>&nbsp;database,
273                      <A HREF="/com/sleepycat/bind/EntityBinding.html" title="interface in com.sleepycat.bind">EntityBinding</A>&nbsp;valueEntityBinding,
274                      boolean&nbsp;writeAllowed)</PRE>
275<DL>
276<DD>Creates a value set entity view of a <A HREF="/com/sleepycat/db/Database.html" title="class in com.sleepycat.db"><CODE>Database</CODE></A>.
277<P>
278<DL>
279<DT><B>Parameters:</B><DD><CODE>database</CODE> - is the Database underlying the new collection.<DD><CODE>valueEntityBinding</CODE> - is the binding used to translate between
280 key/value buffers and entity value objects.<DD><CODE>writeAllowed</CODE> - is true to create a read-write collection or false
281 to create a read-only collection.
282<DT><B>Throws:</B>
283<DD><CODE><A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/IllegalArgumentException.html" title="class or interface in java.lang">IllegalArgumentException</A></CODE> - if formats are not consistently
284 defined or a parameter is invalid.
285<DD><CODE>RuntimeExceptionWrapper</CODE> - if a <A HREF="/com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db"><CODE>DatabaseException</CODE></A> is
286 thrown.</DL>
287</DL>
288
289<!-- ============ METHOD DETAIL ========== -->
290
291<A NAME="method_detail"><!-- --></A>
292<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
293<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
294<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
295<B>Method Detail</B></FONT></TH>
296</TR>
297</TABLE>
298
299<A NAME="add(java.lang.Object)"><!-- --></A><H3>
300add</H3>
301<PRE>
302public boolean <B>add</B>(<A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Object.html" title="class or interface in java.lang">Object</A>&nbsp;entity)</PRE>
303<DL>
304<DD>Adds the specified entity to this set if it is not already present
305 (optional operation).
306 This method conforms to the <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/util/Set.html#add(E)" title="class or interface in java.util"><CODE>Set.add(E)</CODE></A> interface.
307<P>
308<DD><DL>
309<DT><B>Specified by:</B><DD><CODE><A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/util/Collection.html#add(E)" title="class or interface in java.util">add</A></CODE> in interface <CODE><A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/util/Collection.html" title="class or interface in java.util">Collection</A></CODE><DT><B>Specified by:</B><DD><CODE><A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/util/Set.html#add(E)" title="class or interface in java.util">add</A></CODE> in interface <CODE><A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/util/Set.html" title="class or interface in java.util">Set</A></CODE></DL>
310</DD>
311<DD><DL>
312<DT><B>Parameters:</B><DD><CODE>entity</CODE> - is the entity to be added.
313<DT><B>Returns:</B><DD>true if the entity was added, that is the key-value pair
314 represented by the entity was not previously present in the collection.
315<DT><B>Throws:</B>
316<DD><CODE><A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/UnsupportedOperationException.html" title="class or interface in java.lang">UnsupportedOperationException</A></CODE> - if the collection is read-only,
317 if the collection is indexed, or if an entity binding is not used.
318<DD><CODE>RuntimeExceptionWrapper</CODE> - if a <A HREF="/com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db"><CODE>DatabaseException</CODE></A> is
319 thrown.</DL>
320</DD>
321</DL>
322<HR>
323
324<A NAME="contains(java.lang.Object)"><!-- --></A><H3>
325contains</H3>
326<PRE>
327public boolean <B>contains</B>(<A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Object.html" title="class or interface in java.lang">Object</A>&nbsp;value)</PRE>
328<DL>
329<DD>Returns true if this set contains the specified element.
330 This method conforms to the <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/util/Set.html#contains(java.lang.Object)" title="class or interface in java.util"><CODE>Set.contains(java.lang.Object)</CODE></A>
331 interface.
332<P>
333<DD><DL>
334<DT><B>Specified by:</B><DD><CODE><A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/util/Collection.html#contains(java.lang.Object)" title="class or interface in java.util">contains</A></CODE> in interface <CODE><A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/util/Collection.html" title="class or interface in java.util">Collection</A></CODE><DT><B>Specified by:</B><DD><CODE><A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/util/Set.html#contains(java.lang.Object)" title="class or interface in java.util">contains</A></CODE> in interface <CODE><A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/util/Set.html" title="class or interface in java.util">Set</A></CODE></DL>
335</DD>
336<DD><DL>
337<DT><B>Parameters:</B><DD><CODE>value</CODE> - the value to check.
338<DT><B>Returns:</B><DD>whether the set contains the given value.</DL>
339</DD>
340</DL>
341<HR>
342
343<A NAME="remove(java.lang.Object)"><!-- --></A><H3>
344remove</H3>
345<PRE>
346public boolean <B>remove</B>(<A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Object.html" title="class or interface in java.lang">Object</A>&nbsp;value)</PRE>
347<DL>
348<DD>Removes the specified value from this set if it is present (optional
349 operation).
350 If an entity binding is used, the key-value pair represented by the
351 given entity is removed.  If an entity binding is used, the first
352 occurrence of a key-value pair with the given value is removed.
353 This method conforms to the <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/util/Set.html#remove(java.lang.Object)" title="class or interface in java.util"><CODE>Set.remove(java.lang.Object)</CODE></A> interface.
354<P>
355<DD><DL>
356<DT><B>Specified by:</B><DD><CODE><A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/util/Collection.html#remove(java.lang.Object)" title="class or interface in java.util">remove</A></CODE> in interface <CODE><A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/util/Collection.html" title="class or interface in java.util">Collection</A></CODE><DT><B>Specified by:</B><DD><CODE><A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/util/Set.html#remove(java.lang.Object)" title="class or interface in java.util">remove</A></CODE> in interface <CODE><A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/util/Set.html" title="class or interface in java.util">Set</A></CODE></DL>
357</DD>
358<DD><DL>
359
360<DT><B>Throws:</B>
361<DD><CODE><A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/UnsupportedOperationException.html" title="class or interface in java.lang">UnsupportedOperationException</A></CODE> - if the collection is read-only.
362<DD><CODE>RuntimeExceptionWrapper</CODE> - if a <A HREF="/com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db"><CODE>DatabaseException</CODE></A> is
363 thrown.</DL>
364</DD>
365</DL>
366<!-- ========= END OF CLASS DATA ========= -->
367<HR>
368
369
370<!-- ======= START OF BOTTOM NAVBAR ====== -->
371<A NAME="navbar_bottom"><!-- --></A>
372<A HREF="#skip-navbar_bottom" title="Skip navigation links"></A>
373<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
374<TR>
375<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
376<A NAME="navbar_bottom_firstrow"><!-- --></A>
377<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
378  <TR ALIGN="center" VALIGN="top">
379  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="/overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>
380  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
381  <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
382  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="class-use/StoredValueSet.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A>&nbsp;</TD>
383  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
384  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="/deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>
385  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="/index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
386  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="/help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
387  </TR>
388</TABLE>
389</TD>
390<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
391<b>Berkeley DB</b><br><font size="-1"> version 4.7.25</font></EM>
392</TD>
393</TR>
394
395<TR>
396<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
397&nbsp;<A HREF="/com/sleepycat/collections/StoredSortedValueSet.html" title="class in com.sleepycat.collections"><B>PREV CLASS</B></A>&nbsp;
398&nbsp;<A HREF="/com/sleepycat/collections/TransactionRunner.html" title="class in com.sleepycat.collections"><B>NEXT CLASS</B></A></FONT></TD>
399<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
400  <A HREF="/index.html?com/sleepycat/collections/StoredValueSet.html" target="_top"><B>FRAMES</B></A>  &nbsp;
401&nbsp;<A HREF="StoredValueSet.html" target="_top"><B>NO FRAMES</B></A>  &nbsp;
402&nbsp;<SCRIPT type="text/javascript">
403  <!--
404  if(window==top) {
405    document.writeln('<A HREF="/allclasses-noframe.html"><B>All Classes</B></A>');
406  }
407  //-->
408</SCRIPT>
409<NOSCRIPT>
410  <A HREF="/allclasses-noframe.html"><B>All Classes</B></A>
411</NOSCRIPT>
412
413
414</FONT></TD>
415</TR>
416<TR>
417<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
418  SUMMARY:&nbsp;NESTED&nbsp;|&nbsp;<A HREF="#fields_inherited_from_class_com.sleepycat.collections.StoredCollection">FIELD</A>&nbsp;|&nbsp;<A HREF="#constructor_summary">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>
419<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
420DETAIL:&nbsp;FIELD&nbsp;|&nbsp;<A HREF="#constructor_detail">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></FONT></TD>
421</TR>
422</TABLE>
423<A NAME="skip-navbar_bottom"></A>
424<!-- ======== END OF BOTTOM NAVBAR ======= -->
425
426<HR>
427<font size=1>Copyright (c) 1996,2008 Oracle.  All rights reserved.</font>
428</BODY>
429</HTML>
430