<!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_07) on Fri Mar 13 20:01:30 CET 2009 --> <TITLE> IdSet (Rice Pastry - API Specifications) </TITLE> <META NAME="date" CONTENT="2009-03-13"> <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="IdSet (Rice Pastry - API Specifications)"; } } </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="class-use/IdSet.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> Rice Pastry API</EM> </TD> </TR> <TR> <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> <A HREF="../../../rice/p2p/commonapi/IdRange.html" title="interface in rice.p2p.commonapi"><B>PREV CLASS</B></A> <A HREF="../../../rice/p2p/commonapi/Message.html" title="interface in rice.p2p.commonapi"><B>NEXT CLASS</B></A></FONT></TD> <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> <A HREF="../../../index.html?rice/p2p/commonapi/IdSet.html" target="_top"><B>FRAMES</B></A> <A HREF="IdSet.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 | CONSTR | <A HREF="#method_summary">METHOD</A></FONT></TD> <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> DETAIL: FIELD | CONSTR | <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"> rice.p2p.commonapi</FONT> <BR> Interface IdSet</H2> <DL> <DT><B>All Superinterfaces:</B> <DD>java.io.Serializable</DD> </DL> <DL> <DT><B>All Known Implementing Classes:</B> <DD><A HREF="../../../rice/p2p/glacier/FragmentKeySet.html" title="class in rice.p2p.glacier">FragmentKeySet</A>, <A HREF="../../../rice/p2p/past/gc/GCIdSet.html" title="class in rice.p2p.past.gc">GCIdSet</A>, <A HREF="../../../rice/pastry/IdSet.html" title="class in rice.pastry">IdSet</A>, <A HREF="../../../rice/p2p/multiring/MultiringIdSet.html" title="class in rice.p2p.multiring">MultiringIdSet</A>, <A HREF="../../../rice/p2p/glacier/VersionKeySet.html" title="class in rice.p2p.glacier">VersionKeySet</A></DD> </DL> <HR> <DL> <DT><PRE>public interface <B>IdSet</B><DT>extends java.io.Serializable</DL> </PRE> <P> <DL> <DT><B>Version:</B></DT> <DD>$Id: IdSet.java 4654 2009-01-08 16:33:07Z jeffh $</DD> <DT><B>Author:</B></DT> <DD>Alan Mislove, Peter Druschel</DD> </DL> <HR> <P> <!-- ========== 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> void</CODE></FONT></TD> <TD><CODE><B><A HREF="../../../rice/p2p/commonapi/IdSet.html#addId(rice.p2p.commonapi.Id)">addId</A></B>(<A HREF="../../../rice/p2p/commonapi/Id.html" title="interface in rice.p2p.commonapi">Id</A> id)</CODE> <BR> add a member</TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> <CODE> <A HREF="../../../rice/p2p/commonapi/Id.html" title="interface in rice.p2p.commonapi">Id</A>[]</CODE></FONT></TD> <TD><CODE><B><A HREF="../../../rice/p2p/commonapi/IdSet.html#asArray()">asArray</A></B>()</CODE> <BR> return this set as an array</TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> <CODE> <A HREF="../../../rice/p2p/commonapi/IdSet.html" title="interface in rice.p2p.commonapi">IdSet</A></CODE></FONT></TD> <TD><CODE><B><A HREF="../../../rice/p2p/commonapi/IdSet.html#build()">build</A></B>()</CODE> <BR> Returns a new, empty IdSet of this type</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="../../../rice/p2p/commonapi/IdSet.html#clone()">clone</A></B>()</CODE> <BR> Override clone() to make it publicly accessible</TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> <CODE> java.util.Iterator<<A HREF="../../../rice/p2p/commonapi/Id.html" title="interface in rice.p2p.commonapi">Id</A>></CODE></FONT></TD> <TD><CODE><B><A HREF="../../../rice/p2p/commonapi/IdSet.html#getIterator()">getIterator</A></B>()</CODE> <BR> return an iterator over the elements of this set</TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> <CODE> byte[]</CODE></FONT></TD> <TD><CODE><B><A HREF="../../../rice/p2p/commonapi/IdSet.html#hash()">hash</A></B>()</CODE> <BR> return a hash of this set</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="../../../rice/p2p/commonapi/IdSet.html#isMemberId(rice.p2p.commonapi.Id)">isMemberId</A></B>(<A HREF="../../../rice/p2p/commonapi/Id.html" title="interface in rice.p2p.commonapi">Id</A> id)</CODE> <BR> test membership</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="../../../rice/p2p/commonapi/IdSet.html#numElements()">numElements</A></B>()</CODE> <BR> return the number of elements</TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> <CODE> void</CODE></FONT></TD> <TD><CODE><B><A HREF="../../../rice/p2p/commonapi/IdSet.html#removeId(rice.p2p.commonapi.Id)">removeId</A></B>(<A HREF="../../../rice/p2p/commonapi/Id.html" title="interface in rice.p2p.commonapi">Id</A> id)</CODE> <BR> remove a member</TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> <CODE> <A HREF="../../../rice/p2p/commonapi/IdSet.html" title="interface in rice.p2p.commonapi">IdSet</A></CODE></FONT></TD> <TD><CODE><B><A HREF="../../../rice/p2p/commonapi/IdSet.html#subSet(rice.p2p.commonapi.IdRange)">subSet</A></B>(<A HREF="../../../rice/p2p/commonapi/IdRange.html" title="interface in rice.p2p.commonapi">IdRange</A> range)</CODE> <BR> return a subset of this set, consisting of the member ids in a given range</TD> </TR> </TABLE> <P> <!-- ============ 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="numElements()"><!-- --></A><H3> numElements</H3> <PRE> int <B>numElements</B>()</PRE> <DL> <DD>return the number of elements <P> <DD><DL> </DL> </DD> <DD><DL> </DL> </DD> </DL> <HR> <A NAME="addId(rice.p2p.commonapi.Id)"><!-- --></A><H3> addId</H3> <PRE> void <B>addId</B>(<A HREF="../../../rice/p2p/commonapi/Id.html" title="interface in rice.p2p.commonapi">Id</A> id)</PRE> <DL> <DD>add a member <P> <DD><DL> </DL> </DD> <DD><DL> <DT><B>Parameters:</B><DD><CODE>id</CODE> - the id to add</DL> </DD> </DL> <HR> <A NAME="removeId(rice.p2p.commonapi.Id)"><!-- --></A><H3> removeId</H3> <PRE> void <B>removeId</B>(<A HREF="../../../rice/p2p/commonapi/Id.html" title="interface in rice.p2p.commonapi">Id</A> id)</PRE> <DL> <DD>remove a member <P> <DD><DL> </DL> </DD> <DD><DL> <DT><B>Parameters:</B><DD><CODE>id</CODE> - the id to remove</DL> </DD> </DL> <HR> <A NAME="isMemberId(rice.p2p.commonapi.Id)"><!-- --></A><H3> isMemberId</H3> <PRE> boolean <B>isMemberId</B>(<A HREF="../../../rice/p2p/commonapi/Id.html" title="interface in rice.p2p.commonapi">Id</A> id)</PRE> <DL> <DD>test membership <P> <DD><DL> </DL> </DD> <DD><DL> <DT><B>Parameters:</B><DD><CODE>id</CODE> - the id to test <DT><B>Returns:</B><DD>true of id is a member, false otherwise</DL> </DD> </DL> <HR> <A NAME="subSet(rice.p2p.commonapi.IdRange)"><!-- --></A><H3> subSet</H3> <PRE> <A HREF="../../../rice/p2p/commonapi/IdSet.html" title="interface in rice.p2p.commonapi">IdSet</A> <B>subSet</B>(<A HREF="../../../rice/p2p/commonapi/IdRange.html" title="interface in rice.p2p.commonapi">IdRange</A> range)</PRE> <DL> <DD>return a subset of this set, consisting of the member ids in a given range <P> <DD><DL> </DL> </DD> <DD><DL> <DT><B>Parameters:</B><DD><CODE>from</CODE> - the lower end of the range (inclusive)<DD><CODE>to</CODE> - the upper end of the range (exclusive) <DT><B>Returns:</B><DD>the subset</DL> </DD> </DL> <HR> <A NAME="getIterator()"><!-- --></A><H3> getIterator</H3> <PRE> java.util.Iterator<<A HREF="../../../rice/p2p/commonapi/Id.html" title="interface in rice.p2p.commonapi">Id</A>> <B>getIterator</B>()</PRE> <DL> <DD>return an iterator over the elements of this set <P> <DD><DL> </DL> </DD> <DD><DL> <DT><B>Returns:</B><DD>the interator</DL> </DD> </DL> <HR> <A NAME="asArray()"><!-- --></A><H3> asArray</H3> <PRE> <A HREF="../../../rice/p2p/commonapi/Id.html" title="interface in rice.p2p.commonapi">Id</A>[] <B>asArray</B>()</PRE> <DL> <DD>return this set as an array <P> <DD><DL> </DL> </DD> <DD><DL> <DT><B>Returns:</B><DD>the array</DL> </DD> </DL> <HR> <A NAME="hash()"><!-- --></A><H3> hash</H3> <PRE> byte[] <B>hash</B>()</PRE> <DL> <DD>return a hash of this set <P> <DD><DL> </DL> </DD> <DD><DL> <DT><B>Returns:</B><DD>the hash of this set</DL> </DD> </DL> <HR> <A NAME="clone()"><!-- --></A><H3> clone</H3> <PRE> java.lang.Object <B>clone</B>()</PRE> <DL> <DD>Override clone() to make it publicly accessible <P> <DD><DL> </DL> </DD> <DD><DL> <DT><B>Returns:</B><DD>A clone of this set</DL> </DD> </DL> <HR> <A NAME="build()"><!-- --></A><H3> build</H3> <PRE> <A HREF="../../../rice/p2p/commonapi/IdSet.html" title="interface in rice.p2p.commonapi">IdSet</A> <B>build</B>()</PRE> <DL> <DD>Returns a new, empty IdSet of this type <P> <DD><DL> </DL> </DD> <DD><DL> <DT><B>Returns:</B><DD>A new IdSet</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="class-use/IdSet.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> Rice Pastry API</EM> </TD> </TR> <TR> <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> <A HREF="../../../rice/p2p/commonapi/IdRange.html" title="interface in rice.p2p.commonapi"><B>PREV CLASS</B></A> <A HREF="../../../rice/p2p/commonapi/Message.html" title="interface in rice.p2p.commonapi"><B>NEXT CLASS</B></A></FONT></TD> <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> <A HREF="../../../index.html?rice/p2p/commonapi/IdSet.html" target="_top"><B>FRAMES</B></A> <A HREF="IdSet.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 | CONSTR | <A HREF="#method_summary">METHOD</A></FONT></TD> <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> DETAIL: FIELD | CONSTR | <A HREF="#method_detail">METHOD</A></FONT></TD> </TR> </TABLE> <A NAME="skip-navbar_bottom"></A> <!-- ======== END OF BOTTOM NAVBAR ======= --> <HR> <i>Copyright © 2001-2005 - Rice Pastry.</i> </BODY> </HTML>