rice.p2p.commonapi
Interface IdFactory

All Known Implementing Classes:

FragmentKeyFactory, GCIdFactory, MultiringIdFactory, PastryIdFactory, VersionKeyFactory

public interface IdFactory

Version:

$Id: IdFactory.java,v 1.14 2005/03/11 00:58:02 jeffh Exp $

Author:

Alan Mislove, Peter Druschel

Method Summary

Id	buildId(byte[] material) Builds a protocol-specific Id given the source data.
Id	buildId(int[] material) Builds a protocol-specific Id given the source data.
Id	buildId(java.lang.String string) Builds a protocol-specific Id by using the hash of the given string as source data.
Id.Distance	buildIdDistance(byte[] material) Builds a protocol-specific Id.Distance given the source data.
Id	buildIdFromToString(char[] chars, int offset, int length) Builds an Id by converting the given toString() output back to an Id.
Id	buildIdFromToString(java.lang.String string) Builds an Id by converting the given toString() output back to an Id.
IdRange	buildIdRange(Id cw, Id ccw) Creates an IdRange given the CW and CCW ids.
IdRange	buildIdRangeFromPrefix(java.lang.String string) Builds an IdRange based on a prefix.
IdSet	buildIdSet() Creates an empty IdSet.
IdSet	buildIdSet(java.util.SortedMap map) Creates an empty IdSet.
NodeHandleSet	buildNodeHandleSet() Creates an empty NodeHandleSet.
Id	buildRandomId(java.util.Random rng) Builds a random protocol-specific Id.
int	getIdToStringLength() Returns the length a Id.toString should be.

Method Detail

buildId

public Id buildId(byte[] material)

Builds a protocol-specific Id given the source data.

Parameters:

material - The material to use

Returns:

The built Id.

buildId

public Id buildId(int[] material)

Builds a protocol-specific Id given the source data.

Parameters:

material - The material to use

Returns:

The built Id.

buildId

public Id buildId(java.lang.String string)

Builds a protocol-specific Id by using the hash of the given string as source data.

Parameters:

string - The string to use as source data

Returns:

The built Id.

buildRandomId

public Id buildRandomId(java.util.Random rng)

Builds a random protocol-specific Id.

Parameters:

rng - A random number generator

Returns:

The built Id.

buildIdFromToString

public Id buildIdFromToString(java.lang.String string)

Builds an Id by converting the given toString() output back to an Id. Should not normally be used.

Parameters:

string - The toString() representation of an Id

Returns:

The built Id.

buildIdFromToString

public Id buildIdFromToString(char[] chars,
                              int offset,
                              int length)

Builds an Id by converting the given toString() output back to an Id. Should not normally be used.

Parameters:

chars - The character array

offset - The offset to start reading at

length - The length to read

Returns:

The built Id.

buildIdRangeFromPrefix

public IdRange buildIdRangeFromPrefix(java.lang.String string)

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.

Parameters:

string - The toString() representation of an Id

Returns:

The built Id.

getIdToStringLength

public int getIdToStringLength()

Returns the length a Id.toString should be.

Returns:

The correct length;

buildIdDistance

public Id.Distance buildIdDistance(byte[] material)

Builds a protocol-specific Id.Distance given the source data.

Parameters:

material - The material to use

Returns:

The built Id.Distance.

buildIdRange

public IdRange buildIdRange(Id cw,
                            Id ccw)

Creates an IdRange given the CW and CCW ids.

Parameters:

cw - The clockwise Id

ccw - The counterclockwise Id

Returns:

An IdRange with the appropriate delimiters.

buildIdSet

public IdSet buildIdSet()

Creates an empty IdSet.

Returns:

an empty IdSet

buildIdSet

public IdSet buildIdSet(java.util.SortedMap map)

Creates an empty IdSet.

Parameters:

map - DESCRIBE THE PARAMETER

Returns:

an empty IdSet

buildNodeHandleSet

public NodeHandleSet buildNodeHandleSet()

Creates an empty NodeHandleSet.

Returns:

an empty NodeHandleSet