mirror of
https://github.com/ChronosX88/FreePastry.git
synced 2025-01-16 09:36:27 +00:00
700 lines
31 KiB
HTML
700 lines
31 KiB
HTML
<!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:02 CET 2009 -->
|
|
<TITLE>
|
|
GCIdFactory (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="GCIdFactory (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/GCIdFactory.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/past/gc/GCId.html" title="class in rice.p2p.past.gc"><B>PREV CLASS</B></A>
|
|
<A HREF="../../../../rice/p2p/past/gc/GCIdFactory.GCEntrySet.html" title="class in rice.p2p.past.gc"><B>NEXT CLASS</B></A></FONT></TD>
|
|
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
|
|
<A HREF="../../../../index.html?rice/p2p/past/gc/GCIdFactory.html" target="_top"><B>FRAMES</B></A>
|
|
<A HREF="GCIdFactory.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: <A HREF="#nested_class_summary">NESTED</A> | <A HREF="#field_summary">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: <A HREF="#field_detail">FIELD</A> | <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">
|
|
rice.p2p.past.gc</FONT>
|
|
<BR>
|
|
Class GCIdFactory</H2>
|
|
<PRE>
|
|
java.lang.Object
|
|
<IMG SRC="../../../../resources/inherit.gif" ALT="extended by "><B>rice.p2p.past.gc.GCIdFactory</B>
|
|
</PRE>
|
|
<DL>
|
|
<DT><B>All Implemented Interfaces:</B> <DD><A HREF="../../../../rice/p2p/commonapi/IdFactory.html" title="interface in rice.p2p.commonapi">IdFactory</A></DD>
|
|
</DL>
|
|
<HR>
|
|
<DL>
|
|
<DT><PRE>public class <B>GCIdFactory</B><DT>extends java.lang.Object<DT>implements <A HREF="../../../../rice/p2p/commonapi/IdFactory.html" title="interface in rice.p2p.commonapi">IdFactory</A></DL>
|
|
</PRE>
|
|
|
|
<P>
|
|
<DL>
|
|
<DT><B>Version:</B></DT>
|
|
<DD>$Id: GCIdFactory.java 4654 2009-01-08 16:33:07Z jeffh $</DD>
|
|
<DT><B>Author:</B></DT>
|
|
<DD>Alan Mislove, Peter Druschel</DD>
|
|
</DL>
|
|
<HR>
|
|
|
|
<P>
|
|
<!-- ======== NESTED CLASS SUMMARY ======== -->
|
|
|
|
<A NAME="nested_class_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>Nested Class Summary</B></FONT></TH>
|
|
</TR>
|
|
<TR BGCOLOR="white" CLASS="TableRowColor">
|
|
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
|
<CODE>protected class</CODE></FONT></TD>
|
|
<TD><CODE><B><A HREF="../../../../rice/p2p/past/gc/GCIdFactory.GCEntrySet.html" title="class in rice.p2p.past.gc">GCIdFactory.GCEntrySet</A></B></CODE>
|
|
|
|
<BR>
|
|
</TD>
|
|
</TR>
|
|
<TR BGCOLOR="white" CLASS="TableRowColor">
|
|
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
|
<CODE>protected class</CODE></FONT></TD>
|
|
<TD><CODE><B><A HREF="../../../../rice/p2p/past/gc/GCIdFactory.GCMapEntry.html" title="class in rice.p2p.past.gc">GCIdFactory.GCMapEntry</A></B></CODE>
|
|
|
|
<BR>
|
|
</TD>
|
|
</TR>
|
|
<TR BGCOLOR="white" CLASS="TableRowColor">
|
|
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
|
<CODE>protected class</CODE></FONT></TD>
|
|
<TD><CODE><B><A HREF="../../../../rice/p2p/past/gc/GCIdFactory.GCSortedMap.html" title="class in rice.p2p.past.gc">GCIdFactory.GCSortedMap</A></B></CODE>
|
|
|
|
<BR>
|
|
</TD>
|
|
</TR>
|
|
</TABLE>
|
|
<!-- =========== 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>
|
|
<TR BGCOLOR="white" CLASS="TableRowColor">
|
|
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
|
<CODE>protected <A HREF="../../../../rice/p2p/commonapi/IdFactory.html" title="interface in rice.p2p.commonapi">IdFactory</A></CODE></FONT></TD>
|
|
<TD><CODE><B><A HREF="../../../../rice/p2p/past/gc/GCIdFactory.html#factory">factory</A></B></CODE>
|
|
|
|
<BR>
|
|
The underlying IdFactory</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="../../../../rice/p2p/past/gc/GCIdFactory.html#GCIdFactory(rice.p2p.commonapi.IdFactory)">GCIdFactory</A></B>(<A HREF="../../../../rice/p2p/commonapi/IdFactory.html" title="interface in rice.p2p.commonapi">IdFactory</A> factory)</CODE>
|
|
|
|
<BR>
|
|
Constructor</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> <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/past/gc/GCIdFactory.html#buildId(byte[])">buildId</A></B>(byte[] material)</CODE>
|
|
|
|
<BR>
|
|
Builds a protocol-specific Id given the source data.</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/past/gc/GCIdFactory.html#buildId(int[])">buildId</A></B>(int[] material)</CODE>
|
|
|
|
<BR>
|
|
Builds a protocol-specific Id given the source data.</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/past/gc/GCIdFactory.html#buildId(java.lang.String)">buildId</A></B>(java.lang.String string)</CODE>
|
|
|
|
<BR>
|
|
Builds a protocol-specific Id by using the hash of the given string as source data.</TD>
|
|
</TR>
|
|
<TR BGCOLOR="white" CLASS="TableRowColor">
|
|
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
|
<CODE> <A HREF="../../../../rice/p2p/commonapi/Id.Distance.html" title="interface in rice.p2p.commonapi">Id.Distance</A></CODE></FONT></TD>
|
|
<TD><CODE><B><A HREF="../../../../rice/p2p/past/gc/GCIdFactory.html#buildIdDistance(byte[])">buildIdDistance</A></B>(byte[] material)</CODE>
|
|
|
|
<BR>
|
|
Builds a protocol-specific Id.Distance given the source data.</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/past/gc/GCIdFactory.html#buildIdFromToString(char[], int, int)">buildIdFromToString</A></B>(char[] chars,
|
|
int offset,
|
|
int length)</CODE>
|
|
|
|
<BR>
|
|
Builds an Id by converting the given toString() output back to an Id.</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/past/gc/GCIdFactory.html#buildIdFromToString(java.lang.String)">buildIdFromToString</A></B>(java.lang.String string)</CODE>
|
|
|
|
<BR>
|
|
Builds an Id by converting the given toString() output back to an Id.</TD>
|
|
</TR>
|
|
<TR BGCOLOR="white" CLASS="TableRowColor">
|
|
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
|
<CODE> <A HREF="../../../../rice/p2p/commonapi/IdRange.html" title="interface in rice.p2p.commonapi">IdRange</A></CODE></FONT></TD>
|
|
<TD><CODE><B><A HREF="../../../../rice/p2p/past/gc/GCIdFactory.html#buildIdRange(rice.p2p.commonapi.Id, rice.p2p.commonapi.Id)">buildIdRange</A></B>(<A HREF="../../../../rice/p2p/commonapi/Id.html" title="interface in rice.p2p.commonapi">Id</A> cw,
|
|
<A HREF="../../../../rice/p2p/commonapi/Id.html" title="interface in rice.p2p.commonapi">Id</A> ccw)</CODE>
|
|
|
|
<BR>
|
|
Creates an IdRange given the CW and CCW ids.</TD>
|
|
</TR>
|
|
<TR BGCOLOR="white" CLASS="TableRowColor">
|
|
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
|
<CODE> <A HREF="../../../../rice/p2p/commonapi/IdRange.html" title="interface in rice.p2p.commonapi">IdRange</A></CODE></FONT></TD>
|
|
<TD><CODE><B><A HREF="../../../../rice/p2p/past/gc/GCIdFactory.html#buildIdRangeFromPrefix(java.lang.String)">buildIdRangeFromPrefix</A></B>(java.lang.String string)</CODE>
|
|
|
|
<BR>
|
|
Builds an IdRange based on a prefix.</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/past/gc/GCIdFactory.html#buildIdSet()">buildIdSet</A></B>()</CODE>
|
|
|
|
<BR>
|
|
Creates an empty IdSet.</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/past/gc/GCIdFactory.html#buildIdSet(java.util.SortedMap)">buildIdSet</A></B>(java.util.SortedMap map)</CODE>
|
|
|
|
<BR>
|
|
Creates an empty IdSet.</TD>
|
|
</TR>
|
|
<TR BGCOLOR="white" CLASS="TableRowColor">
|
|
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
|
<CODE> <A HREF="../../../../rice/p2p/commonapi/NodeHandleSet.html" title="interface in rice.p2p.commonapi">NodeHandleSet</A></CODE></FONT></TD>
|
|
<TD><CODE><B><A HREF="../../../../rice/p2p/past/gc/GCIdFactory.html#buildNodeHandleSet()">buildNodeHandleSet</A></B>()</CODE>
|
|
|
|
<BR>
|
|
Creates an empty NodeHandleSet.</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/past/gc/GCIdFactory.html#buildNormalId(byte[])">buildNormalId</A></B>(byte[] material)</CODE>
|
|
|
|
<BR>
|
|
Builds a protocol-specific Id given the source data.</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/past/gc/GCIdFactory.html#buildRandomId(java.util.Random)">buildRandomId</A></B>(java.util.Random rng)</CODE>
|
|
|
|
<BR>
|
|
Builds a random protocol-specific Id.</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/past/gc/GCIdFactory.html#buildRandomId(rice.environment.random.RandomSource)">buildRandomId</A></B>(<A HREF="../../../../rice/environment/random/RandomSource.html" title="interface in rice.environment.random">RandomSource</A> rng)</CODE>
|
|
|
|
<BR>
|
|
</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/past/gc/GCIdFactory.html#getIdToStringLength()">getIdToStringLength</A></B>()</CODE>
|
|
|
|
<BR>
|
|
Returns the length a Id.toString should be.</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, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</CODE></TD>
|
|
</TR>
|
|
</TABLE>
|
|
|
|
<P>
|
|
|
|
<!-- ============ FIELD DETAIL =========== -->
|
|
|
|
<A NAME="field_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>Field Detail</B></FONT></TH>
|
|
</TR>
|
|
</TABLE>
|
|
|
|
<A NAME="factory"><!-- --></A><H3>
|
|
factory</H3>
|
|
<PRE>
|
|
protected <A HREF="../../../../rice/p2p/commonapi/IdFactory.html" title="interface in rice.p2p.commonapi">IdFactory</A> <B>factory</B></PRE>
|
|
<DL>
|
|
<DD>The underlying IdFactory
|
|
<P>
|
|
<DL>
|
|
</DL>
|
|
</DL>
|
|
|
|
<!-- ========= 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="GCIdFactory(rice.p2p.commonapi.IdFactory)"><!-- --></A><H3>
|
|
GCIdFactory</H3>
|
|
<PRE>
|
|
public <B>GCIdFactory</B>(<A HREF="../../../../rice/p2p/commonapi/IdFactory.html" title="interface in rice.p2p.commonapi">IdFactory</A> factory)</PRE>
|
|
<DL>
|
|
<DD>Constructor
|
|
<P>
|
|
<DL>
|
|
<DT><B>Parameters:</B><DD><CODE>factory</CODE> - the underlying factory to use</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="buildNormalId(byte[])"><!-- --></A><H3>
|
|
buildNormalId</H3>
|
|
<PRE>
|
|
public <A HREF="../../../../rice/p2p/commonapi/Id.html" title="interface in rice.p2p.commonapi">Id</A> <B>buildNormalId</B>(byte[] material)</PRE>
|
|
<DL>
|
|
<DD>Builds a protocol-specific Id given the source data.
|
|
<P>
|
|
<DD><DL>
|
|
</DL>
|
|
</DD>
|
|
<DD><DL>
|
|
<DT><B>Parameters:</B><DD><CODE>material</CODE> - The material to use
|
|
<DT><B>Returns:</B><DD>The built Id.</DL>
|
|
</DD>
|
|
</DL>
|
|
<HR>
|
|
|
|
<A NAME="buildId(byte[])"><!-- --></A><H3>
|
|
buildId</H3>
|
|
<PRE>
|
|
public <A HREF="../../../../rice/p2p/commonapi/Id.html" title="interface in rice.p2p.commonapi">Id</A> <B>buildId</B>(byte[] material)</PRE>
|
|
<DL>
|
|
<DD>Builds a protocol-specific Id given the source data.
|
|
<P>
|
|
<DD><DL>
|
|
<DT><B>Specified by:</B><DD><CODE><A HREF="../../../../rice/p2p/commonapi/IdFactory.html#buildId(byte[])">buildId</A></CODE> in interface <CODE><A HREF="../../../../rice/p2p/commonapi/IdFactory.html" title="interface in rice.p2p.commonapi">IdFactory</A></CODE></DL>
|
|
</DD>
|
|
<DD><DL>
|
|
<DT><B>Parameters:</B><DD><CODE>material</CODE> - The material to use
|
|
<DT><B>Returns:</B><DD>The built Id.</DL>
|
|
</DD>
|
|
</DL>
|
|
<HR>
|
|
|
|
<A NAME="buildId(int[])"><!-- --></A><H3>
|
|
buildId</H3>
|
|
<PRE>
|
|
public <A HREF="../../../../rice/p2p/commonapi/Id.html" title="interface in rice.p2p.commonapi">Id</A> <B>buildId</B>(int[] material)</PRE>
|
|
<DL>
|
|
<DD>Builds a protocol-specific Id given the source data.
|
|
<P>
|
|
<DD><DL>
|
|
<DT><B>Specified by:</B><DD><CODE><A HREF="../../../../rice/p2p/commonapi/IdFactory.html#buildId(int[])">buildId</A></CODE> in interface <CODE><A HREF="../../../../rice/p2p/commonapi/IdFactory.html" title="interface in rice.p2p.commonapi">IdFactory</A></CODE></DL>
|
|
</DD>
|
|
<DD><DL>
|
|
<DT><B>Parameters:</B><DD><CODE>material</CODE> - The material to use
|
|
<DT><B>Returns:</B><DD>The built Id.</DL>
|
|
</DD>
|
|
</DL>
|
|
<HR>
|
|
|
|
<A NAME="buildId(java.lang.String)"><!-- --></A><H3>
|
|
buildId</H3>
|
|
<PRE>
|
|
public <A HREF="../../../../rice/p2p/commonapi/Id.html" title="interface in rice.p2p.commonapi">Id</A> <B>buildId</B>(java.lang.String string)</PRE>
|
|
<DL>
|
|
<DD>Builds a protocol-specific Id by using the hash of the given string as source data.
|
|
<P>
|
|
<DD><DL>
|
|
<DT><B>Specified by:</B><DD><CODE><A HREF="../../../../rice/p2p/commonapi/IdFactory.html#buildId(java.lang.String)">buildId</A></CODE> in interface <CODE><A HREF="../../../../rice/p2p/commonapi/IdFactory.html" title="interface in rice.p2p.commonapi">IdFactory</A></CODE></DL>
|
|
</DD>
|
|
<DD><DL>
|
|
<DT><B>Parameters:</B><DD><CODE>string</CODE> - The string to use as source data
|
|
<DT><B>Returns:</B><DD>The built Id.</DL>
|
|
</DD>
|
|
</DL>
|
|
<HR>
|
|
|
|
<A NAME="buildRandomId(java.util.Random)"><!-- --></A><H3>
|
|
buildRandomId</H3>
|
|
<PRE>
|
|
public <A HREF="../../../../rice/p2p/commonapi/Id.html" title="interface in rice.p2p.commonapi">Id</A> <B>buildRandomId</B>(java.util.Random rng)</PRE>
|
|
<DL>
|
|
<DD>Builds a random protocol-specific Id.
|
|
<P>
|
|
<DD><DL>
|
|
<DT><B>Specified by:</B><DD><CODE><A HREF="../../../../rice/p2p/commonapi/IdFactory.html#buildRandomId(java.util.Random)">buildRandomId</A></CODE> in interface <CODE><A HREF="../../../../rice/p2p/commonapi/IdFactory.html" title="interface in rice.p2p.commonapi">IdFactory</A></CODE></DL>
|
|
</DD>
|
|
<DD><DL>
|
|
<DT><B>Parameters:</B><DD><CODE>rng</CODE> - A random number generator
|
|
<DT><B>Returns:</B><DD>The built Id.</DL>
|
|
</DD>
|
|
</DL>
|
|
<HR>
|
|
|
|
<A NAME="buildRandomId(rice.environment.random.RandomSource)"><!-- --></A><H3>
|
|
buildRandomId</H3>
|
|
<PRE>
|
|
public <A HREF="../../../../rice/p2p/commonapi/Id.html" title="interface in rice.p2p.commonapi">Id</A> <B>buildRandomId</B>(<A HREF="../../../../rice/environment/random/RandomSource.html" title="interface in rice.environment.random">RandomSource</A> rng)</PRE>
|
|
<DL>
|
|
<DD><DL>
|
|
<DT><B>Specified by:</B><DD><CODE><A HREF="../../../../rice/p2p/commonapi/IdFactory.html#buildRandomId(rice.environment.random.RandomSource)">buildRandomId</A></CODE> in interface <CODE><A HREF="../../../../rice/p2p/commonapi/IdFactory.html" title="interface in rice.p2p.commonapi">IdFactory</A></CODE></DL>
|
|
</DD>
|
|
<DD><DL>
|
|
</DL>
|
|
</DD>
|
|
</DL>
|
|
<HR>
|
|
|
|
<A NAME="buildIdFromToString(java.lang.String)"><!-- --></A><H3>
|
|
buildIdFromToString</H3>
|
|
<PRE>
|
|
public <A HREF="../../../../rice/p2p/commonapi/Id.html" title="interface in rice.p2p.commonapi">Id</A> <B>buildIdFromToString</B>(java.lang.String string)</PRE>
|
|
<DL>
|
|
<DD>Builds an Id by converting the given toString() output back to an Id. Should
|
|
not normall be used.
|
|
<P>
|
|
<DD><DL>
|
|
<DT><B>Specified by:</B><DD><CODE><A HREF="../../../../rice/p2p/commonapi/IdFactory.html#buildIdFromToString(java.lang.String)">buildIdFromToString</A></CODE> in interface <CODE><A HREF="../../../../rice/p2p/commonapi/IdFactory.html" title="interface in rice.p2p.commonapi">IdFactory</A></CODE></DL>
|
|
</DD>
|
|
<DD><DL>
|
|
<DT><B>Parameters:</B><DD><CODE>string</CODE> - The toString() representation of an Id
|
|
<DT><B>Returns:</B><DD>The built Id.</DL>
|
|
</DD>
|
|
</DL>
|
|
<HR>
|
|
|
|
<A NAME="buildIdFromToString(char[], int, int)"><!-- --></A><H3>
|
|
buildIdFromToString</H3>
|
|
<PRE>
|
|
public <A HREF="../../../../rice/p2p/commonapi/Id.html" title="interface in rice.p2p.commonapi">Id</A> <B>buildIdFromToString</B>(char[] chars,
|
|
int offset,
|
|
int length)</PRE>
|
|
<DL>
|
|
<DD>Builds an Id by converting the given toString() output back to an Id. Should
|
|
not normally be used.
|
|
<P>
|
|
<DD><DL>
|
|
<DT><B>Specified by:</B><DD><CODE><A HREF="../../../../rice/p2p/commonapi/IdFactory.html#buildIdFromToString(char[], int, int)">buildIdFromToString</A></CODE> in interface <CODE><A HREF="../../../../rice/p2p/commonapi/IdFactory.html" title="interface in rice.p2p.commonapi">IdFactory</A></CODE></DL>
|
|
</DD>
|
|
<DD><DL>
|
|
<DT><B>Parameters:</B><DD><CODE>chars</CODE> - The character array<DD><CODE>offset</CODE> - The offset to start reading at<DD><CODE>length</CODE> - The length to read
|
|
<DT><B>Returns:</B><DD>The built Id.</DL>
|
|
</DD>
|
|
</DL>
|
|
<HR>
|
|
|
|
<A NAME="buildIdRangeFromPrefix(java.lang.String)"><!-- --></A><H3>
|
|
buildIdRangeFromPrefix</H3>
|
|
<PRE>
|
|
public <A HREF="../../../../rice/p2p/commonapi/IdRange.html" title="interface in rice.p2p.commonapi">IdRange</A> <B>buildIdRangeFromPrefix</B>(java.lang.String string)</PRE>
|
|
<DL>
|
|
<DD>Builds an IdRange based on a prefix. Any id which has this prefix should
|
|
be inside this IdRange, and any id which does not share this prefix should
|
|
be outside it.
|
|
<P>
|
|
<DD><DL>
|
|
<DT><B>Specified by:</B><DD><CODE><A HREF="../../../../rice/p2p/commonapi/IdFactory.html#buildIdRangeFromPrefix(java.lang.String)">buildIdRangeFromPrefix</A></CODE> in interface <CODE><A HREF="../../../../rice/p2p/commonapi/IdFactory.html" title="interface in rice.p2p.commonapi">IdFactory</A></CODE></DL>
|
|
</DD>
|
|
<DD><DL>
|
|
<DT><B>Parameters:</B><DD><CODE>string</CODE> - The toString() representation of an Id
|
|
<DT><B>Returns:</B><DD>The built Id.</DL>
|
|
</DD>
|
|
</DL>
|
|
<HR>
|
|
|
|
<A NAME="getIdToStringLength()"><!-- --></A><H3>
|
|
getIdToStringLength</H3>
|
|
<PRE>
|
|
public int <B>getIdToStringLength</B>()</PRE>
|
|
<DL>
|
|
<DD>Returns the length a Id.toString should be.
|
|
<P>
|
|
<DD><DL>
|
|
<DT><B>Specified by:</B><DD><CODE><A HREF="../../../../rice/p2p/commonapi/IdFactory.html#getIdToStringLength()">getIdToStringLength</A></CODE> in interface <CODE><A HREF="../../../../rice/p2p/commonapi/IdFactory.html" title="interface in rice.p2p.commonapi">IdFactory</A></CODE></DL>
|
|
</DD>
|
|
<DD><DL>
|
|
|
|
<DT><B>Returns:</B><DD>The correct length;</DL>
|
|
</DD>
|
|
</DL>
|
|
<HR>
|
|
|
|
<A NAME="buildIdDistance(byte[])"><!-- --></A><H3>
|
|
buildIdDistance</H3>
|
|
<PRE>
|
|
public <A HREF="../../../../rice/p2p/commonapi/Id.Distance.html" title="interface in rice.p2p.commonapi">Id.Distance</A> <B>buildIdDistance</B>(byte[] material)</PRE>
|
|
<DL>
|
|
<DD>Builds a protocol-specific Id.Distance given the source data.
|
|
<P>
|
|
<DD><DL>
|
|
<DT><B>Specified by:</B><DD><CODE><A HREF="../../../../rice/p2p/commonapi/IdFactory.html#buildIdDistance(byte[])">buildIdDistance</A></CODE> in interface <CODE><A HREF="../../../../rice/p2p/commonapi/IdFactory.html" title="interface in rice.p2p.commonapi">IdFactory</A></CODE></DL>
|
|
</DD>
|
|
<DD><DL>
|
|
<DT><B>Parameters:</B><DD><CODE>material</CODE> - The material to use
|
|
<DT><B>Returns:</B><DD>The built Id.Distance.</DL>
|
|
</DD>
|
|
</DL>
|
|
<HR>
|
|
|
|
<A NAME="buildIdRange(rice.p2p.commonapi.Id, rice.p2p.commonapi.Id)"><!-- --></A><H3>
|
|
buildIdRange</H3>
|
|
<PRE>
|
|
public <A HREF="../../../../rice/p2p/commonapi/IdRange.html" title="interface in rice.p2p.commonapi">IdRange</A> <B>buildIdRange</B>(<A HREF="../../../../rice/p2p/commonapi/Id.html" title="interface in rice.p2p.commonapi">Id</A> cw,
|
|
<A HREF="../../../../rice/p2p/commonapi/Id.html" title="interface in rice.p2p.commonapi">Id</A> ccw)</PRE>
|
|
<DL>
|
|
<DD>Creates an IdRange given the CW and CCW ids.
|
|
<P>
|
|
<DD><DL>
|
|
<DT><B>Specified by:</B><DD><CODE><A HREF="../../../../rice/p2p/commonapi/IdFactory.html#buildIdRange(rice.p2p.commonapi.Id, rice.p2p.commonapi.Id)">buildIdRange</A></CODE> in interface <CODE><A HREF="../../../../rice/p2p/commonapi/IdFactory.html" title="interface in rice.p2p.commonapi">IdFactory</A></CODE></DL>
|
|
</DD>
|
|
<DD><DL>
|
|
<DT><B>Parameters:</B><DD><CODE>cw</CODE> - The clockwise Id<DD><CODE>ccw</CODE> - The counterclockwise Id
|
|
<DT><B>Returns:</B><DD>An IdRange with the appropriate delimiters.</DL>
|
|
</DD>
|
|
</DL>
|
|
<HR>
|
|
|
|
<A NAME="buildIdSet()"><!-- --></A><H3>
|
|
buildIdSet</H3>
|
|
<PRE>
|
|
public <A HREF="../../../../rice/p2p/commonapi/IdSet.html" title="interface in rice.p2p.commonapi">IdSet</A> <B>buildIdSet</B>()</PRE>
|
|
<DL>
|
|
<DD>Creates an empty IdSet.
|
|
<P>
|
|
<DD><DL>
|
|
<DT><B>Specified by:</B><DD><CODE><A HREF="../../../../rice/p2p/commonapi/IdFactory.html#buildIdSet()">buildIdSet</A></CODE> in interface <CODE><A HREF="../../../../rice/p2p/commonapi/IdFactory.html" title="interface in rice.p2p.commonapi">IdFactory</A></CODE></DL>
|
|
</DD>
|
|
<DD><DL>
|
|
|
|
<DT><B>Returns:</B><DD>an empty IdSet</DL>
|
|
</DD>
|
|
</DL>
|
|
<HR>
|
|
|
|
<A NAME="buildIdSet(java.util.SortedMap)"><!-- --></A><H3>
|
|
buildIdSet</H3>
|
|
<PRE>
|
|
public <A HREF="../../../../rice/p2p/commonapi/IdSet.html" title="interface in rice.p2p.commonapi">IdSet</A> <B>buildIdSet</B>(java.util.SortedMap map)</PRE>
|
|
<DL>
|
|
<DD>Creates an empty IdSet.
|
|
<P>
|
|
<DD><DL>
|
|
<DT><B>Specified by:</B><DD><CODE><A HREF="../../../../rice/p2p/commonapi/IdFactory.html#buildIdSet(java.util.SortedMap)">buildIdSet</A></CODE> in interface <CODE><A HREF="../../../../rice/p2p/commonapi/IdFactory.html" title="interface in rice.p2p.commonapi">IdFactory</A></CODE></DL>
|
|
</DD>
|
|
<DD><DL>
|
|
|
|
<DT><B>Returns:</B><DD>an empty IdSet</DL>
|
|
</DD>
|
|
</DL>
|
|
<HR>
|
|
|
|
<A NAME="buildNodeHandleSet()"><!-- --></A><H3>
|
|
buildNodeHandleSet</H3>
|
|
<PRE>
|
|
public <A HREF="../../../../rice/p2p/commonapi/NodeHandleSet.html" title="interface in rice.p2p.commonapi">NodeHandleSet</A> <B>buildNodeHandleSet</B>()</PRE>
|
|
<DL>
|
|
<DD>Creates an empty NodeHandleSet.
|
|
<P>
|
|
<DD><DL>
|
|
<DT><B>Specified by:</B><DD><CODE><A HREF="../../../../rice/p2p/commonapi/IdFactory.html#buildNodeHandleSet()">buildNodeHandleSet</A></CODE> in interface <CODE><A HREF="../../../../rice/p2p/commonapi/IdFactory.html" title="interface in rice.p2p.commonapi">IdFactory</A></CODE></DL>
|
|
</DD>
|
|
<DD><DL>
|
|
|
|
<DT><B>Returns:</B><DD>an empty NodeHandleSet</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/GCIdFactory.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/past/gc/GCId.html" title="class in rice.p2p.past.gc"><B>PREV CLASS</B></A>
|
|
<A HREF="../../../../rice/p2p/past/gc/GCIdFactory.GCEntrySet.html" title="class in rice.p2p.past.gc"><B>NEXT CLASS</B></A></FONT></TD>
|
|
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
|
|
<A HREF="../../../../index.html?rice/p2p/past/gc/GCIdFactory.html" target="_top"><B>FRAMES</B></A>
|
|
<A HREF="GCIdFactory.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: <A HREF="#nested_class_summary">NESTED</A> | <A HREF="#field_summary">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: <A HREF="#field_detail">FIELD</A> | <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>
|
|
<i>Copyright © 2001-2005 - Rice Pastry.</i>
|
|
</BODY>
|
|
</HTML>
|