StoredValueSet.html [plain text]
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN""http://www.w3.org/TR/REC-html40/loose.dtd">
<!--NewPage-->
<HTML>
<HEAD>
<!-- Generated by javadoc on Wed Dec 03 16:22:08 EST 2003 -->
<TITLE>
StoredValueSet (Sleepycat Software, Inc. - Berkeley DB Java API)
</TITLE>
<META NAME="keywords" CONTENT="com.sleepycat.bdb.collection.StoredValueSet,StoredValueSet class">
<LINK REL ="stylesheet" TYPE="text/css" HREF="../../../../style.css" TITLE="Style">
</HEAD>
<SCRIPT>
function asd()
{
parent.document.title="StoredValueSet (Sleepycat Software, Inc. - Berkeley DB Java API)";
}
</SCRIPT>
<BODY BGCOLOR="white" onload="asd();">
<!-- ========== START OF NAVBAR ========== -->
<A NAME="navbar_top"><!-- --></A>
<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0">
<TR>
<TD COLSPAN=3 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
<A NAME="navbar_top_firstrow"><!-- --></A>
<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3">
<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="class-use/StoredValueSet.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A> </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>
<b>Berkeley DB</b><br><font size="-1"> version 4.2.52</font></EM>
</TD>
</TR>
<TR>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
<A HREF="../../../../com/sleepycat/bdb/collection/StoredSortedValueSet.html"><B>PREV CLASS</B></A>
NEXT CLASS</FONT></TD>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
<A HREF="../../../../index.html" TARGET="_top"><B>FRAMES</B></A>
<A HREF="StoredValueSet.html" TARGET="_top"><B>NO FRAMES</B></A>
<SCRIPT>
<!--
if(window==top) {
document.writeln('<A HREF="../../../../allclasses-noframe.html" TARGET=""><B>All Classes</B></A>');
}
</SCRIPT>
<NOSCRIPT>
<A HREF="../../../../allclasses-noframe.html" TARGET=""><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>
<!-- =========== END OF NAVBAR =========== -->
<HR>
<!-- ======== START OF CLASS DATA ======== -->
<H2>
<FONT SIZE="-1">
com.sleepycat.bdb.collection</FONT>
<BR>
Class StoredValueSet</H2>
<PRE>
<A HREF="http://java.sun.com/j2se/1.3/docs/api/java/lang/Object.html">java.lang.Object</A>
|
+--<A HREF="../../../../com/sleepycat/bdb/collection/StoredContainer.html">com.sleepycat.bdb.collection.StoredContainer</A>
|
+--<A HREF="../../../../com/sleepycat/bdb/collection/StoredCollection.html">com.sleepycat.bdb.collection.StoredCollection</A>
|
+--<B>com.sleepycat.bdb.collection.StoredValueSet</B>
</PRE>
<DL>
<DT><B>All Implemented Interfaces:</B> <DD><A HREF="http://java.sun.com/j2se/1.3/docs/api/java/lang/Cloneable.html">Cloneable</A>, <A HREF="http://java.sun.com/j2se/1.3/docs/api/java/util/Collection.html">Collection</A>, <A HREF="http://java.sun.com/j2se/1.3/docs/api/java/util/Set.html">Set</A></DD>
</DL>
<DL>
<DT><B>Direct Known Subclasses:</B> <DD><A HREF="../../../../com/sleepycat/bdb/collection/StoredSortedValueSet.html">StoredSortedValueSet</A></DD>
</DL>
<HR>
<DL>
<DT>public class <B>StoredValueSet</B><DT>extends <A HREF="../../../../com/sleepycat/bdb/collection/StoredCollection.html">StoredCollection</A><DT>implements <A HREF="http://java.sun.com/j2se/1.3/docs/api/java/util/Set.html">Set</A></DL>
<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>
<!-- ======== NESTED CLASS SUMMARY ======== -->
<!-- =========== FIELD SUMMARY =========== -->
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
<A NAME="constructor_summary"><!-- --></A>
<TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TD COLSPAN=2><FONT SIZE="+2">
<B>Constructor Summary</B></FONT></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.DataBinding, boolean)">StoredValueSet</A></B>(<A HREF="../../../../com/sleepycat/bdb/DataIndex.html">DataIndex</A> index,
<A HREF="../../../../com/sleepycat/bdb/bind/DataBinding.html">DataBinding</A> valueBinding,
boolean writeAllowed)</CODE>
<BR>
Creates a value set view of a <A HREF="../../../../com/sleepycat/bdb/DataIndex.html"><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">DataIndex</A> index,
<A HREF="../../../../com/sleepycat/bdb/bind/EntityBinding.html">EntityBinding</A> valueEntityBinding,
boolean writeAllowed)</CODE>
<BR>
Creates a value set entity view of a <A HREF="../../../../com/sleepycat/bdb/DataIndex.html"><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">DataStore</A> store,
<A HREF="../../../../com/sleepycat/bdb/bind/DataBinding.html">DataBinding</A> valueBinding,
boolean writeAllowed)</CODE>
<BR>
Creates a value set view of a <A HREF="../../../../com/sleepycat/bdb/DataStore.html"><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">DataStore</A> store,
<A HREF="../../../../com/sleepycat/bdb/bind/EntityBinding.html">EntityBinding</A> valueEntityBinding,
boolean writeAllowed)</CODE>
<BR>
Creates a value set entity view of a <A HREF="../../../../com/sleepycat/bdb/DataStore.html"><CODE>DataStore</CODE></A>.</TD>
</TR>
</TABLE>
<!-- ========== METHOD SUMMARY =========== -->
<A NAME="method_summary"><!-- --></A>
<TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TD COLSPAN=2><FONT SIZE="+2">
<B>Method Summary</B></FONT></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#add(java.lang.Object)">add</A></B>(<A HREF="http://java.sun.com/j2se/1.3/docs/api/java/lang/Object.html">Object</A> 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>(<A HREF="http://java.sun.com/j2se/1.3/docs/api/java/lang/Object.html">Object</A> 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>(<A HREF="http://java.sun.com/j2se/1.3/docs/api/java/lang/Object.html">Object</A> 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" CELLPADDING="3" CELLSPACING="0" WIDTH="100%">
<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
<TD><B>Methods inherited from class com.sleepycat.bdb.collection.<A HREF="../../../../com/sleepycat/bdb/collection/StoredCollection.html">StoredCollection</A></B></TD>
</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" CELLPADDING="3" CELLSPACING="0" WIDTH="100%">
<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
<TD><B>Methods inherited from class com.sleepycat.bdb.collection.<A HREF="../../../../com/sleepycat/bdb/collection/StoredContainer.html">StoredContainer</A></B></TD>
</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" CELLPADDING="3" CELLSPACING="0" WIDTH="100%">
<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
<TD><B>Methods inherited from class java.lang.<A HREF="http://java.sun.com/j2se/1.3/docs/api/java/lang/Object.html">Object</A></B></TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD><CODE><A HREF="http://java.sun.com/j2se/1.3/docs/api/java/lang/Object.html#getClass()">getClass</A>, <A HREF="http://java.sun.com/j2se/1.3/docs/api/java/lang/Object.html#hashCode()">hashCode</A>, <A HREF="http://java.sun.com/j2se/1.3/docs/api/java/lang/Object.html#notify()">notify</A>, <A HREF="http://java.sun.com/j2se/1.3/docs/api/java/lang/Object.html#notifyAll()">notifyAll</A>, <A HREF="http://java.sun.com/j2se/1.3/docs/api/java/lang/Object.html#wait()">wait</A>, <A HREF="http://java.sun.com/j2se/1.3/docs/api/java/lang/Object.html#wait(long)">wait</A>, <A HREF="http://java.sun.com/j2se/1.3/docs/api/java/lang/Object.html#wait(long, int)">wait</A></CODE></TD>
</TR>
</TABLE>
<A NAME="methods_inherited_from_class_java.util.Set"><!-- --></A>
<TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%">
<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
<TD><B>Methods inherited from interface java.util.<A HREF="http://java.sun.com/j2se/1.3/docs/api/java/util/Set.html">Set</A></B></TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD><CODE><A HREF="http://java.sun.com/j2se/1.3/docs/api/java/util/Set.html#addAll(java.util.Collection)">addAll</A>, <A HREF="http://java.sun.com/j2se/1.3/docs/api/java/util/Set.html#clear()">clear</A>, <A HREF="http://java.sun.com/j2se/1.3/docs/api/java/util/Set.html#containsAll(java.util.Collection)">containsAll</A>, <A HREF="http://java.sun.com/j2se/1.3/docs/api/java/util/Set.html#equals(java.lang.Object)">equals</A>, <A HREF="http://java.sun.com/j2se/1.3/docs/api/java/util/Set.html#hashCode()">hashCode</A>, <A HREF="http://java.sun.com/j2se/1.3/docs/api/java/util/Set.html#isEmpty()">isEmpty</A>, <A HREF="http://java.sun.com/j2se/1.3/docs/api/java/util/Set.html#iterator()">iterator</A>, <A HREF="http://java.sun.com/j2se/1.3/docs/api/java/util/Set.html#removeAll(java.util.Collection)">removeAll</A>, <A HREF="http://java.sun.com/j2se/1.3/docs/api/java/util/Set.html#retainAll(java.util.Collection)">retainAll</A>, <A HREF="http://java.sun.com/j2se/1.3/docs/api/java/util/Set.html#toArray()">toArray</A>, <A HREF="http://java.sun.com/j2se/1.3/docs/api/java/util/Set.html#toArray(java.lang.Object[])">toArray</A></CODE></TD>
</TR>
</TABLE>
<P>
<!-- ============ FIELD DETAIL =========== -->
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<A NAME="constructor_detail"><!-- --></A>
<TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TD COLSPAN=1><FONT SIZE="+2">
<B>Constructor Detail</B></FONT></TD>
</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">DataStore</A> store,
<A HREF="../../../../com/sleepycat/bdb/bind/DataBinding.html">DataBinding</A> valueBinding,
boolean writeAllowed)</PRE>
<DL>
<DD>Creates a value set view of a <A HREF="../../../../com/sleepycat/bdb/DataStore.html"><CODE>DataStore</CODE></A>.
<P>
<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><A HREF="http://java.sun.com/j2se/1.3/docs/api/java/lang/IllegalArgumentException.html">IllegalArgumentException</A></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"><CODE>DbException</CODE></A> is thrown.</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">DataStore</A> store,
<A HREF="../../../../com/sleepycat/bdb/bind/EntityBinding.html">EntityBinding</A> valueEntityBinding,
boolean writeAllowed)</PRE>
<DL>
<DD>Creates a value set entity view of a <A HREF="../../../../com/sleepycat/bdb/DataStore.html"><CODE>DataStore</CODE></A>.
<P>
<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><A HREF="http://java.sun.com/j2se/1.3/docs/api/java/lang/IllegalArgumentException.html">IllegalArgumentException</A></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"><CODE>DbException</CODE></A> is thrown.</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">DataIndex</A> index,
<A HREF="../../../../com/sleepycat/bdb/bind/DataBinding.html">DataBinding</A> valueBinding,
boolean writeAllowed)</PRE>
<DL>
<DD>Creates a value set view of a <A HREF="../../../../com/sleepycat/bdb/DataIndex.html"><CODE>DataIndex</CODE></A>.
<P>
<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><A HREF="http://java.sun.com/j2se/1.3/docs/api/java/lang/IllegalArgumentException.html">IllegalArgumentException</A></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"><CODE>DbException</CODE></A> is thrown.</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">DataIndex</A> index,
<A HREF="../../../../com/sleepycat/bdb/bind/EntityBinding.html">EntityBinding</A> valueEntityBinding,
boolean writeAllowed)</PRE>
<DL>
<DD>Creates a value set entity view of a <A HREF="../../../../com/sleepycat/bdb/DataIndex.html"><CODE>DataIndex</CODE></A>.
<P>
<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><A HREF="http://java.sun.com/j2se/1.3/docs/api/java/lang/IllegalArgumentException.html">IllegalArgumentException</A></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"><CODE>DbException</CODE></A> is thrown.</DL>
<!-- ============ METHOD DETAIL ========== -->
<A NAME="method_detail"><!-- --></A>
<TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TD COLSPAN=1><FONT SIZE="+2">
<B>Method Detail</B></FONT></TD>
</TR>
</TABLE>
<A NAME="add(java.lang.Object)"><!-- --></A><H3>
add</H3>
<PRE>
public boolean <B>add</B>(<A HREF="http://java.sun.com/j2se/1.3/docs/api/java/lang/Object.html">Object</A> 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(java.lang.Object)</CODE> interface.
<P>
<DD><DL>
<DT><B>Specified by:</B><DD><CODE>add</CODE> in interface <CODE><A HREF="http://java.sun.com/j2se/1.3/docs/api/java/util/Set.html">Set</A></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><A HREF="http://java.sun.com/j2se/1.3/docs/api/java/lang/UnsupportedOperationException.html">UnsupportedOperationException</A></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"><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>(<A HREF="http://java.sun.com/j2se/1.3/docs/api/java/lang/Object.html">Object</A> 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><A HREF="http://java.sun.com/j2se/1.3/docs/api/java/util/Set.html">Set</A></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>(<A HREF="http://java.sun.com/j2se/1.3/docs/api/java/lang/Object.html">Object</A> 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><A HREF="http://java.sun.com/j2se/1.3/docs/api/java/util/Set.html">Set</A></CODE></DL>
</DD>
<DD><DL>
<DT><B>Throws:</B>
<DD><CODE><A HREF="http://java.sun.com/j2se/1.3/docs/api/java/lang/UnsupportedOperationException.html">UnsupportedOperationException</A></CODE> - if the collection is read-only.
<DD><CODE>RuntimeExceptionWrapper</CODE> - if a <A HREF="../../../../com/sleepycat/db/DbException.html"><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">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><A HREF="http://java.sun.com/j2se/1.3/docs/api/java/util/Set.html">Set</A></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">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 NAVBAR ========== -->
<A NAME="navbar_bottom"><!-- --></A>
<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0">
<TR>
<TD COLSPAN=3 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
<A NAME="navbar_bottom_firstrow"><!-- --></A>
<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3">
<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="class-use/StoredValueSet.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A> </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>
<b>Berkeley DB</b><br><font size="-1"> version 4.2.52</font></EM>
</TD>
</TR>
<TR>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
<A HREF="../../../../com/sleepycat/bdb/collection/StoredSortedValueSet.html"><B>PREV CLASS</B></A>
NEXT CLASS</FONT></TD>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
<A HREF="../../../../index.html" TARGET="_top"><B>FRAMES</B></A>
<A HREF="StoredValueSet.html" TARGET="_top"><B>NO FRAMES</B></A>
<SCRIPT>
<!--
if(window==top) {
document.writeln('<A HREF="../../../../allclasses-noframe.html" TARGET=""><B>All Classes</B></A>');
}
</SCRIPT>
<NOSCRIPT>
<A HREF="../../../../allclasses-noframe.html" TARGET=""><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>
<!-- =========== END OF NAVBAR =========== -->
<HR>
<font size=1><a href="../../../../../sleepycat/legal.html">Copyright (c) 1996-2003</a> <a href="http://www.sleepycat.com">Sleepycat Software, Inc.</a> - All rights reserved.</font>
</BODY>
</HTML>