<!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_17) on Sun Mar 14 17:34:25 UTC 2010 --> <TITLE> StoredSortedKeySet </TITLE> <META NAME="date" CONTENT="2010-03-14"> <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="StoredSortedKeySet"; } } </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/collections/StoredSortedEntrySet.html" title="class in com.sleepycat.collections"><B>PREV CLASS</B></A> <A HREF="../../../com/sleepycat/collections/StoredSortedMap.html" title="class in com.sleepycat.collections"><B>NEXT CLASS</B></A></FONT></TD> <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> <A HREF="../../../index.html?com/sleepycat/collections/StoredSortedKeySet.html" target="_top"><B>FRAMES</B></A> <A HREF="StoredSortedKeySet.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 | <A HREF="#fields_inherited_from_class_com.sleepycat.collections.StoredCollection">FIELD</A> | <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.collections</FONT> <BR> Class StoredSortedKeySet</H2> <PRE> java.lang.Object <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> <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> <IMG SRC="../../../resources/inherit.gif" ALT="extended by "><A HREF="../../../com/sleepycat/collections/StoredKeySet.html" title="class in com.sleepycat.collections">com.sleepycat.collections.StoredKeySet</A> <IMG SRC="../../../resources/inherit.gif" ALT="extended by "><B>com.sleepycat.collections.StoredSortedKeySet</B> </PRE> <DL> <DT><B>All Implemented Interfaces:</B> <DD>java.lang.Cloneable, java.lang.Iterable, java.util.Collection, java.util.Set, java.util.SortedSet</DD> </DL> <HR> <DL> <DT><PRE>public class <B>StoredSortedKeySet</B><DT>extends <A HREF="../../../com/sleepycat/collections/StoredKeySet.html" title="class in com.sleepycat.collections">StoredKeySet</A><DT>implements java.util.SortedSet</DL> </PRE> <P> The SortedSet returned by Map.keySet() and which can also be constructed directly if a Map is not needed. Since this collection is a set it only contains one element for each key, even when duplicates are allowed. Key set iterators are therefore particularly useful for enumerating the unique keys of a store or index that allows duplicates. <p>In addition to the standard SortedSet methods, this class provides the following methods for stored sorted sets only. Note that the use of these methods is not compatible with the standard Java collections interface.</p> <ul> <li><A HREF="../../../com/sleepycat/collections/StoredSortedKeySet.html#headSet(java.lang.Object, boolean)"><CODE>headSet(Object, boolean)</CODE></A></li> <li><A HREF="../../../com/sleepycat/collections/StoredSortedKeySet.html#tailSet(java.lang.Object, boolean)"><CODE>tailSet(Object, boolean)</CODE></A></li> <li><A HREF="../../../com/sleepycat/collections/StoredSortedKeySet.html#subSet(java.lang.Object, boolean, java.lang.Object, boolean)"><CODE>subSet(Object, boolean, Object, boolean)</CODE></A></li> </ul> <P> <P> <HR> <P> <!-- =========== FIELD SUMMARY =========== --> <A NAME="field_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>Field Summary</B></FONT></TH> </TR> </TABLE> <A NAME="fields_inherited_from_class_com.sleepycat.collections.StoredCollection"><!-- --></A> <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> <TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor"> <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> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD><CODE><A HREF="../../../com/sleepycat/collections/StoredCollection.html#DEFAULT_ITERATOR_BLOCK_SIZE">DEFAULT_ITERATOR_BLOCK_SIZE</A></CODE></TD> </TR> </TABLE> <!-- ======== 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/collections/StoredSortedKeySet.html#StoredSortedKeySet(com.sleepycat.db.Database, com.sleepycat.bind.EntryBinding, boolean)">StoredSortedKeySet</A></B>(<A HREF="../../../com/sleepycat/db/Database.html" title="class in com.sleepycat.db">Database</A> database, <A HREF="../../../com/sleepycat/bind/EntryBinding.html" title="interface in com.sleepycat.bind">EntryBinding</A> keyBinding, boolean writeAllowed)</CODE> <BR> Creates a sorted key set view of a <A HREF="../../../com/sleepycat/db/Database.html" title="class in com.sleepycat.db"><CODE>Database</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> java.util.Comparator</CODE></FONT></TD> <TD><CODE><B><A HREF="../../../com/sleepycat/collections/StoredSortedKeySet.html#comparator()">comparator</A></B>()</CODE> <BR> Returns null since comparators are not supported.</TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> <CODE> java.lang.Object</CODE></FONT></TD> <TD><CODE><B><A HREF="../../../com/sleepycat/collections/StoredSortedKeySet.html#first()">first</A></B>()</CODE> <BR> Returns the first (lowest) element currently in this sorted set.</TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> <CODE> java.util.SortedSet</CODE></FONT></TD> <TD><CODE><B><A HREF="../../../com/sleepycat/collections/StoredSortedKeySet.html#headSet(java.lang.Object)">headSet</A></B>(java.lang.Object toKey)</CODE> <BR> Returns a view of the portion of this sorted set whose elements are strictly less than toKey.</TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> <CODE> java.util.SortedSet</CODE></FONT></TD> <TD><CODE><B><A HREF="../../../com/sleepycat/collections/StoredSortedKeySet.html#headSet(java.lang.Object, boolean)">headSet</A></B>(java.lang.Object toKey, boolean toInclusive)</CODE> <BR> Returns a view of the portion of this sorted set whose elements are strictly less than toKey, optionally including toKey.</TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> <CODE> java.lang.Object</CODE></FONT></TD> <TD><CODE><B><A HREF="../../../com/sleepycat/collections/StoredSortedKeySet.html#last()">last</A></B>()</CODE> <BR> Returns the last (highest) element currently in this sorted set.</TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> <CODE> java.util.SortedSet</CODE></FONT></TD> <TD><CODE><B><A HREF="../../../com/sleepycat/collections/StoredSortedKeySet.html#subSet(java.lang.Object, boolean, java.lang.Object, boolean)">subSet</A></B>(java.lang.Object fromKey, boolean fromInclusive, java.lang.Object toKey, boolean toInclusive)</CODE> <BR> Returns a view of the portion of this sorted set whose elements are strictly greater than fromKey and strictly less than toKey, optionally including fromKey and toKey.</TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> <CODE> java.util.SortedSet</CODE></FONT></TD> <TD><CODE><B><A HREF="../../../com/sleepycat/collections/StoredSortedKeySet.html#subSet(java.lang.Object, java.lang.Object)">subSet</A></B>(java.lang.Object fromKey, java.lang.Object toKey)</CODE> <BR> Returns a view of the portion of this sorted set whose elements range from fromKey, inclusive, to toKey, exclusive.</TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> <CODE> java.util.SortedSet</CODE></FONT></TD> <TD><CODE><B><A HREF="../../../com/sleepycat/collections/StoredSortedKeySet.html#tailSet(java.lang.Object)">tailSet</A></B>(java.lang.Object fromKey)</CODE> <BR> Returns a view of the portion of this sorted set whose elements are greater than or equal to fromKey.</TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> <CODE> java.util.SortedSet</CODE></FONT></TD> <TD><CODE><B><A HREF="../../../com/sleepycat/collections/StoredSortedKeySet.html#tailSet(java.lang.Object, boolean)">tailSet</A></B>(java.lang.Object fromKey, boolean fromInclusive)</CODE> <BR> Returns a view of the portion of this sorted set whose elements are strictly greater than fromKey, optionally including fromKey.</TD> </TR> </TABLE> <A NAME="methods_inherited_from_class_com.sleepycat.collections.StoredKeySet"><!-- --></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.collections.<A HREF="../../../com/sleepycat/collections/StoredKeySet.html" title="class in com.sleepycat.collections">StoredKeySet</A></B></TH> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD><CODE><A HREF="../../../com/sleepycat/collections/StoredKeySet.html#add(java.lang.Object)">add</A>, <A HREF="../../../com/sleepycat/collections/StoredKeySet.html#contains(java.lang.Object)">contains</A>, <A HREF="../../../com/sleepycat/collections/StoredKeySet.html#remove(java.lang.Object)">remove</A></CODE></TD> </TR> </TABLE> <A NAME="methods_inherited_from_class_com.sleepycat.collections.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.collections.<A HREF="../../../com/sleepycat/collections/StoredCollection.html" title="class in com.sleepycat.collections">StoredCollection</A></B></TH> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <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> </TR> </TABLE> <A NAME="methods_inherited_from_class_com.sleepycat.collections.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.collections.<A HREF="../../../com/sleepycat/collections/StoredContainer.html" title="class in com.sleepycat.collections">StoredContainer</A></B></TH> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <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#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> </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, 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>add, addAll, clear, contains, containsAll, equals, hashCode, isEmpty, iterator, remove, removeAll, retainAll, size, 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="StoredSortedKeySet(com.sleepycat.db.Database, com.sleepycat.bind.EntryBinding, boolean)"><!-- --></A><H3> StoredSortedKeySet</H3> <PRE> public <B>StoredSortedKeySet</B>(<A HREF="../../../com/sleepycat/db/Database.html" title="class in com.sleepycat.db">Database</A> database, <A HREF="../../../com/sleepycat/bind/EntryBinding.html" title="interface in com.sleepycat.bind">EntryBinding</A> keyBinding, boolean writeAllowed)</PRE> <DL> <DD>Creates a sorted key set view of a <A HREF="../../../com/sleepycat/db/Database.html" title="class in com.sleepycat.db"><CODE>Database</CODE></A>. <P> <DL> <DT><B>Parameters:</B><DD><CODE>database</CODE> - is the Database underlying the new collection.<DD><CODE>keyBinding</CODE> - is the binding used to translate between key buffers and key 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/DatabaseException.html" title="class in com.sleepycat.db"><CODE>DatabaseException</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="comparator()"><!-- --></A><H3> comparator</H3> <PRE> public java.util.Comparator <B>comparator</B>()</PRE> <DL> <DD>Returns null since comparators are not supported. The natural ordering of a stored collection is data byte order, whether the data classes implement the <CODE>Comparable</CODE> interface or not. This method does not conform to the <CODE>SortedSet.comparator()</CODE> interface. <P> <DD><DL> <DT><B>Specified by:</B><DD><CODE>comparator</CODE> in interface <CODE>java.util.SortedSet</CODE></DL> </DD> <DD><DL> <DT><B>Returns:</B><DD>null.</DL> </DD> </DL> <HR> <A NAME="first()"><!-- --></A><H3> first</H3> <PRE> public java.lang.Object <B>first</B>()</PRE> <DL> <DD>Returns the first (lowest) element currently in this sorted set. This method conforms to the <CODE>SortedSet.first()</CODE> interface. <P> <DD><DL> <DT><B>Specified by:</B><DD><CODE>first</CODE> in interface <CODE>java.util.SortedSet</CODE></DL> </DD> <DD><DL> <DT><B>Returns:</B><DD>the first element. <DT><B>Throws:</B> <DD><CODE>RuntimeExceptionWrapper</CODE> - if a <A HREF="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db"><CODE>DatabaseException</CODE></A> is thrown.</DL> </DD> </DL> <HR> <A NAME="last()"><!-- --></A><H3> last</H3> <PRE> public java.lang.Object <B>last</B>()</PRE> <DL> <DD>Returns the last (highest) element currently in this sorted set. This method conforms to the <CODE>SortedSet.last()</CODE> interface. <P> <DD><DL> <DT><B>Specified by:</B><DD><CODE>last</CODE> in interface <CODE>java.util.SortedSet</CODE></DL> </DD> <DD><DL> <DT><B>Returns:</B><DD>the last element. <DT><B>Throws:</B> <DD><CODE>RuntimeExceptionWrapper</CODE> - if a <A HREF="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db"><CODE>DatabaseException</CODE></A> is thrown.</DL> </DD> </DL> <HR> <A NAME="headSet(java.lang.Object)"><!-- --></A><H3> headSet</H3> <PRE> public java.util.SortedSet <B>headSet</B>(java.lang.Object toKey)</PRE> <DL> <DD>Returns a view of the portion of this sorted set whose elements are strictly less than toKey. This method conforms to the <CODE>SortedSet.headSet(E)</CODE> interface. <p>Note that the return value is a StoredCollection and must be treated as such; for example, its iterators must be explicitly closed.</p> <P> <DD><DL> <DT><B>Specified by:</B><DD><CODE>headSet</CODE> in interface <CODE>java.util.SortedSet</CODE></DL> </DD> <DD><DL> <DT><B>Parameters:</B><DD><CODE>toKey</CODE> - is the upper bound. <DT><B>Returns:</B><DD>the subset. <DT><B>Throws:</B> <DD><CODE>RuntimeExceptionWrapper</CODE> - if a <A HREF="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db"><CODE>DatabaseException</CODE></A> is thrown.</DL> </DD> </DL> <HR> <A NAME="headSet(java.lang.Object, boolean)"><!-- --></A><H3> headSet</H3> <PRE> public java.util.SortedSet <B>headSet</B>(java.lang.Object toKey, boolean toInclusive)</PRE> <DL> <DD>Returns a view of the portion of this sorted set whose elements are strictly less than toKey, optionally including toKey. This method does not exist in the standard <CODE>SortedSet</CODE> interface. <p>Note that the return value is a StoredCollection and must be treated as such; for example, its iterators must be explicitly closed.</p> <P> <DD><DL> </DL> </DD> <DD><DL> <DT><B>Parameters:</B><DD><CODE>toKey</CODE> - is the upper bound.<DD><CODE>toInclusive</CODE> - is true to include toKey. <DT><B>Returns:</B><DD>the subset. <DT><B>Throws:</B> <DD><CODE>RuntimeExceptionWrapper</CODE> - if a <A HREF="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db"><CODE>DatabaseException</CODE></A> is thrown.</DL> </DD> </DL> <HR> <A NAME="tailSet(java.lang.Object)"><!-- --></A><H3> tailSet</H3> <PRE> public java.util.SortedSet <B>tailSet</B>(java.lang.Object fromKey)</PRE> <DL> <DD>Returns a view of the portion of this sorted set whose elements are greater than or equal to fromKey. This method conforms to the <CODE>SortedSet.tailSet(E)</CODE> interface. <p>Note that the return value is a StoredCollection and must be treated as such; for example, its iterators must be explicitly closed.</p> <P> <DD><DL> <DT><B>Specified by:</B><DD><CODE>tailSet</CODE> in interface <CODE>java.util.SortedSet</CODE></DL> </DD> <DD><DL> <DT><B>Parameters:</B><DD><CODE>fromKey</CODE> - is the lower bound. <DT><B>Returns:</B><DD>the subset. <DT><B>Throws:</B> <DD><CODE>RuntimeExceptionWrapper</CODE> - if a <A HREF="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db"><CODE>DatabaseException</CODE></A> is thrown.</DL> </DD> </DL> <HR> <A NAME="tailSet(java.lang.Object, boolean)"><!-- --></A><H3> tailSet</H3> <PRE> public java.util.SortedSet <B>tailSet</B>(java.lang.Object fromKey, boolean fromInclusive)</PRE> <DL> <DD>Returns a view of the portion of this sorted set whose elements are strictly greater than fromKey, optionally including fromKey. This method does not exist in the standard <CODE>SortedSet</CODE> interface. <p>Note that the return value is a StoredCollection and must be treated as such; for example, its iterators must be explicitly closed.</p> <P> <DD><DL> </DL> </DD> <DD><DL> <DT><B>Parameters:</B><DD><CODE>fromKey</CODE> - is the lower bound.<DD><CODE>fromInclusive</CODE> - is true to include fromKey. <DT><B>Returns:</B><DD>the subset. <DT><B>Throws:</B> <DD><CODE>RuntimeExceptionWrapper</CODE> - if a <A HREF="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db"><CODE>DatabaseException</CODE></A> is thrown.</DL> </DD> </DL> <HR> <A NAME="subSet(java.lang.Object, java.lang.Object)"><!-- --></A><H3> subSet</H3> <PRE> public java.util.SortedSet <B>subSet</B>(java.lang.Object fromKey, java.lang.Object toKey)</PRE> <DL> <DD>Returns a view of the portion of this sorted set whose elements range from fromKey, inclusive, to toKey, exclusive. This method conforms to the <CODE>SortedSet.subSet(E, E)</CODE> interface. <p>Note that the return value is a StoredCollection and must be treated as such; for example, its iterators must be explicitly closed.</p> <P> <DD><DL> <DT><B>Specified by:</B><DD><CODE>subSet</CODE> in interface <CODE>java.util.SortedSet</CODE></DL> </DD> <DD><DL> <DT><B>Parameters:</B><DD><CODE>fromKey</CODE> - is the lower bound.<DD><CODE>toKey</CODE> - is the upper bound. <DT><B>Returns:</B><DD>the subset. <DT><B>Throws:</B> <DD><CODE>RuntimeExceptionWrapper</CODE> - if a <A HREF="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db"><CODE>DatabaseException</CODE></A> is thrown.</DL> </DD> </DL> <HR> <A NAME="subSet(java.lang.Object, boolean, java.lang.Object, boolean)"><!-- --></A><H3> subSet</H3> <PRE> public java.util.SortedSet <B>subSet</B>(java.lang.Object fromKey, boolean fromInclusive, java.lang.Object toKey, boolean toInclusive)</PRE> <DL> <DD>Returns a view of the portion of this sorted set whose elements are strictly greater than fromKey and strictly less than toKey, optionally including fromKey and toKey. This method does not exist in the standard <CODE>SortedSet</CODE> interface. <p>Note that the return value is a StoredCollection and must be treated as such; for example, its iterators must be explicitly closed.</p> <P> <DD><DL> </DL> </DD> <DD><DL> <DT><B>Parameters:</B><DD><CODE>fromKey</CODE> - is the lower bound.<DD><CODE>fromInclusive</CODE> - is true to include fromKey.<DD><CODE>toKey</CODE> - is the upper bound.<DD><CODE>toInclusive</CODE> - is true to include toKey. <DT><B>Returns:</B><DD>the subset. <DT><B>Throws:</B> <DD><CODE>RuntimeExceptionWrapper</CODE> - if a <A HREF="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db"><CODE>DatabaseException</CODE></A> is thrown.</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/collections/StoredSortedEntrySet.html" title="class in com.sleepycat.collections"><B>PREV CLASS</B></A> <A HREF="../../../com/sleepycat/collections/StoredSortedMap.html" title="class in com.sleepycat.collections"><B>NEXT CLASS</B></A></FONT></TD> <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> <A HREF="../../../index.html?com/sleepycat/collections/StoredSortedKeySet.html" target="_top"><B>FRAMES</B></A> <A HREF="StoredSortedKeySet.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 | <A HREF="#fields_inherited_from_class_com.sleepycat.collections.StoredCollection">FIELD</A> | <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>