<!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:43 UTC 2010 --> <TITLE> StoredValueSet </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="StoredValueSet"; } } </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/collection/StoredSortedValueSet.html" title="class in com.sleepycat.bdb.collection"><B>PREV CLASS</B></A> NEXT CLASS</FONT></TD> <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> <A HREF="../../../../index.html?com/sleepycat/bdb/collection/StoredValueSet.html" target="_top"><B>FRAMES</B></A> <A HREF="StoredValueSet.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.collection</FONT> <BR> Class StoredValueSet</H2> <PRE> java.lang.Object <IMG SRC="../../../../resources/inherit.gif" ALT="extended by "><A HREF="../../../../com/sleepycat/bdb/collection/StoredContainer.html" title="class in com.sleepycat.bdb.collection">com.sleepycat.bdb.collection.StoredContainer</A> <IMG SRC="../../../../resources/inherit.gif" ALT="extended by "><A HREF="../../../../com/sleepycat/bdb/collection/StoredCollection.html" title="class in com.sleepycat.bdb.collection">com.sleepycat.bdb.collection.StoredCollection</A> <IMG SRC="../../../../resources/inherit.gif" ALT="extended by "><B>com.sleepycat.bdb.collection.StoredValueSet</B> </PRE> <DL> <DT><B>All Implemented Interfaces:</B> <DD>java.lang.Cloneable, java.lang.Iterable, java.util.Collection, java.util.Set</DD> </DL> <DL> <DT><B>Direct Known Subclasses:</B> <DD><A HREF="../../../../com/sleepycat/bdb/collection/StoredSortedValueSet.html" title="class in com.sleepycat.bdb.collection">StoredSortedValueSet</A></DD> </DL> <HR> <DL> <DT><PRE>public class <B>StoredValueSet</B><DT>extends <A HREF="../../../../com/sleepycat/bdb/collection/StoredCollection.html" title="class in com.sleepycat.bdb.collection">StoredCollection</A><DT>implements java.util.Set</DL> </PRE> <P> The Set returned by Map.values() and Map.duplicates(), and which can also be constructed directly if a Map is not needed. Although this collection is a set it may contain duplicate values. Only if an entity value binding is used are all elements guaranteed to be unique. <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/collection/StoredValueSet.html#StoredValueSet(com.sleepycat.bdb.DataIndex, com.sleepycat.bdb.bind.DataBinding, boolean)">StoredValueSet</A></B>(<A HREF="../../../../com/sleepycat/bdb/DataIndex.html" title="class in com.sleepycat.bdb">DataIndex</A> index, <A HREF="../../../../com/sleepycat/bdb/bind/DataBinding.html" title="interface in com.sleepycat.bdb.bind">DataBinding</A> valueBinding, boolean writeAllowed)</CODE> <BR> Creates a value set view of a <A HREF="../../../../com/sleepycat/bdb/DataIndex.html" title="class in com.sleepycat.bdb"><CODE>DataIndex</CODE></A>.</TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD><CODE><B><A HREF="../../../../com/sleepycat/bdb/collection/StoredValueSet.html#StoredValueSet(com.sleepycat.bdb.DataIndex, com.sleepycat.bdb.bind.EntityBinding, boolean)">StoredValueSet</A></B>(<A HREF="../../../../com/sleepycat/bdb/DataIndex.html" title="class in com.sleepycat.bdb">DataIndex</A> index, <A HREF="../../../../com/sleepycat/bdb/bind/EntityBinding.html" title="interface in com.sleepycat.bdb.bind">EntityBinding</A> valueEntityBinding, boolean writeAllowed)</CODE> <BR> Creates a value set entity view of a <A HREF="../../../../com/sleepycat/bdb/DataIndex.html" title="class in com.sleepycat.bdb"><CODE>DataIndex</CODE></A>.</TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD><CODE><B><A HREF="../../../../com/sleepycat/bdb/collection/StoredValueSet.html#StoredValueSet(com.sleepycat.bdb.DataStore, com.sleepycat.bdb.bind.DataBinding, boolean)">StoredValueSet</A></B>(<A HREF="../../../../com/sleepycat/bdb/DataStore.html" title="class in com.sleepycat.bdb">DataStore</A> store, <A HREF="../../../../com/sleepycat/bdb/bind/DataBinding.html" title="interface in com.sleepycat.bdb.bind">DataBinding</A> valueBinding, boolean writeAllowed)</CODE> <BR> Creates a value set view of a <A HREF="../../../../com/sleepycat/bdb/DataStore.html" title="class in com.sleepycat.bdb"><CODE>DataStore</CODE></A>.</TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD><CODE><B><A HREF="../../../../com/sleepycat/bdb/collection/StoredValueSet.html#StoredValueSet(com.sleepycat.bdb.DataStore, com.sleepycat.bdb.bind.EntityBinding, boolean)">StoredValueSet</A></B>(<A HREF="../../../../com/sleepycat/bdb/DataStore.html" title="class in com.sleepycat.bdb">DataStore</A> store, <A HREF="../../../../com/sleepycat/bdb/bind/EntityBinding.html" title="interface in com.sleepycat.bdb.bind">EntityBinding</A> valueEntityBinding, boolean writeAllowed)</CODE> <BR> Creates a value set entity view of a <A HREF="../../../../com/sleepycat/bdb/DataStore.html" title="class in com.sleepycat.bdb"><CODE>DataStore</CODE></A>.</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> boolean</CODE></FONT></TD> <TD><CODE><B><A HREF="../../../../com/sleepycat/bdb/collection/StoredValueSet.html#add(java.lang.Object)">add</A></B>(java.lang.Object entity)</CODE> <BR> Adds the specified entity to this set if it is not already present (optional operation).</TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> <CODE> boolean</CODE></FONT></TD> <TD><CODE><B><A HREF="../../../../com/sleepycat/bdb/collection/StoredValueSet.html#contains(java.lang.Object)">contains</A></B>(java.lang.Object value)</CODE> <BR> Returns true if this set contains the specified element.</TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> <CODE> boolean</CODE></FONT></TD> <TD><CODE><B><A HREF="../../../../com/sleepycat/bdb/collection/StoredValueSet.html#remove(java.lang.Object)">remove</A></B>(java.lang.Object value)</CODE> <BR> Removes the specified value from this set if it is present (optional operation).</TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> <CODE> int</CODE></FONT></TD> <TD><CODE><B><A HREF="../../../../com/sleepycat/bdb/collection/StoredValueSet.html#size()">size</A></B>()</CODE> <BR> Always throws UnsupportedOperationException.</TD> </TR> </TABLE> <A NAME="methods_inherited_from_class_com.sleepycat.bdb.collection.StoredCollection"><!-- --></A> <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> <TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor"> <TH ALIGN="left"><B>Methods inherited from class com.sleepycat.bdb.collection.<A HREF="../../../../com/sleepycat/bdb/collection/StoredCollection.html" title="class in com.sleepycat.bdb.collection">StoredCollection</A></B></TH> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD><CODE><A HREF="../../../../com/sleepycat/bdb/collection/StoredCollection.html#addAll(java.util.Collection)">addAll</A>, <A HREF="../../../../com/sleepycat/bdb/collection/StoredCollection.html#containsAll(java.util.Collection)">containsAll</A>, <A HREF="../../../../com/sleepycat/bdb/collection/StoredCollection.html#equals(java.lang.Object)">equals</A>, <A HREF="../../../../com/sleepycat/bdb/collection/StoredCollection.html#iterator()">iterator</A>, <A HREF="../../../../com/sleepycat/bdb/collection/StoredCollection.html#iterator(boolean)">iterator</A>, <A HREF="../../../../com/sleepycat/bdb/collection/StoredCollection.html#join(com.sleepycat.bdb.collection.StoredContainer[], java.lang.Object[])">join</A>, <A HREF="../../../../com/sleepycat/bdb/collection/StoredCollection.html#join(com.sleepycat.bdb.collection.StoredContainer[], java.lang.Object[], boolean)">join</A>, <A HREF="../../../../com/sleepycat/bdb/collection/StoredCollection.html#removeAll(java.util.Collection)">removeAll</A>, <A HREF="../../../../com/sleepycat/bdb/collection/StoredCollection.html#retainAll(java.util.Collection)">retainAll</A>, <A HREF="../../../../com/sleepycat/bdb/collection/StoredCollection.html#toArray()">toArray</A>, <A HREF="../../../../com/sleepycat/bdb/collection/StoredCollection.html#toArray(java.lang.Object[])">toArray</A>, <A HREF="../../../../com/sleepycat/bdb/collection/StoredCollection.html#toList()">toList</A>, <A HREF="../../../../com/sleepycat/bdb/collection/StoredCollection.html#toString()">toString</A></CODE></TD> </TR> </TABLE> <A NAME="methods_inherited_from_class_com.sleepycat.bdb.collection.StoredContainer"><!-- --></A> <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> <TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor"> <TH ALIGN="left"><B>Methods inherited from class com.sleepycat.bdb.collection.<A HREF="../../../../com/sleepycat/bdb/collection/StoredContainer.html" title="class in com.sleepycat.bdb.collection">StoredContainer</A></B></TH> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD><CODE><A HREF="../../../../com/sleepycat/bdb/collection/StoredContainer.html#areDuplicatesAllowed()">areDuplicatesAllowed</A>, <A HREF="../../../../com/sleepycat/bdb/collection/StoredContainer.html#areDuplicatesOrdered()">areDuplicatesOrdered</A>, <A HREF="../../../../com/sleepycat/bdb/collection/StoredContainer.html#areKeysRenumbered()">areKeysRenumbered</A>, <A HREF="../../../../com/sleepycat/bdb/collection/StoredContainer.html#clear()">clear</A>, <A HREF="../../../../com/sleepycat/bdb/collection/StoredContainer.html#isAutoCommit()">isAutoCommit</A>, <A HREF="../../../../com/sleepycat/bdb/collection/StoredContainer.html#isDirtyReadAllowed()">isDirtyReadAllowed</A>, <A HREF="../../../../com/sleepycat/bdb/collection/StoredContainer.html#isDirtyReadEnabled()">isDirtyReadEnabled</A>, <A HREF="../../../../com/sleepycat/bdb/collection/StoredContainer.html#isEmpty()">isEmpty</A>, <A HREF="../../../../com/sleepycat/bdb/collection/StoredContainer.html#isIndexed()">isIndexed</A>, <A HREF="../../../../com/sleepycat/bdb/collection/StoredContainer.html#isOrdered()">isOrdered</A>, <A HREF="../../../../com/sleepycat/bdb/collection/StoredContainer.html#isTransactional()">isTransactional</A>, <A HREF="../../../../com/sleepycat/bdb/collection/StoredContainer.html#isWriteAllowed()">isWriteAllowed</A></CODE></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, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait</CODE></TD> </TR> </TABLE> <A NAME="methods_inherited_from_class_java.util.Set"><!-- --></A> <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> <TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor"> <TH ALIGN="left"><B>Methods inherited from interface java.util.Set</B></TH> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD><CODE>addAll, clear, containsAll, equals, hashCode, isEmpty, iterator, removeAll, retainAll, toArray, toArray</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="StoredValueSet(com.sleepycat.bdb.DataStore, com.sleepycat.bdb.bind.DataBinding, boolean)"><!-- --></A><H3> StoredValueSet</H3> <PRE> public <B>StoredValueSet</B>(<A HREF="../../../../com/sleepycat/bdb/DataStore.html" title="class in com.sleepycat.bdb">DataStore</A> store, <A HREF="../../../../com/sleepycat/bdb/bind/DataBinding.html" title="interface in com.sleepycat.bdb.bind">DataBinding</A> valueBinding, boolean writeAllowed)</PRE> <DL> <DD>Creates a value set view of a <A HREF="../../../../com/sleepycat/bdb/DataStore.html" title="class in com.sleepycat.bdb"><CODE>DataStore</CODE></A>. <P> <DL> <DT><B>Parameters:</B><DD><CODE>store</CODE> - is the DataStore underlying the new collection.<DD><CODE>valueBinding</CODE> - is the binding used to translate between value buffers and value objects.<DD><CODE>writeAllowed</CODE> - is true to create a read-write collection or false to create a read-only collection. <DT><B>Throws:</B> <DD><CODE>java.lang.IllegalArgumentException</CODE> - if formats are not consistently defined or a parameter is invalid. <DD><CODE>RuntimeExceptionWrapper</CODE> - if a <A HREF="../../../../com/sleepycat/db/DbException.html" title="class in com.sleepycat.db"><CODE>DbException</CODE></A> is thrown.</DL> </DL> <HR> <A NAME="StoredValueSet(com.sleepycat.bdb.DataStore, com.sleepycat.bdb.bind.EntityBinding, boolean)"><!-- --></A><H3> StoredValueSet</H3> <PRE> public <B>StoredValueSet</B>(<A HREF="../../../../com/sleepycat/bdb/DataStore.html" title="class in com.sleepycat.bdb">DataStore</A> store, <A HREF="../../../../com/sleepycat/bdb/bind/EntityBinding.html" title="interface in com.sleepycat.bdb.bind">EntityBinding</A> valueEntityBinding, boolean writeAllowed)</PRE> <DL> <DD>Creates a value set entity view of a <A HREF="../../../../com/sleepycat/bdb/DataStore.html" title="class in com.sleepycat.bdb"><CODE>DataStore</CODE></A>. <P> <DL> <DT><B>Parameters:</B><DD><CODE>store</CODE> - is the DataStore underlying the new collection.<DD><CODE>valueEntityBinding</CODE> - is the binding used to translate between key/value buffers and entity value objects.<DD><CODE>writeAllowed</CODE> - is true to create a read-write collection or false to create a read-only collection. <DT><B>Throws:</B> <DD><CODE>java.lang.IllegalArgumentException</CODE> - if formats are not consistently defined or a parameter is invalid. <DD><CODE>RuntimeExceptionWrapper</CODE> - if a <A HREF="../../../../com/sleepycat/db/DbException.html" title="class in com.sleepycat.db"><CODE>DbException</CODE></A> is thrown.</DL> </DL> <HR> <A NAME="StoredValueSet(com.sleepycat.bdb.DataIndex, com.sleepycat.bdb.bind.DataBinding, boolean)"><!-- --></A><H3> StoredValueSet</H3> <PRE> public <B>StoredValueSet</B>(<A HREF="../../../../com/sleepycat/bdb/DataIndex.html" title="class in com.sleepycat.bdb">DataIndex</A> index, <A HREF="../../../../com/sleepycat/bdb/bind/DataBinding.html" title="interface in com.sleepycat.bdb.bind">DataBinding</A> valueBinding, boolean writeAllowed)</PRE> <DL> <DD>Creates a value set view of a <A HREF="../../../../com/sleepycat/bdb/DataIndex.html" title="class in com.sleepycat.bdb"><CODE>DataIndex</CODE></A>. <P> <DL> <DT><B>Parameters:</B><DD><CODE>index</CODE> - is the DataIndex underlying the new collection.<DD><CODE>valueBinding</CODE> - is the binding used to translate between value buffers and value objects.<DD><CODE>writeAllowed</CODE> - is true to create a read-write collection or false to create a read-only collection. <DT><B>Throws:</B> <DD><CODE>java.lang.IllegalArgumentException</CODE> - if formats are not consistently defined or a parameter is invalid. <DD><CODE>RuntimeExceptionWrapper</CODE> - if a <A HREF="../../../../com/sleepycat/db/DbException.html" title="class in com.sleepycat.db"><CODE>DbException</CODE></A> is thrown.</DL> </DL> <HR> <A NAME="StoredValueSet(com.sleepycat.bdb.DataIndex, com.sleepycat.bdb.bind.EntityBinding, boolean)"><!-- --></A><H3> StoredValueSet</H3> <PRE> public <B>StoredValueSet</B>(<A HREF="../../../../com/sleepycat/bdb/DataIndex.html" title="class in com.sleepycat.bdb">DataIndex</A> index, <A HREF="../../../../com/sleepycat/bdb/bind/EntityBinding.html" title="interface in com.sleepycat.bdb.bind">EntityBinding</A> valueEntityBinding, boolean writeAllowed)</PRE> <DL> <DD>Creates a value set entity view of a <A HREF="../../../../com/sleepycat/bdb/DataIndex.html" title="class in com.sleepycat.bdb"><CODE>DataIndex</CODE></A>. <P> <DL> <DT><B>Parameters:</B><DD><CODE>index</CODE> - is the DataIndex underlying the new collection.<DD><CODE>valueEntityBinding</CODE> - is the binding used to translate between key/value buffers and entity value objects.<DD><CODE>writeAllowed</CODE> - is true to create a read-write collection or false to create a read-only collection. <DT><B>Throws:</B> <DD><CODE>java.lang.IllegalArgumentException</CODE> - if formats are not consistently defined or a parameter is invalid. <DD><CODE>RuntimeExceptionWrapper</CODE> - if a <A HREF="../../../../com/sleepycat/db/DbException.html" title="class in com.sleepycat.db"><CODE>DbException</CODE></A> is thrown.</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="add(java.lang.Object)"><!-- --></A><H3> add</H3> <PRE> public boolean <B>add</B>(java.lang.Object entity)</PRE> <DL> <DD>Adds the specified entity to this set if it is not already present (optional operation). This method conforms to the <CODE>Set.add(E)</CODE> interface. <P> <DD><DL> <DT><B>Specified by:</B><DD><CODE>add</CODE> in interface <CODE>java.util.Collection</CODE><DT><B>Specified by:</B><DD><CODE>add</CODE> in interface <CODE>java.util.Set</CODE></DL> </DD> <DD><DL> <DT><B>Parameters:</B><DD><CODE>entity</CODE> - is the entity to be added. <DT><B>Returns:</B><DD>true if the entity was added, that is the key-value pair represented by the entity was not previously present in the collection. <DT><B>Throws:</B> <DD><CODE>java.lang.UnsupportedOperationException</CODE> - if the collection is read-only, if the collection is indexed, or if an entity binding is not used. <DD><CODE>RuntimeExceptionWrapper</CODE> - if a <A HREF="../../../../com/sleepycat/db/DbException.html" title="class in com.sleepycat.db"><CODE>DbException</CODE></A> is thrown.</DL> </DD> </DL> <HR> <A NAME="contains(java.lang.Object)"><!-- --></A><H3> contains</H3> <PRE> public boolean <B>contains</B>(java.lang.Object value)</PRE> <DL> <DD>Returns true if this set contains the specified element. This method conforms to the <CODE>Set.contains(Object)</CODE> interface. <P> <DD><DL> <DT><B>Specified by:</B><DD><CODE>contains</CODE> in interface <CODE>java.util.Collection</CODE><DT><B>Specified by:</B><DD><CODE>contains</CODE> in interface <CODE>java.util.Set</CODE></DL> </DD> <DD><DL> <DT><B>Parameters:</B><DD><CODE>value</CODE> - the value to check. <DT><B>Returns:</B><DD>whether the set contains the given value.</DL> </DD> </DL> <HR> <A NAME="remove(java.lang.Object)"><!-- --></A><H3> remove</H3> <PRE> public boolean <B>remove</B>(java.lang.Object value)</PRE> <DL> <DD>Removes the specified value from this set if it is present (optional operation). If an entity binding is used, the key-value pair represented by the given entity is removed. If an entity binding is used, the first occurance of a key-value pair with the given value is removed. This method conforms to the <CODE>Set.remove(java.lang.Object)</CODE> interface. <P> <DD><DL> <DT><B>Specified by:</B><DD><CODE>remove</CODE> in interface <CODE>java.util.Collection</CODE><DT><B>Specified by:</B><DD><CODE>remove</CODE> in interface <CODE>java.util.Set</CODE></DL> </DD> <DD><DL> <DT><B>Throws:</B> <DD><CODE>java.lang.UnsupportedOperationException</CODE> - if the collection is read-only. <DD><CODE>RuntimeExceptionWrapper</CODE> - if a <A HREF="../../../../com/sleepycat/db/DbException.html" title="class in com.sleepycat.db"><CODE>DbException</CODE></A> is thrown.</DL> </DD> </DL> <HR> <A NAME="size()"><!-- --></A><H3> size</H3> <PRE> public int <B>size</B>()</PRE> <DL> <DD><B>Description copied from class: <CODE><A HREF="../../../../com/sleepycat/bdb/collection/StoredContainer.html#size()">StoredContainer</A></CODE></B></DD> <DD>Always throws UnsupportedOperationException. The size of a database cannot be obtained reliably or inexpensively. This method therefore violates the <CODE>Collection.size()</CODE> and <CODE>Map.size()</CODE> interfaces. <P> <DD><DL> <DT><B>Specified by:</B><DD><CODE>size</CODE> in interface <CODE>java.util.Collection</CODE><DT><B>Specified by:</B><DD><CODE>size</CODE> in interface <CODE>java.util.Set</CODE><DT><B>Overrides:</B><DD><CODE><A HREF="../../../../com/sleepycat/bdb/collection/StoredContainer.html#size()">size</A></CODE> in class <CODE><A HREF="../../../../com/sleepycat/bdb/collection/StoredContainer.html" title="class in com.sleepycat.bdb.collection">StoredContainer</A></CODE></DL> </DD> <DD><DL> <DT><B>Returns:</B><DD>always throws an exception.</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/collection/StoredSortedValueSet.html" title="class in com.sleepycat.bdb.collection"><B>PREV CLASS</B></A> NEXT CLASS</FONT></TD> <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> <A HREF="../../../../index.html?com/sleepycat/bdb/collection/StoredValueSet.html" target="_top"><B>FRAMES</B></A> <A HREF="StoredValueSet.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>